Search documentation
karat

+

K

User Documentation ↗

Get Action Type

GET/api/v2/ontologies/{ontology}/actionTypes/{actionType}

Gets a specific action type with the given API name.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: 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.

actionType
string

The name of the action type in the API.

Response body

ActionTypeV2
object

Success response.

Hide children

Hide children

apiName
string

The name of the action type in the API. To find the API name for your Action Type, use the List action types endpoint or check the Ontology Manager.

description
string
optional
displayName
string
optional

The display name of the entity.

status
string (enum)

The release status of the entity.

Enum values: ACTIVE, EXPERIMENTAL, DEPRECATED

parameters
map<ParameterId, ActionParameterV2>
optional
Show children

Show children

ParameterId
string

The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. Parameters can be viewed and managed in the Ontology Manager.

ActionParameterV2
object

Details about a parameter of an action.

Show children

Show children

description
string
optional
dataType
union

A union of all the types supported by Ontology Action parameters.

Show children

Show children

date
object
optional
boolean
object
optional
marking
object
optional
attachment
object
optional
string
object
optional
array
object
optional
Show children

Show children

subType
union

A union of all the types supported by Ontology Action parameters.

Show children

Show children

date
object
optional
boolean
object
optional
marking
object
optional
attachment
object
optional
string
object
optional
array
object
optional
Show children

Show children

subType
union

A union of all the types supported by Ontology Action parameters.

objectSet
object
optional
Show children

Show children

objectApiName
string
optional

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.

objectTypeApiName
string
optional

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.

double
object
optional
integer
object
optional
long
object
optional
object
object
optional
Show children

Show children

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

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.

timestamp
object
optional
objectSet
object
optional
Show children

Show children

objectApiName
string
optional

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.

objectTypeApiName
string
optional

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.

double
object
optional
integer
object
optional
long
object
optional
object
object
optional
Show children

Show children

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

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.

timestamp
object
optional
required
boolean
rid
string

The unique resource identifier of an action type, useful for interacting with other Foundry APIs.

operations
list<LogicRule>
optional
Show children

Show children

LogicRule
union
Show children

Show children

modifyInterfaceObject
object
optional
modifyObject
object
optional
Show children

Show children

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.

deleteObject
object
optional
Show children

Show children

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.

createInterfaceObject
object
optional
deleteLink
object
optional
Show children

Show children

linkTypeApiNameAtoB
string

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

linkTypeApiNameBtoA
string

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

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

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

createObject
object
optional
Show children

Show children

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.

createLink
object
optional
Show children

Show children

linkTypeApiNameAtoB
string

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

linkTypeApiNameBtoA
string

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

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

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

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/actionTypes/promote-employee"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "data": { "apiName": "promote-employee", "description": "Update an employee's title and compensation", "parameters": { "employeeId": { "dataType": { "type": "integer" } }, "newTitle": { "dataType": { "type": "string" } }, "newCompensation": { "dataType": { "type": "double" } } }, "rid": "ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167" } }