Downloading Incident Report


Overview

Download incident report associated with specific tenant.


Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/ecl-api/tickets/{ticketid}?tenantid={tenantid}&usertoken={x-subject-token}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters
Parameter Type Format Description Required
tenantid String UUID Tenant ID of the owner (UUID) Yes
usertoken String UUID User Token (UUID) Yes
ticketid String Numeric Ticket Id registered in MSA Yes

Sample Request Body

This API does not require Request Body.


Response

HTTP Response Code

Response Codes
Response Code Description
200 OK
400 Request format is invalid
401 Unauthorized
404 Not found
500 Internal Server Error

Response Parameter

Response Parameters
Parameter Type Format Description
ticket Object - Object showing incident ticket report associated with specific tenant
id String Numeric Ticket Id registered in MSA
title String - Title of the Ticket
category String - Ticket category
status String - Ticket status
priority String - Ticket priority
submitter String UUID Submitter [tenant] UUID
date String YYYY-MM-DD HH:MM:SS Ticket creation date
comments Array - Array showing Ticket comments
comment String - Ticket comment
date String YYYY-MM-DD HH:MM:SS Ticket comment date with submitter

Sample Response Body

Normal Response

{
    "ticket": {
         "id": "23",
         "title": "sbe",
         "category": "router",
         "status": "requested",
         "priority": "high",
         "submitter": "e6fff086078e4977aa7a441bf4bfadf4",
         "date": "2017-04-18 15:13:22",
         "comments": [{
              "comment": "new comment",
              "date": "2017-04-18 15:13:10 e6fff086078e4977aa7a441bf4bfadf4"
         }]
    }
}

Error Response

{
    "error": {
         "message": "error message"
    }
}
Listing Incident Tickets
Port Management for Single Constitution FW/UTM