Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Action Type By Rid Batch

POST/api/v2/ontologies/{ontology}/actionTypes/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 a list of action types by RID in bulk.

Action types are filtered from the response if they don't exist or the requesting token lacks the required permissions.

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

GetActionTypeByRidBatchRequest
object
Hide child attributes

Hide child attributes

requests
list<GetActionTypeByRidBatchRequestElement>
optional
Show child attributes

Show child attributes

Response body

GetActionTypeByRidBatchResponse
object

Success response.

Hide child attributes

Hide child attributes

data
list<ActionTypeV2>
optional
Show child attributes

Show child attributes

Examples

Request

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