Get Active Entity Definitions

GET /cs-close-api/entity-definitions
Oidc Oauth2

The purpose of the "Get Entity Definition List" call is to return a list of ALL Close- Entities that are in Close. The data is similar to what might be seen in the "Details" and "Subtasks" section on the Entity Definition. Details page in Close, and nothing relating to any specific period is returned.

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

    The identifier of the period. Only entities which are part of the specified period will be returned

  • parentId string

    The identifier of the parent entity to return. Included in the result as the single 'root' entity along with all children.

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
      • parentId integer
      • name string
      • number string
      • description string
      • hasChildren boolean
      • childCount integer(int32)
    • 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/entity-definitions 
curl \
 --request GET 'https://customer.trintech.com/cs-close-api/entity-definitions'
Response examples (200) 
{
  "result": [
    {
      "id": 42,
      "parentId": 42,
      "name": "string",
      "number": "string",
      "description": "string",
      "hasChildren": true,
      "childCount": 42
    }
  ],
  "metadata": {
    "totalElements": 42,
    "totalPages": 42,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 42,
    "size": 42,
    "sorted": true
  }
}