Fetch all entities
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 is10000
. -
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
curl \
--request GET 'http://close-service:8082/cs-close-api/entities?periodId=string'
{
"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
}
}