Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Scenario Edited Object Types

GET/api/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objectTypes/edited
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Returns the list of object type API names that have been modified within a given scenario.

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

Path parameters

ontology
string

The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager.

scenarioRid
string

The unique resource identifier of the scenario.

Query parameters

preview
booleanoptional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

Response body

ListScenarioEditedObjectTypesResponse
object

Success response.

Hide child attributes

Hide child attributes

data
list<ObjectTypeApiName>optional

The list of object type API names that have been modified within the scenario.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/scenarios/ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objectTypes/edited?preview=true"