Version 2.0

List Scenario Edited Links

GET/api/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/links/{linkType}/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 edited links within a given scenario for a specific object type and link type, grouped by source object. Only works for many-to-many link types. Only links where the user has permission to view both objects are returned.

Each page may be smaller than the requested page size.

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.

linkType

string

The API name of the link type.

Query parameters

pageSize

integeroptional

The maximum number of links to return per page.

pageToken

stringoptional

The page token to use for pagination.

preview

booleanoptional

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

Response body

ListScenarioEditedLinksResponse

object

Success response.

Hide child attributes

data

list<LinksFromObject>optional

The list of linked objects that have been edited within the scenario, grouped by source object.

Show child attributes

nextPageToken

stringoptional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!

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