Oracle Management Cloud Common REST API

Get details of the associated tickets for the alert

get

/serviceapi/eventServices/alerts/{alertId}/tickets

Retrieves details of the associated tickets for the alert.

Request

Supported Media Types

application/json

Path Parameters

alertId: string

The id of the alert

Query Parameters

limit(optional): integer(int32)

the number of entries in the result to be returend in one REST call

Default Value: 50
offset(optional): integer(int32)

the offset into the result list when doing a query with limit

Default Value: 0

Response

Supported Media Types

application/json

200 Response

query was successful

Root Schema : ItemListAlertTicketInfo

Type: object

It is describing the list of tickets returned in response to an alert tickets request.

Show Source

count: integer(int32)

The number of items in the list
hasMore: boolean

Default Value: false

Indicates if there are more items
items: array items

The items
nextLink(optional): string

The link to get the next chunk of items (if paging)
previousLink(optional): string

The link to the previous chunk of items (if paging)

{
    "type":"object",
    "required":[
        "count",
        "hasMore",
        "items"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in the list"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more items",
            "default":false
        },
        "items":{
            "type":"array",
            "description":"The items",
            "items":{
                "$ref":"#/definitions/AlertTicketInfo"
            }
        },
        "nextLink":{
            "type":"string",
            "description":"The link to get the next chunk of items (if paging)"
        },
        "previousLink":{
            "type":"string",
            "description":"The link to the previous chunk of items (if paging)"
        }
    },
    "description":"<p>\n It is describing the list of tickets returned in response to an alert tickets request.\n</p>"
}

Nested Schema : items

Type: array

The items

Show Source

Array of: object AlertTicketInfo

It is possible to configure alert rules to create/update tickets in external ticketing systems for the alerts managed in Oracle Management Cloud. Each ticket (associated with an alert) has various properties that describe it. The ticket is uniquely identified by its id in Oracle Management Cloud. The reference id is the corresponding identifier in the ticketing system. The status property corresponds to its current status in the ticketing system. Associated ticket can be accessed via the url.

{
    "type":"array",
    "description":"The items",
    "items":{
        "$ref":"#/definitions/AlertTicketInfo"
    }
}

Nested Schema : AlertTicketInfo

Type: object

It is possible to configure alert rules to create/update tickets in external ticketing systems for the alerts managed in Oracle Management Cloud. Each ticket (associated with an alert) has various properties that describe it. The ticket is uniquely identified by its id in Oracle Management Cloud. The reference id is the corresponding identifier in the ticketing system. The status property corresponds to its current status in the ticketing system. Associated ticket can be accessed via the url.

Show Source

openTime: string

The time (in UTC) when ticket was opened

Example: 2020-09-02T19:41:53.281Z
referenceId: string

The reference id in ticketing system

Example: fe81b96fa5f572651348495dd4b97735
status: string

The status of ticket in ticketing system

Example: New
ticketId: string

The ticket id in Oracle Management Cloud

Example: INC0000026
ticketType: string

The type of ticketing system

Example: ServiceNow
updatedTime: string

The last time (in UTC) when ticket was updated

Example: 2020-09-02T19:51:56.032Z
url: string

The url to access ticket in ticketing system

Example: https://demo.service-now.com/nav_to.do?uri=incident.do?sys_id=fe81b96fa5f572651348495dd4b97735%26sysparm_view=ess

