Retrieve a list of all entities for a specific entity definition

Request

Lists all entities for the specified entity definition.

Security

OAuth2

Path

namestringrequired

Entity definition name to use when filtering the entities, for example M.Asset.

Query

skipinteger, (int32)

Number of entities to skip before retrieving results, for example 1.

takeinteger, (int32)

Number of entities to retrieve, for example 2.

culturestring

User culture in which to load the entities, for example en-US.

filterstring

Additional filters to apply when retrieving entities, for example status:active AND type:image.

groupsstring

Member groups to include in the retrieved entities, for example PreambleGroup,ChoiceGroup.

membersstring

Members to include in the retrieved entities, for example PreambleThemeProperty,ChoiceThemeProperty.

nestedRelationsArray of strings

Nested relations to retrieve. Expected format: <name>|<role>[|<propertyName>].

curl -i -X GET \
  'https://your-server/api/entitydefinitions/{name}/entities?skip=0&take=0&culture=string&filter=string&groups=string&members=string&nestedRelations=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

last_hit_dataArray of strings or null

The last returned hits, which are used to fetch the next page of results.

itemsArray of objects or null(EntityResource)

Gets or sets the list of items.

total_itemsinteger or null, (int64)

Gets or sets the total number of items.

returned_itemsinteger or null, (int64)

Gets or sets the number of returned items.

offsetinteger or null, (int32)

Gets or sets the offset of the items.

nextobject(Link)

Represents a link to a resource.

previousobject(Link)

Represents a link to a resource.

identifierstring or null

Gets or sets the identifier of the resource.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property

Response

{
  "last_hit_data": [
    "string"
  ],
  "items": [
    { … }
  ],
  "total_items": 0,
  "returned_items": 0,
  "offset": 0,
  "next": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "previous": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "identifier": "string",
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}