Search documentation
karat

+

K

User Documentation ↗

Apply Action

POST/api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply

Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take some time to be visible.

Note that parameter default values are not currently supported by this endpoint.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-write.

Path parameters

ontologyRid
string

The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.

actionType
string

The API name of the action to apply. To find the API name for your action, use the List action types endpoint or check the Ontology Manager.

Request body

ApplyActionRequest
object
Hide child attributes

Hide child attributes

parameters
map<ParameterId, DataValue>
optional
Show child attributes

Show child attributes

Response body

ApplyActionResponse
object

Success response.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/apply" \ -d '{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}'

Response

Copied!
1 {}