GetEntity

Command, Introduced in version 2.18

POST https://localhost:8001/sv/001.1/api/v1/Common/Commands/GetEntity

Queries out a specific entity from the Query API by identifier.

Returns EntityCommandResponse

The root entity id of the response is the business key identifier of the queried entity.

The entity id of the response is the same as the root entity id.

The Data property of the response is populated with the queried entity encoded as JSON.

Properties

Name Type Summary Introduced in
Path String The API query path to the entity that you want to query.

For example /Sales/Customers.

  • Mandatory
EntityId Int64 The identifier of the entity that you want to query.

  • Mandatory
Expands String[] A list of expandable properties that should be expanded when queried.

  • None by default

Example

{
  "Path": null,
  "EntityId": 0,
  "Expands": null
}