Search documentation
karat

+

K

User Documentation ↗

Get Object

GET/api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}

Gets a specific object with the given primary key.

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

Path parameters

ontologyRid
string

The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.

objectType
string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

primaryKey
string

The primary key of the requested object. To look up the expected primary key for your object type, use the Get object type endpoint or the Ontology Manager.

Query parameters

properties
list<SelectedPropertyApiName>
optional

The properties of the object type that should be included in the response. Omit this parameter to get all the properties.

Show child attributes

Show child attributes

Response body

OntologyObject
object

Success response.

Hide child attributes

Hide child attributes

properties
map<PropertyApiName, PropertyValue>
optional

A map of the property values of the object.

Show child attributes

Show child attributes

rid
string

The unique resource identifier of an object, useful for interacting with other Foundry APIs.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/50030"

Response

Copied!
1 2 3 4 5 6 7 8 { "rid": "ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61", "properties": { "id": 50030, "firstName": "John", "lastName": "Doe" } }