Partial entities

Limit the requested member groups and member group properties of an entity in order to reduce the response size.

To do this, use one or both of the following parameters:

Name

Type

Description

groups

String

the name value(s) of the requested member_groups object

members

String

the name value(s) of the requested members that are present in the member_groups object.

Note that multiple values need to be separated by a ,

Absence of these parameters defaults to 'select all'. This functionality is limited to the /entities resource and only GET, HEAD and PUT requests are supported.

Example with partial request for member

RequestResponse

GET /entities/1?members=Title,FileSize

Response:

RequestResponse

{
  "id": 6077,
  "identifier": "655J0JFYmEC6AE8uYVL9kA",
  "properties": {
    "Title": "Pork Belly Ssäm with Mustard Seed Sauce",
    "FileSize": 0.1
  }

  ...
}

Example with partial request for member group

RequestResponse

GET /entities/1?groups=Content

Response:

RequestResponse

{
  "id": 6077,
  "identifier": "655J0JFYmEC6AE8uYVL9kA",
  "properties": {
    "Title": "Pork Belly Ssäm with Mustard Seed Sauce",
  }

  ...
}

Do you have some feedback for us?

If you have suggestions for improving this article,