API Reference

Apply Action Batch

POST/api/v2/ontologies/{ontology}/actions/{action}/applyBatch

Applies multiple actions (of the same Action Type) using the given parameters. Changes to the Ontology are eventually consistent and may take some time to be visible.

Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit.

Note that notifications are not currently supported by this endpoint.

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

Path parameters

ontology

string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

action

string

The API name of the action to apply. To find the API name for your action, use the List action types endpoint or check the Ontology Manager.

Query parameters

artifactRepository

string

optional

The repository associated with a marketplace installation.

packageName

string

optional

The package name of the generated SDK.

Request body

BatchApplyActionRequestV2

object

Hide child attributes

options

object

optional

Show child attributes

returnEdits

string (enum)

optional

Enum values: ALL, NONE

requests

list<BatchApplyActionRequestItem>

optional

Show child attributes

BatchApplyActionRequestItem

object

Show child attributes

parameters

map<ParameterId, DataValue>

optional

Show child attributes

ParameterId

string

The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. Parameters can be viewed and managed in the Ontology Manager.

DataValue

any

Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	string	`"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Float	number	`3.14159265`
Double	number	`3.14159265`
Integer	number	`238940`
Long	string	`"58319870951433"`
Marking	string	`"MU"`
Null	null	`null`
Object Set	string OR the object set definition	`ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`
Ontology Object Reference	JSON encoding of the object's primary key	`10033123` or `"EMP1234"`
Set	array	`["alpha", "bravo", "charlie"]`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Struct	JSON object	`{"name": "John Doe", "age": 42}`
TwoDimensionalAggregation	JSON object	`{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}`
ThreeDimensionalAggregation	JSON object	`{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Response body

BatchApplyActionResponseV2

object

Success response.

Hide child attributes

edits

union

optional

Show child attributes

edits

object

optional

Show child attributes

edits

list<ObjectEdit>

optional

Show child attributes

ObjectEdit

union

Show child attributes

modifyObject

object

optional

Show child attributes

primaryKey

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

objectType

string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

addObject

object

optional

Show child attributes

primaryKey

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

objectType

string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

addLink

object

optional

Show child attributes

linkTypeApiNameAtoB

string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.

linkTypeApiNameBtoA

string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.

aSideObject

object

Show child attributes

primaryKey

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

objectType

string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

bSideObject

object

Show child attributes

primaryKey

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

objectType

string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

addedObjectCount

integer

modifiedObjectsCount

integer

deletedObjectsCount

integer

addedLinksCount

integer

deletedLinksCount

integer

largeScaleEdits

object

optional

Show child attributes

editedObjectTypes

list<ObjectTypeApiName>

optional

Show child attributes

ObjectTypeApiName

string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/actions/rename-employee/applyBatch" \
	-d '{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}'

Response

Copied!

{}