Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Create Temporary Object Set

POST/api/v2/ontologies/{ontology}/objectSets/createTemporary
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.

Creates a temporary ObjectSet from the given definition. This ObjectSet expires after one hour.

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 or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager.

Query parameters

branch
stringoptional

The Foundry branch to reference. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.

sdkPackageRid
stringoptional

The package rid of the generated SDK.

sdkVersion
stringoptional

The package version of the generated SDK.

preview
booleanoptional

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

Request body

CreateTemporaryObjectSetRequestV2
object
Hide child attributes

Hide child attributes

objectSet
union

Represents the definition of an ObjectSet in the Ontology.

Show child attributes

Show child attributes

Response body

CreateTemporaryObjectSetResponseV2
object

Success response.

Hide child attributes

Hide child attributes

objectSetRid
string

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/objectSets/createTemporary?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true" \ -d '{"objectSet":{"type":"base","objectType":"Employee"}}'

Response

Copied!
1 2 3 { "objectSetRid": "ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053" }