API Endpoint Data Model
The API Endpoint data model represents an application programming interface (API) endpoint. It extends the Asset data model.
The following table details the default attributes of the API Endpoint data model:
| Attribute Name | Attribute Type | Relationship Type | Required |
|---|---|---|---|
apiType | Text | N/A | No |
authField | Text | N/A | No |
authLocation | Text | N/A | No |
authType | Text | N/A | No |
baseRiskScore | Calculated (Number) | N/A | No |
businessServices | Reference (Business service) | SUPPORTS | No |
categories | Text (Multivalued) | N/A | No |
complianceFlags | Text (Multivalued) | N/A | No |
complianceStatus | Calculated (Single Choice) | N/A | No |
connectorCategories | Text (Multivalued) | N/A | No |
connectorNames | Text (Multivalued) | N/A | No |
createdBy | Text | N/A | No |
dataIntegrationTitles | Text (Multivalued) | N/A | No |
dataModelName | Calculated (Text) | N/A | No |
dateCreated | Date Time | N/A | No |
description | Text | N/A | No |
displayName | Calculated (Text) | N/A | Yes |
environments | Category | N/A | No |
firstSeen | Date Time | N/A | No |
flowState | Text | N/A | No |
informedUsers | Category | N/A | No |
lastAssessed | Date Time | N/A | No |
lastEnrollment | Date Time | N/A | No |
lastInventoryUpdate | Date Time | N/A | No |
lastLogin | Date Time | N/A | No |
lastPasswordChange | Date Time | N/A | No |
lastSeen | Date Time | N/A | No |
lastUpdated | Date Time | N/A | No |
name | Text | N/A | No |
numberOfDataIntegrationSources | Calculated (Number) | N/A | No |
numberOfDataIntegrationsWithMultipleSourceDatasets | Calculated (Number) | N/A | No |
numberOfSourceDatasets | Calculated (Number) | N/A | No |
numberOutofCompliance | Calculated (Number) | N/A | No |
openFindingCount | Calculated (Number) | N/A | No |
owners | Reference (Person) | OWNS | No |
privilegedDataAccess | True False | N/A | No |
profiles | Category | N/A | No |
remediationOwner | Category | N/A | No |
requestDataTypes | Text (Multivalued) | N/A | No |
requestTags | Text (Multivalued) | N/A | No |
responseDataTypes | Text (Multivalued) | N/A | No |
resposeTags | Text (Multivalued) | N/A | No |
riskFactorOffset | Calculated (Number) | N/A | No |
riskFactors | Risk Factors | N/A | No |
riskOwner | Category | N/A | No |
riskRating | Calculated (Single Choice) | N/A | No |
riskScore | Calculated (Number) | N/A | No |
riskScoringModel | Risk Scoring Model | N/A | No |
scannedForVulnerabilities | Calculated (True False) | N/A | No |
sources | Reference (Base model) | SOURCED_FROM | No |
sourcesIcons | Source data models icons | N/A | No |
sourceUids | Text (Multivalued) | N/A | No |
status | Single Choice | N/A | No |
summary | Text | N/A | No |
supportedMethod | Text (Multivalued) | N/A | No |
tags | Text (Multivalued) | N/A | No |
technologies | Category | N/A | No |
type | Category | N/A | No |
uid | Text | N/A | Yes |
updatedBy | Text | N/A | No |
FOOTNOTES
- The attribute names are used in Brinqa Query Language (BQL) queries and Brinqa Condition Language (BCL) predicates.
- In the Type column, Calculated means that the value of the attribute is computed by executing a script. The text in the parentheses after Calculated denotes the type of the outcome.
- In the Type column, Reference means that two data models are related. The name in the parentheses after Reference indicates the other data model.
- The Relationship Type column only applies to the Reference type attributes. You can use the relationship type keyword in BQL queries.