Search documentation
karat

+

K

User Documentation ↗

Get object

GET/api/gotham/v1/objects/{primaryKey}

Gets a specific object with the given primary key.

Path parameters

primaryKey
string

The primary key of the requested object.

Response body

GetObjectResponse
object

Success response

Hide child attributes

Hide child attributes

primaryKey
string

The primary key/unique identifier of an object, useful for interacting with Gotham APIs to load and mutate objects.

title
string
optional

The title of an object, which represents a display-friendly String of what the object represents.

objectType
string

The name of the object in the API - also called the Object Type URI.

properties
map<PropertyApiName, array>
optional

A map of the property values of the object.

Show child attributes

Show child attributes

PropertyApiName
string

The name of the property in the API - also called the Property Type URI.

array
list<PropertyValue>
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property. The following table provides expected representations of scalar data types:

TypeJSON encodingExample
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Integernumber238940
Longstring"58319870951433"
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
intrinsicCoordinates
object
optional
Show child attributes

Show child attributes

longitude
number
latitude
number
elevation
number
optional
timeInterval
object
optional

Represents a time interval by its start and end datetime. TimeInterval is generally used when an Object has a meaningful start and/or end datetime, such as an event. For example, a Meeting might have start and end datetimes corresponding to when the meeting began and ended.

Show child attributes

Show child attributes

timeStart
string
optional
timeEnd
string
optional

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/objects/ri.gotham.111111-0.object-internal.111111"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "primaryKey": "ri.gotham.111111-0.object-internal.111111", "objectType": "com.palantir.object.person", "properties": { "com.palantir.property.name": [ { "FIRST_NAME": "John", "LAST_NAME": "Smith" } ], "com.palantir.property.age": [ 37 ] } }