Search documentation
karat

+

K

User Documentation ↗

List Outgoing Link Types

GET/api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes

List the outgoing links for an object type.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read.

Path parameters

ontology
string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

objectType
string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager application.

Query parameters

pageSize
integer
optional

The desired size of the page to be returned.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and populate the next request's pageToken field with it.

Response body

ListOutgoingLinkTypesResponseV2
object

Success response.

Hide children

Hide children

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and populate the next request's pageToken field with it.

data
list<LinkTypeSideV2>
optional

The list of link type sides in the current page.

Show children

Show children

LinkTypeSideV2
object
Show children

Show children

apiName
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.

displayName
string

The display name of the entity.

status
string (enum)

The release status of the entity.

Enum values: ACTIVE, EXPERIMENTAL, DEPRECATED

objectTypeApiName
string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

cardinality
string (enum)

Enum values: ONE, MANY

foreignKeyPropertyApiName
string
optional

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

linkTypeRid
string

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/objectTypes/Flight/outgoingLinkTypes?pageSize=&pageToken="

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 { "nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv", "data": [ { "apiName": "originAirport", "objectTypeApiName": "Airport", "cardinality": "ONE", "foreignKeyPropertyApiName": "originAirportId" } ] }