API Reference

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

SelectedPropertyApiName

string

By default, anytime an object is requested, every property belonging to that object is returned. The response can be filtered to only include certain properties using the properties query parameter.

Properties to include can be specified in one of two ways.

A comma delimited list as the value for the properties query parameter properties={property1ApiName},{property2ApiName}
Multiple properties query parameters. properties={property1ApiName}&properties={property2ApiName}

The primary key of the object will always be returned even if it wasn't specified in the properties values.

Unknown properties specified in the properties list will result in a PropertiesNotFound error.

To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

Response body

OntologyObject

object

Success response.

Hide child attributes

properties

map<PropertyApiName, PropertyValue>

optional

A map of the property values of the object.

Show child attributes

PropertyApiName

string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

PropertyValue

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.

rid

string

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

Examples

Request

Copied!

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

Response

Copied!

{
  "rid": "ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61",
  "properties": {
    "id": 50030,
    "firstName": "John",
    "lastName": "Doe"
  }
}