Version 2.0

Get Outgoing Link Types By Object Type Rid Batch

POST/api/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets outgoing link types for a batch of object types, identified by their RIDs.

For each requested object type, returns the list of outgoing link types visible to the requesting token. Optionally, results can be filtered to only include specific link type RIDs.

Object types that don't exist or that the requesting token lacks permissions for are silently omitted from the response.

The maximum batch size for this endpoint is 100.

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

Path parameters

ontology

string

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

Query parameters

branch

string

optional

The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.

Request body

GetOutgoingLinkTypesByObjectTypeRidBatchRequest

object

Hide child attributes

requests

list<GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement>

optional

Show child attributes

filterLinkTypeRids

list<LinkTypeRid>

optional

If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned.

Show child attributes

Response body

GetOutgoingLinkTypesByObjectTypeRidBatchResponse

object

Success response.

Hide child attributes

data

map<ObjectTypeRid, array>

optional

Show child attributes

Examples

Request

Copied!

curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/outgoingLinkTypes/getByRidBatch?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" \
	-d ''