Load the ontology objects present in the ObjectSet
from the provided object set definition.
For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
are available, attempting to load another page will result in an ObjectsExceededLimit
error being returned. There is no limit on Object Storage V2 backed objects.
Note that null value properties will not be returned.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read
.
string
The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
string
The repository associated with a marketplace installation.
string
The package name of the generated SDK.
object
Represents the API POST body when loading an ObjectSet
.
union
Represents the definition of an ObjectSet
in the Ontology
.
object
Specifies the ordering of search results by a field and an ordering direction.
list<SelectedPropertyApiName>
string
The 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 use it to populate the pageToken
field of the next request.
integer
The page size to use for the endpoint.
boolean
A flag to exclude the retrieval of the __rid
property.
Setting this to true may improve performance of this endpoint for object types in OSV2.
object
Success response.
list<OntologyObjectV2>
The list of objects in the current Page.
string
The 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 use it to populate the pageToken
field of the next request.
string
The total number of items across all pages.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/objectSets/loadObjects" \
-d '{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"data": [
{
"__rid": "ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851",
"__primaryKey": 50030,
"__apiName": "Employee",
"employeeId": 50030,
"firstName": "John",
"lastName": "Smith",
"age": 21
},
{
"__rid": "ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61",
"__primaryKey": 20090,
"__apiName": "Employee",
"employeeId": 20090,
"firstName": "John",
"lastName": "Haymore",
"age": 27
}
]
}