Fetch all entities

GET /cs-close-api/entities
Oidc Oauth2

Retrieve a paginated list of entities for a specified period, which includes their associated dependent entities.

To acquire this data, the crucial parameter is periodId, ensuring the retrieval of all pertinent entities tied to the designated time frame while allowing for efficient pagination control.

Query parameters

  • page integer(int32)

    The page define the current page number. It should be positive integer number and should start with minimum value 1.

    Minimum value is 1.

  • size integer(int32)

    The size define number of records on each page. It should be positive integer number between 1 to 10000.

    Minimum value is 1, maximum value is 10000.

  • sort array[string]

    The sort parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.

  • name string

    The name parameter is an optional filter that allows you to narrow down the results based on specific name content.

  • periodId string Required

    The id of the period for which entity instances are required

Responses

  • 200 application/json

    The requested page of entities.

    Hide response attributes Show response attributes object
    • result array[object]
      Hide result attributes Show result attributes object
      • id integer
      • entityDefinitionId integer
      • snapshotId integer
      • parentId integer
      • name string
      • description string
      • number string
      • periodId integer
      • childCount integer(int32)
      • hasChildren boolean
    • metadata object

      Paging metadata dto.

      Hide metadata attributes Show metadata attributes object
      • totalElements integer(int64)

        The total number of rows in the result set.

      • totalPages integer(int32)

        The total number of pages in the result set, should = totalElements / size

      • first boolean

        True if this is the first page.

      • last boolean

        True if this is the last page.

      • empty boolean

        True if the result is empty.

      • numberOfElements integer(int32)

        The number of results in this page. Will be <= size.

      • size integer(int32)

        The page size.

      • sorted boolean

        True if the results are sorted.
GET /cs-close-api/entities 
curl \
 --request GET 'https://customer.trintech.com/cs-close-api/entities?periodId=string'
Response examples (200) 
{
  "result": [
    {
      "id": 42,
      "entityDefinitionId": 42,
      "snapshotId": 42,
      "parentId": 42,
      "name": "string",
      "description": "string",
      "number": "string",
      "periodId": 42,
      "childCount": 42,
      "hasChildren": true
    }
  ],
  "metadata": {
    "totalElements": 42,
    "totalPages": 42,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 42,
    "size": 42,
    "sorted": true
  }
}