v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

TaskTypes.list

Returns all defined TaskTypes

get/entities/TaskTypes

Query parameters

include-deletedboolean

if enabled, deleted TaskTypes are returned as well

firstinteger

Number of entities to return from beginning of the result set. Max: 100. Default: 30

lastinteger

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

beforestring

Cursor until which to take entities to result set.

afterstring

Cursor after which to start taking entities to result set.

expandstring

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

order-bystring

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

filterobject

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-opobject

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-onlystring

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Response

list of TaskTypes

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": [
    {
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "name": "string",
      "revision": 1
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}