Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Scenario Edited Link Types

GET/api/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objectTypes/{objectType}/outgoingLinkTypes/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 outgoing links that have been modified within a given scenario for an object type.

Note that only many-to-many link type are returned by this endpoint. 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.

objectType
string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager application.

Query parameters

preview
booleanoptional

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

Response body

ListScenarioEditedLinkTypesResponse
object

Success response.

Hide child attributes

Hide child attributes

data
list<LinkTypeApiName>optional

The list of link 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/Flight/outgoingLinkTypes/edited?preview=true"