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.
stringThe unique Resource Identifier (RID) of the Ontology that contains the action type.
stringThe name of the action type in the API.
objectSuccess response.
stringThe 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.
stringstringThe display name of the entity.
string (enum)The release status of the entity.
Enum values: ACTIVE, EXPERIMENTAL, DEPRECATED
map<ParameterId, Parameter>stringThe unique resource identifier of an action type, useful for interacting with other Foundry APIs.
list<LogicRule>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"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"
}
}