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.
stringThe 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.
stringThe 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.
objectmap<ParameterId, DataValue>stringThe 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.
anyRepresents the value of data in the following format. Note that these values can be nested, for example an array of structs.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | string | "ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e" |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Float | number | 3.14159265 |
| Double | number | 3.14159265 |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Marking | string | "MU" |
| Null | null | null |
| Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z |
| Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or "EMP1234" |
| Set | array | ["alpha", "bravo", "charlie"] |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Struct | JSON object | {"name": "John Doe", "age": 42} |
| TwoDimensionalAggregation | JSON object | {"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]} |
| ThreeDimensionalAggregation | JSON object | {"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]} |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
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"}}'1
{}