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.
Lists the linked objects for a specific object and the given link type.
Invalid link type results in an InvalidOntologyTypes error.
stringThe primary key of the object from which the links originate.
stringThe type of the link that exists between the object and the requested objects.
integerThe maximum size of the page to return. The default is 1,000 and the maximum allowed is 1,000. If a page size greater than 1,000 is requested, then it will default to 1,000. The service may return fewer or more results than requested, but will always return at least one result per page as long as there are more results.
stringThe page token indicates where to start paging. This should be omitted from the first page request and
populated from the nextPageToken field of the previous response in subsequent requests
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectSuccess response
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and populate the next request's pageToken field with it.
list<GothamOntologyObject>objectRepresents an object in the Object Store.
stringThe primary key/unique identifier of an object, useful for interacting with Gotham APIs to load and mutate objects.
stringThe title of an object, which represents a display-friendly String of what the object represents.
stringThe name of the object in the API - also called the Object Type URI.
map<PropertyApiName, array>A map of the property values of the object.
stringThe name of the property in the API - also called the Property Type URI.
list<PropertyValue>anyRepresents the value of a property. The following table provides expected representations of scalar data types:
| Type | JSON encoding | Example |
|---|---|---|
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
objectnumbernumbernumberobjectRepresents 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.
stringstring1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/objects/ri.gotham.111111-0.object-internal.111111/links/com.palantir.link.parentof?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
[
{
"primaryKey": "ri.gotham.111111-0.object-internal.222222",
"objectType": "com.palantir.object.person",
"properties": {
"com.palantir.property.name": [
{
"FIRST_NAME": "Chris",
"LAST_NAME": "Smith"
}
],
"com.palantir.property.age": [
78
]
}
},
{
"primaryKey": "ri.gotham.111111-0.object-internal.333333",
"objectType": "com.palantir.object.person",
"properties": {
"com.palantir.property.name": [
{
"FIRST_NAME": "Mary",
"LAST_NAME": "Smith"
}
],
"com.palantir.property.age": [
79
]
}
}
]