API xm entity resource GET api xm entities by ids

xm-entity-resource GET /api/xm-entities-by-ids

Objective

This API could be used to minimize request counts to entity microservice to get information by a list of entities.

Parameters

• ids - array with ids of entities.
• embed - optional parameter to identify embeded data should be added to the entities. Allowed types:
  • targets - entity will include targets with linked entities if present
  • locations - entity will include locations if present
  • ratings - entity will include ratings if present
  • calendars - entity will include calendars if present
  • calendars.events - entity will include calendars with events if present
  • attachments - entity will include attachments if present
  • tags - entity will include tags if present
  • functionContexts - entity will include function contexts if present
• page - optional parameter with number of the requested page.
• size - optional parameter with size of a page.
• sort - optional parameter with sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

curl example

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer <token>' 'https://host/entity/api/xm-entities-by-ids?ids=951&ids=952'