Version 2.0

List Scenario Conflicting Objects

GET/api/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/conflicting

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 objects with edits that conflict with edits to the scenario's base for a specific object type. A conflict occurs when an object has been edited both within the scenario and on the scenario's base after the scenario was created. Only objects that the user has permission to view are returned.

Conflict detection takes into account changes that are not reflected in the user-visible object data. As a result, this endpoint may report false positives. An object may be returned as conflicting even if its data has not actually changed on the scenario's base.

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.

Query parameters

pageSize

integeroptional

The maximum number of objects to examine when searching for conflicts. This bounds the work performed per call; it is not a guarantee on the number of conflicting objects returned, which may be smaller. Each page may be smaller than this value.

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

ListScenarioConflictingObjectsResponse

object

Success response.

Hide child attributes

data

list<ObjectLocator>optional

The list of objects that have a conflicting edit within the scenario.

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/conflicting?preview=true"