Get active task definitions
Lists the active task definitions in the system which are accessible to the current user. Returns the requested page of task definitions.
Query parameters
-
The identifier of the entity definition. Only task definitions defined for the specified entity definition will be returned if active and accessible to current user.
-
Governs if child task definitions are loaded and, if so, how deeply we traverse the tree. If not provided, we do not load child task definitions.
Minimum value is
0
, maximum value is5
. -
The
page
define the current page number. It should be positive integer number and should start with minimum value 1.Minimum value is
1
. -
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
. -
The
sort
parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending. -
The
name
parameter is an optional filter that allows you to narrow down the results based on specific name content.
curl \
--request GET 'https://customer.trintech.com/cs-close-api/task-definitions'
{
"result": [
{
"id": 42,
"parentId": 42,
"name": "string",
"number": "string",
"description": "string",
"instructions": "string",
"isCritical": true,
"entity": {
"id": {},
"name": "string"
},
"performer": {
"id": 42,
"name": "string",
"email": "string",
"userName": "string",
"first": "string",
"middle": "string",
"last": "string"
},
"reviewer": {
"id": 42,
"name": "string",
"email": "string",
"userName": "string",
"first": "string",
"middle": "string",
"last": "string"
},
"approver": {
"id": 42,
"name": "string",
"email": "string",
"userName": "string",
"first": "string",
"middle": "string",
"last": "string"
},
"children": [
{
"id": {},
"name": "string"
}
]
}
],
"metadata": {
"totalElements": 42,
"totalPages": 42,
"first": true,
"last": true,
"empty": true,
"numberOfElements": 42,
"size": 42,
"sorted": true
}
}