Search documentation
karat

+

K

User Documentation ↗

Get Action Type

GET/api/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}

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

ontologyRid
string

The unique Resource Identifier (RID) of the Ontology that contains the action type.

actionTypeApiName
string

The name of the action type in the API.

Response body

ActionType
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, Parameter>
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.

Parameter
object

Details about a parameter of an action or query.

Show children

Show children

description
string
optional
baseType
string

A string indicating the type of each data value. Note that these types can be nested, for example an array of structs.

TypeJSON value
ArrayArray<T>, where T is the type of the array elements, e.g. Array<String>.
AttachmentAttachment
BooleanBoolean
ByteByte
DateLocalDate
DecimalDecimal
DoubleDouble
FloatFloat
IntegerInteger
LongLong
MarkingMarking
OntologyObjectOntologyObject<T> where T is the API name of the referenced object type.
ShortShort
StringString
StructStruct<T> where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }>
TimeseriesTimeSeries<T> where T is either String for an enum series or Double for a numeric series.
TimestampTimestamp
dataType
union
optional

A union of all the primitive types used by Palantir's Ontology-based products.

Show children

Show children

date
object
optional
struct
object
optional
Show children

Show children

fields
list<OntologyStructField>
optional
Show children

Show children

OntologyStructField
object
Show children

Show children

name
string

The name of a field in a Struct.

fieldType
union

A union of all the primitive types used by Palantir's Ontology-based products.

Show children

Show children

date
object
optional
struct
object
optional
Show children

Show children

fields
list<OntologyStructField>
optional
Show children

Show children

OntologyStructField
object
Show children

Show children

name
string

The name of a field in a Struct.

fieldType
union

A union of all the primitive types used by Palantir's Ontology-based products.

required
boolean
set
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

string
object
optional
byte
object
optional
double
object
optional
integer
object
optional
float
object
optional
any
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
unsupported
object
optional
Show children

Show children

unsupportedType
string
array
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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.

binary
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
map
object
optional
Show children

Show children

keyType
union

A union of all the primitive types used by Palantir's Ontology-based products.

valueType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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

required
boolean
set
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

Show children

Show children

date
object
optional
struct
object
optional
Show children

Show children

fields
list<OntologyStructField>
optional
Show children

Show children

OntologyStructField
object
Show children

Show children

name
string

The name of a field in a Struct.

fieldType
union

A union of all the primitive types used by Palantir's Ontology-based products.

required
boolean
set
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

string
object
optional
byte
object
optional
double
object
optional
integer
object
optional
float
object
optional
any
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
unsupported
object
optional
Show children

Show children

unsupportedType
string
array
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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.

binary
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
map
object
optional
Show children

Show children

keyType
union

A union of all the primitive types used by Palantir's Ontology-based products.

valueType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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

string
object
optional
byte
object
optional
double
object
optional
integer
object
optional
float
object
optional
any
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
unsupported
object
optional
Show children

Show children

unsupportedType
string
array
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

Show children

Show children

date
object
optional
struct
object
optional
Show children

Show children

fields
list<OntologyStructField>
optional
Show children

Show children

OntologyStructField
object
Show children

Show children

name
string

The name of a field in a Struct.

fieldType
union

A union of all the primitive types used by Palantir's Ontology-based products.

required
boolean
set
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

string
object
optional
byte
object
optional
double
object
optional
integer
object
optional
float
object
optional
any
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
unsupported
object
optional
Show children

Show children

unsupportedType
string
array
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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.

binary
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
map
object
optional
Show children

Show children

keyType
union

A union of all the primitive types used by Palantir's Ontology-based products.

valueType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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

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.

binary
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
map
object
optional
Show children

Show children

keyType
union

A union of all the primitive types used by Palantir's Ontology-based products.

Show children

Show children

date
object
optional
struct
object
optional
Show children

Show children

fields
list<OntologyStructField>
optional
Show children

Show children

OntologyStructField
object
Show children

Show children

name
string

The name of a field in a Struct.

fieldType
union

A union of all the primitive types used by Palantir's Ontology-based products.

required
boolean
set
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

string
object
optional
byte
object
optional
double
object
optional
integer
object
optional
float
object
optional
any
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
unsupported
object
optional
Show children

Show children

unsupportedType
string
array
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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.

binary
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
map
object
optional
Show children

Show children

keyType
union

A union of all the primitive types used by Palantir's Ontology-based products.

valueType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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

valueType
union

A union of all the primitive types used by Palantir's Ontology-based products.

Show children

Show children

date
object
optional
struct
object
optional
Show children

Show children

fields
list<OntologyStructField>
optional
Show children

Show children

OntologyStructField
object
Show children

Show children

name
string

The name of a field in a Struct.

fieldType
union

A union of all the primitive types used by Palantir's Ontology-based products.

required
boolean
set
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

string
object
optional
byte
object
optional
double
object
optional
integer
object
optional
float
object
optional
any
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
unsupported
object
optional
Show children

Show children

unsupportedType
string
array
object
optional
Show children

Show children

itemType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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.

binary
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
map
object
optional
Show children

Show children

keyType
union

A union of all the primitive types used by Palantir's Ontology-based products.

valueType
union

A union of all the primitive types used by Palantir's Ontology-based products.

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

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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actionTypes/promote-employee"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "data": { "apiName": "promote-employee", "description": "Update an employee's title and compensation", "parameters": { "employeeId": { "baseType": "Integer" }, "newTitle": { "baseType": "String" }, "newCompensation": { "baseType": "Decimal" } }, "rid": "ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167" } }