Returns a list of active issues associated with the account, scoped by the user's permissions
GET {{baseUrl}}/api/v1/issues?offset=-15748812&limit=-15748812&filter=t&sort=/issues?sort=id desc&select=t
Returns the active (state=CREATED
) issues for the account, which are associated with the resource-types for which the user has access. The user should also have the permission to view issues.
Eg: if there are issues associated with 50 resources (of different resource-types) for a customer (obtained from the request header),
and the user (obtained from the request headers), who has correct permissions to view the issues but has acceess to only 20 of those resources (ie access to their resource types),
this API will return only the issues associated with those 20 resources. The grouped issues are places next to each other. The client will have to process them for any desired grouping
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | number | The number of items to skip before starting to collect the result set | |
limit | number | The numbers of items to return | |
filter | string | The filter query parameter is used to filter the set of resources returned in the response. | |
| The returned set of resources must match the criteria in the filter query parameter | |||
| A comparision compares a property name to a literal. The comparisons supported are the following: | |||
| “eq” : Is a property equal to value. Valid for number, boolean and string properties. | |||
| “gt” : Is a property greater than a value. Valid for number or string timestamp properties. | |||
| “lt” : Is a property less than a value. Valid for number or string timestamp properties | |||
| “in” : Is a value in a property (that is an array of strings) | |||
| Syntax: | |||
| “eq” : filter=<property> eq <value> {host:port}/api/v1/issues?filter=<property> eq <value> | |||
| “gt” : filter=<property> gt <value> {host:port}/api/v1/issues?filter=<property> gt <value> | |||
| “lt” : filter=<property> lt <value> {host:port}/api/v1/issues?filter=<property> lt <value> | |||
| “in” : filter=<property> in <value> {host:port}/api/v1/issues?filter=<property> in <value> |
- Can use and to add more filter inputs {host:port}/api/v1/issues?filter=<property1> eq <value1> and <property2> lt <value2>
- To filter multiple values on one property e.g. filter=severity in ('CRITICAL','WARNING') {host:port}/api/v1/issues?filter=severity%20in%20CRITICAL%2CWARNING
Examples:
GET /api/v1/issues?filter=issueType eq 'ISSUE'
GET /api/v1/issues?filter=issueType eq 'ISSUE' and state eq 'CREATED'
GET /api/v1/issues?filter=relatedObjectType in ('NIMBLE-VOLUME')
Filters are supported on following attributes:
issueType,
severity,
category,
state,
relatedObject (relatedObject.resourceUri),
relatedObjectType (relatedObject.type),
relatedObjectOwner (relatedObjectOwner.resourceUri),
relatedObjectOwnerType (relatedObjectOwner.type),
ruleId,
createdAt
|
|
sort| string | | resource property to sort, with an order appended Order may only be either “asc” (ascending) or “desc” (descending) | |select| string | | The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"pageOffset":-99755372,"pageLimit":9002552,"total":49368078}