Version 2.0

List Scenario Edited Entity Types

GET/api/v2/ontologies/{ontology}/scenarios/{scenarioRid}/editedEntityTypes

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 object types and link types that have been modified within a given scenario.

The response contains the list of object type API names that have been modified, and the list of many-to-many link types that have been modified, grouped by their source object type. One-to-many link type edits are surfaced as object edits on the object type that owns the foreign key property.

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

ListScenarioEditedEntityTypesResponse

object

Success response.

Hide child attributes

objectTypes

list<ObjectTypeApiName>optional

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

Show child attributes

linkTypes

list<ObjectTypeLinkTypeApiNameMapping>optional

The list of edited link types grouped by source object type.

Note that only many-to-many link types are returned. One-to-many link type edits are surfaced as object edits on the object type that owns the foreign key property.

Show child attributes

Examples

Request

Copied!

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