Entity Relationship Types (Beta)
Use these operations to interact with entity relationship types in Cortex.
Required permissions
Create and Update Relationship Types: Your API key must have the Edit entities
permission.
Your tenant must also have the Entity relationships
feature enabled.
Operations
List paginated relationship types
Authorizations
Query parameters
pageSizeinteger · int32RequiredDefault:
Number of results to return per page, between 1 and 1000. Default 250.
250
pageinteger · int32RequiredDefault:
Page number to return, 0-indexed. Default 0.
0
Responses
200
Successfully found entity relationship types
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/relationship-types HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"page": 1,
"relationshipTypes": [
{
"allowCycles": true,
"definitionLocation": "SOURCE",
"description": "text",
"destinationLabelPlural": "text",
"destinationLabelSingular": "text",
"destinationNamePlural": "text",
"destinationNameSingular": "text",
"destinationsFilter": {
"include": true,
"types": [
"text"
]
},
"inheritances": [
{
"inheritanceType": "NONE",
"parameterTag": "text"
}
],
"isCortexManaged": true,
"isSingleDestination": true,
"isSingleSource": true,
"name": "text",
"sourceLabelPlural": "text",
"sourceLabelSingular": "text",
"sourceNamePlural": "text",
"sourceNameSingular": "text",
"sourcesFilter": {
"include": true,
"types": [
"text"
]
},
"tag": "text"
}
],
"total": 1,
"totalPages": 1
}
Create a relationship type
Authorizations
Body
allowCyclesbooleanRequired
createCatalogbooleanRequired
definitionLocationstring · enumRequiredPossible values:
descriptionstringOptional
destinationLabelPluralstringOptional
destinationLabelSingularstringOptional
isSingleDestinationbooleanRequired
isSingleSourcebooleanRequired
namestringRequired
sourceLabelPluralstringOptional
sourceLabelSingularstringOptional
tagstringRequired
Responses
200
Successfully created relationship type
application/json
400
Validation error creating relationship type
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
post
POST /api/v1/relationship-types HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 461
{
"allowCycles": true,
"createCatalog": true,
"definitionLocation": "SOURCE",
"description": "text",
"destinationLabelPlural": "text",
"destinationLabelSingular": "text",
"destinationsFilter": {
"include": true,
"types": [
"text"
]
},
"inheritances": [
{
"inheritanceType": "NONE",
"parameterTag": "text"
}
],
"isSingleDestination": true,
"isSingleSource": true,
"name": "text",
"sourceLabelPlural": "text",
"sourceLabelSingular": "text",
"sourcesFilter": {
"include": true,
"types": [
"text"
]
},
"tag": "text"
}
{
"allowCycles": true,
"definitionLocation": "SOURCE",
"description": "text",
"destinationLabelPlural": "text",
"destinationLabelSingular": "text",
"destinationNamePlural": "text",
"destinationNameSingular": "text",
"destinationsFilter": {
"include": true,
"types": [
"text"
]
},
"inheritances": [
{
"inheritanceType": "NONE",
"parameterTag": "text"
}
],
"isCortexManaged": true,
"isSingleDestination": true,
"isSingleSource": true,
"name": "text",
"sourceLabelPlural": "text",
"sourceLabelSingular": "text",
"sourceNamePlural": "text",
"sourceNameSingular": "text",
"sourcesFilter": {
"include": true,
"types": [
"text"
]
},
"tag": "text"
}
List details for a relationship type
Authorizations
Path parameters
relationshipTypeTagstringRequired
Responses
200
Successfully found relationship type
application/json
404
Relationship type not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/relationship-types/{relationshipTypeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"allowCycles": true,
"definitionLocation": "SOURCE",
"description": "text",
"destinationLabelPlural": "text",
"destinationLabelSingular": "text",
"destinationNamePlural": "text",
"destinationNameSingular": "text",
"destinationsFilter": {
"include": true,
"types": [
"text"
]
},
"inheritances": [
{
"inheritanceType": "NONE",
"parameterTag": "text"
}
],
"isCortexManaged": true,
"isSingleDestination": true,
"isSingleSource": true,
"name": "text",
"sourceLabelPlural": "text",
"sourceLabelSingular": "text",
"sourceNamePlural": "text",
"sourceNameSingular": "text",
"sourcesFilter": {
"include": true,
"types": [
"text"
]
},
"tag": "text"
}
Update relationship type
Authorizations
Path parameters
relationshipTypeTagstringRequired
Body
allowCyclesbooleanRequired
createCatalogbooleanRequired
definitionLocationstring · enumRequiredPossible values:
descriptionstringOptional
destinationLabelPluralstringOptional
destinationLabelSingularstringOptional
isSingleDestinationbooleanRequired
isSingleSourcebooleanRequired
namestringRequired
sourceLabelPluralstringOptional
sourceLabelSingularstringOptional
tagstringRequired
Responses
200
Successfully updated relationship type
application/json
400
Validation error updating relationship type
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
put
PUT /api/v1/relationship-types/{relationshipTypeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 461
{
"allowCycles": true,
"createCatalog": true,
"definitionLocation": "SOURCE",
"description": "text",
"destinationLabelPlural": "text",
"destinationLabelSingular": "text",
"destinationsFilter": {
"include": true,
"types": [
"text"
]
},
"inheritances": [
{
"inheritanceType": "NONE",
"parameterTag": "text"
}
],
"isSingleDestination": true,
"isSingleSource": true,
"name": "text",
"sourceLabelPlural": "text",
"sourceLabelSingular": "text",
"sourcesFilter": {
"include": true,
"types": [
"text"
]
},
"tag": "text"
}
{
"allowCycles": true,
"definitionLocation": "SOURCE",
"description": "text",
"destinationLabelPlural": "text",
"destinationLabelSingular": "text",
"destinationNamePlural": "text",
"destinationNameSingular": "text",
"destinationsFilter": {
"include": true,
"types": [
"text"
]
},
"inheritances": [
{
"inheritanceType": "NONE",
"parameterTag": "text"
}
],
"isCortexManaged": true,
"isSingleDestination": true,
"isSingleSource": true,
"name": "text",
"sourceLabelPlural": "text",
"sourceLabelSingular": "text",
"sourceNamePlural": "text",
"sourceNameSingular": "text",
"sourcesFilter": {
"include": true,
"types": [
"text"
]
},
"tag": "text"
}
Delete a relationship type
Authorizations
Path parameters
relationshipTypeTagstringRequired
Responses
200
Successfully deleted relationship type
204
No Content
400
Validation error deleting relationship type
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
delete
DELETE /api/v1/relationship-types/{relationshipTypeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?