Retrieve collection of incidents

get

/services/rest/connect/v1.4/incidents

Request

Supported Media Types
Query Parameters
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name
  • The requested page size, which limits the number of elements the collection should max return
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Returns the count of elements as the given order. The value is a comma delimited string. Each token in the string is the name of the field, optionally followed by asc or desc.
  • Query parameter that allows searching by providing ROQL WHERE clause filtering
  • Indicates whether or not to calculate the totalResults property. By default, totalResults is not calculated.

Response

Supported Media Types

Default Response

Body ()
Collection of incidents
Root Schema : incidents-collection
Type: object
Collection of incidents
Show Source

Examples

Use GET with the following syntax to list all incidents:

https://your_site_interface/services/rest/connect/version/incidents

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/incidents

Response body example

{
    "items": [
        {
            "id": 1,
            "lookupName": "100909-000000",
            "createdTime": "2013-08-21T21:13:23Z",
            "updatedTime": "2013-11-11T21:00:25Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents/1"
                }
            ]
        },
        {
            "id": 2,
            "lookupName": "100909-000001",
            "createdTime": "2013-08-21T21:15:50Z",
            "updatedTime": "2013-11-11T21:00:14Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents/2"
                }
            ]
        },

        ...

        {
            "id": 65,
            "lookupName": "150929-000001",
            "createdTime": "2015-09-29T17:19:40Z",
            "updatedTime": "2015-09-29T17:19:40Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents/65"
                }
            ]
        },
        {
            "id": 66,
            "lookupName": "150929-000002",
            "createdTime": "2015-09-29T20:17:11Z",
            "updatedTime": "2015-09-29T20:17:11Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents/66"
                }
            ]
        }
    ],
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/incidents",
            "mediaType": "application/schema+json"
        },
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/incidents"
        }
    ]
}