Fetch entity by id

GET /entities/{id}

Retrieve an entity's details by providing its unique ID. This operation allows for the precise access of information related to a specific entity within the dataset.

Path parameters

id integer Required

identifier for the entity to fetch the details for.

Responses

200 application/json

The dto which details the entity attributes.
Hide response attributes Show response attributes object
- id integer
- entityDefinitionId integer
- snapshotId integer
- parentId integer
- name string
- description string
- number string
- periodId integer
- childCount integer(int32)
- hasChildren boolean

GET /entities/{id}

curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/entities/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": 42,
  "entityDefinitionId": 42,
  "snapshotId": 42,
  "parentId": 42,
  "name": "string",
  "description": "string",
  "number": "string",
  "periodId": 42,
  "childCount": 42,
  "hasChildren": true
}