Lists the action types for the given Ontology.
Each page may be smaller than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read
.
string
The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
integer
The desired size of the page to be returned. Defaults to 500. See page sizes for details.
string
The page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken
field of the previous response
and populate the next request's pageToken
field with it.
object
Success response.
string
The page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken
field of the previous response
and populate the next request's pageToken
field with it.
list<ActionTypeV2>
object
Represents an action type in the Ontology.
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.
string
string
The display name of the entity.
string
(enum)The release status of the entity.
Enum values: ACTIVE
, EXPERIMENTAL
, DEPRECATED
map<ParameterId, ActionParameterV2>
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.
object
Details about a parameter of an action.
string
union
A union of all the types supported by Ontology Action parameters.
object
object
object
object
object
object
union
A union of all the types supported by Ontology Action parameters.
object
object
object
object
object
object
union
A union of all the types supported by Ontology Action parameters.
object
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
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.
object
object
object
object
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
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.
object
object
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
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.
object
object
object
object
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
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.
object
boolean
string
The unique resource identifier of an action type, useful for interacting with other Foundry APIs.
list<LogicRule>
union
object
object
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.
object
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.
object
object
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
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
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.
object
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.
object
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
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
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.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/actionTypes"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
"nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv",
"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"
},
{
"apiName": "move-office",
"description": "Update an office's physical location",
"parameters": {
"officeId": {
"dataType": {
"type": "string"
}
},
"newAddress": {
"description": "The office's new physical address (not necessarily shipping address)",
"dataType": {
"type": "string"
}
},
"newCapacity": {
"description": "The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)",
"dataType": {
"type": "integer"
}
}
},
"rid": "ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2"
}
]
}