API Reference
Search documentation
karat

+

K

User Documentation ↗

Resolve objects

PUT/api/gotham/v1/objects/{primaryKey}/resolution
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.

Resolves two or more objects together.

Path parameters

primaryKey
string

The primary key of one object to resolve.

Query parameters

resolvedObjectPrimaryKeys
list<ObjectPrimaryKey>
optional

The primary key of the other objects to resolve.

Show child attributes

Show child attributes

ObjectPrimaryKey
string

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

preview
boolean
optional

Represents a boolean value that restricts an endpoint to preview mode when set to true.

Response body

ObjectPrimaryKey
string

The primary key for the resolved object.

Examples

Request

Copied!
1 2 3 curl -X PUT \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/gotham/v1/objects/ri.gotham.111111-0.object-internal.111111/resolution?resolvedObjectPrimaryKeys=ri.gotham.111111-0.object-internal.222222&preview=true"

Response

Copied!
1 ri.gotham.111111-0.object-internal.111111