Entities by definition
The Entities by definition resource contains the collection of entities associated with the specified entity definition.
This resource only supports the GET method.
GET /api/entitydefinitions/{name}/entities{?skip,take}
Retrieves the collection of entities associated with the specified entity definition. The response contains a collection of Entity Objects.
The following table provides a list of query parameters and related information.
Parameter |
Type |
Information |
---|---|---|
skip |
integer |
The number of definitions to skip. |
take |
integer |
The number of definitions to return. |
filter |
string |
Additional filters. |
definitionsToLoad |
string |
Deprecated, use definitionsToLoadByName. |
definitionsToLoadByName |
string |
Comma-separated list of definition names. |
definitionsToLoadById |
string |
Comma-separated list of definition IDs. |
viewMode |
basic/extended |
The view mode. |
loadPermissions |
boolean |
Flag for loading permissions. |
includeConditionalMembers |
boolean |
Flag for including conditional members. |
excludeTaxonomyDefinitions |
boolean |
Flag for excluding taxonomy definitions. |
excludeSystemOwnedDefinitions |
boolean |
Flag for excluding system owned definitions. |
Chunking
If there are more entities than can fit in a single chunk, a link is included to retrieve the next chunk.
Ranging
If the take parameter is specified, the number of entities returned is limited to that parameter (up to 100). The skip parameter can also be included to further determine which range of entities is returned.
Example Request:
GET http://<hostname>/api/entitydefinitions/EntityDefinition1/entities
Host: hostname
Accept: application/json
Example Response:
HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"
{
"items": [
{
"id":100,
"properties":{
"Property1":"Some value",
"Property2":42
},
"relations":...
"self":{
"href":"http://<hostname>/api/entities/1"
}
}
],
"next",{
"href":"http://<hostname>/api/entitydefinitions/EntityDefinition1/entities/?skip=25"
}
"returned_items":25,
"self":{
"href":"http://<hostname>/api/entitydefinitions/EntityDefinition1/entities"
},
"total_items":1245
}