Version 2.0

Get Object Type Edits History

POST/api/v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory

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 history of edits (additions, modifications, deletions) for objects of a specific object type. This endpoint provides visibility into all actions that have modified objects of this type.

The edits are returned in reverse chronological order (most recent first) by default.

Note that filters are ignored for OSv1 object types.

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

Path parameters

ontology

string

The ontology RID or API name

objectType

string

The API name of the object type

Query parameters

branch

string

optional

The Foundry branch from which we will get edits history. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported.

Request body

ObjectTypeEditsHistoryRequest

object

Request object for querying object type edits history, containing both filters and pagination parameters

If objectPrimaryKey property is set, the method will return edits history for the particular object. Otherwise, the method will return edits history for all objects of this object type.

Hide child attributes

objectPrimaryKey

map<PropertyApiName, PrimaryKeyValueV2>

optional

Show child attributes

filters

union

optional

Show child attributes

sortOrder

string (enum)

optional

Enum values: newest_first, oldest_first

includeAllPreviousProperties

boolean

optional

pageSize

integer

optional

The maximum number of edits to return per page. Defaults to 100.

pageToken

string

optional

Token for retrieving the next page of results

Response body

ObjectTypeEditsHistoryResponse

object

Success response

Hide child attributes

data

list<ObjectEditHistoryEntry>

optional

List of historical edits for this object type

Show child attributes

totalCount

integer

optional

Count of items in the data array above

nextPageToken

string

optional

Token for retrieving the next page of results

Examples

Request

Copied!

curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/objectTypes/Employee/editsHistory?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" \
	-d ''