{
    "type":"object",
    "required":[
        "ticketId",
        "referenceId",
        "ticketType",
        "status",
        "url",
        "openTime",
        "updatedTime"
    ],
    "properties":{
        "ticketId":{
            "type":"string",
            "description":"The ticket id in Oracle Management Cloud",
            "example":"INC0000026"
        },
        "referenceId":{
            "type":"string",
            "description":"The reference id in ticketing system",
            "example":"fe81b96fa5f572651348495dd4b97735"
        },
        "ticketType":{
            "type":"string",
            "description":"The type of ticketing system",
            "example":"ServiceNow"
        },
        "status":{
            "type":"string",
            "description":"The status of ticket in ticketing system",
            "example":"New"
        },
        "url":{
            "type":"string",
            "description":"The url to access ticket in ticketing system",
            "example":"https://demo.service-now.com/nav_to.do?uri=incident.do?sys_id=fe81b96fa5f572651348495dd4b97735%26sysparm_view=ess"
        },
        "openTime":{
            "type":"string",
            "description":"The time (in UTC) when ticket was opened",
            "example":"2020-09-02T19:41:53.281Z"
        },
        "updatedTime":{
            "type":"string",
            "description":"The last time (in UTC) when ticket was updated",
            "example":"2020-09-02T19:51:56.032Z"
        }
    },
    "description":"<p>\n It is possible to configure alert rules to create/update tickets in external ticketing systems for the alerts managed in Oracle Management Cloud. Each ticket (associated with an alert) has various properties that describe it.\n  The ticket is uniquely identified by its id in Oracle Management Cloud. The reference id is the corresponding identifier in the ticketing system. The status property corresponds to its current status in the ticketing system. Associated ticket can be accessed via the url.\n</p>"
}

400 Response

The alert id is invalid

Root Schema : InvalidRequest

Type: object

When invalid alert API request is received, alert system returns this response.

Show Source

errorCode: string

The alert system's internal error code
errorMessage: string

The alert system's internal error message
httpMessage: string

The http error message
httpStatusCode: string

Default Value: 400

The http status code

{
    "type":"object",
    "required":[
        "httpStatusCode",
        "httpMessage",
        "errorCode",
        "errorMessage"
    ],
    "properties":{
        "httpStatusCode":{
            "type":"string",
            "description":"The http status code",
            "default":"400"
        },
        "httpMessage":{
            "type":"string",
            "description":"The http error message"
        },
        "errorCode":{
            "type":"string",
            "description":"The alert system's internal error code"
        },
        "errorMessage":{
            "type":"string",
            "description":"The alert system's internal error message"
        }
    },
    "description":"<p>\n When invalid alert API request is received, alert system returns this response.\n</p>"
}

500 Response

encountered unhandled exception

Root Schema : UnhandledException

Type: object

When alert system runs into unhandled exception, it returns this response.

Show Source

errorCode: string

Default Value: general_error

The alert system's error code for unhandled exception
errorMessage: string

Default Value: Internal Server Error

The alert system's error message for unhandled exception
httpMessage: string

Default Value: Internal Server Error

The http error message
httpStatusCode: string

Default Value: 500

The http status code

{
    "type":"object",
    "required":[
        "httpStatusCode",
        "httpMessage",
        "errorCode",
        "errorMessage"
    ],
    "properties":{
        "httpStatusCode":{
            "type":"string",
            "description":"The http status code",
            "default":"500"
        },
        "httpMessage":{
            "type":"string",
            "description":"The http error message",
            "default":"Internal Server Error"
        },
        "errorCode":{
            "type":"string",
            "description":"The alert system's error code for unhandled exception",
            "default":"general_error"
        },
        "errorMessage":{
            "type":"string",
            "description":"The alert system's error message for unhandled exception",
            "default":"Internal Server Error"
        }
    },
    "description":"<p>\n When alert system runs into unhandled exception, it returns this response.\n</p>"
}

Examples

Get details of the associated tickets for the alert

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/eventServices/alerts/62965132339213727047162539738389170623/tickets"

The response might look like the following:

    {
     "items": [
      {
       "status": "New",
       "updatedTime": "2020-08-05T06:44:10.327Z",
       "referenceId": "fe81b96fa5f572651348495dd4b97735",
       "url": "https://demo.service-now.com/nav_to.do?uri=incident.do?sys_id=fe81b96fa5f572651348495dd4b97735%26sysparm_view=ess",
       "ticketType": "ServiceNow",
       "openTime": "2020-08-05T06:44:10.327Z",
       "ticketId": "INC0000026"
      }
     ],
     "hasMore": false,
     "count": 1
    }