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 relationship types

get

List paginated relationship types

Authorizations
Query parameters
pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250
pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0
Responses
200
Successfully found entity relationship types
application/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 relationship type

post

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
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"
}

Get a relationship type

get

List details for a relationship type

Authorizations
Path parameters
relationshipTypeTagstringRequired
Responses
200
Successfully found relationship type
application/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

put

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
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

delete

Delete a relationship type

Authorizations
Path parameters
relationshipTypeTagstringRequired
Responses
200
Successfully deleted relationship type
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?