Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Issues

List Issues

post/tasks/v1/incidents/list

Request body

page_sizeinteger

Optional. Number of issues to be returned in a single request. This must be a value between 1 and 100, any values outside of this range will be ignored. The presence of next_page_token in the response indicates that more results might be available.

page_tokenstring

Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call. This can be used to retrieve more than 100 issues with multiple API calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='

sort_field'SORT_FIELD_UNKNOWN' | 'PRIORITY' | 'DATE_DUE' | 'CREATED_AT' | 'MODIFIED_AT' | 'OCCURRED_AT'

The options available to sort the issues by. By default, the issues will be returned by the date they were last modified in descending order. This should be used in combination with SortDirection to determine how issues are sorted. If either SortField or SortDirection is missing, the default sort order will be used.

  • SORT_FIELD_UNKNOWN: SORT_FIELD_UNKNOWN will return the default sort order.
  • PRIORITY: PRIORITY will sort the issues by incident priority.
  • DATE_DUE: DATE_DUE will sort the issues by due date.
  • CREATED_AT: CREATED_AT will sort the issues by the date they were created.
  • MODIFIED_AT: MODIFIED_AT will sort the issues by the date they were last modified.
  • OCCURRED_AT: OCCURRED_AT will sort the issues by the date they occurred at.
sort_direction'SORT_DIRECTION_UNKNOWN' | 'ASC' | 'DESC'

The options available to define the sort direction.

  • SORT_DIRECTION_UNKNOWN: SORT_DIRECTION_UNKNOWN will return the default sort direction.
  • ASC: ASC will return the sorted issues in ascending order.
  • DESC: DESC will return the sorted issues in descending order.

Response

A successful response.

next_page_tokenstring

If there are more results than those appearing in this response, then next_page_token is included. If empty then there are no more results. To get the next set of results, call GetIncidents method again using the value of next_page_token as page_token. For Example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='

totalinteger

@deprecated: Use GetIncidentsCount instead. Total number of issues found