API Reference

Get Outgoing Link Type

GET/api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}

Get an outgoing link for an object type.

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

Path parameters

ontologyRid

string

The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager application.

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.

linkType

string

The API name of the outgoing link. To find the API name for your link type, check the Ontology Manager.

Response body

LinkTypeSide

object

Success response.

Hide child attributes

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.

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objectTypes/Employee/outgoingLinkTypes/directReport"

Response

Copied!

{
  "apiName": "directReport",
  "objectTypeApiName": "Employee",
  "cardinality": "MANY"
}