Get ticket details by generic Request ID

Returns full details about a specified generic change request, including custom fields configured for the template.

Tip: Use generic ticket APIs to document change request tickets for devices for unique business needs which are not addressed within existing FireFlow workflows.

Resource Name: /change-requests/generic/{changeRequestId}

Request Method: GET

Header requirements:

Key Value
Cookie FireFlow_Session=[sessionId]. The sessionId is retrieved from the authentication request.

Request URL Parameters:

Element

Type

Description

changeRequestId
Mandatory

Integer

The ID of the change request you want to return data for.

Response:

Code

Description
200

Operation completed successfully

400

Input validation failure

Message Code Message text Parameters
INVALID_FORM_TYPE Invalid template form type, form type should be: {0} 0 - RequestType ("Traffic Change"/"Rule Removal"...)
CHANGE_REQUEST_NOT_FOUND Change request {0} not found 0 - CR id
403

Authentication failure

Message Code Message text Parameters
NO_PERMISSIONS There are no permissions to process the requested operation N/A
INVALID_SESSION_KEY The session key provided is invalid N/A
EXPIRED_SESSION_KEY The session key provided has expired N/A
BAD_COOKIE_HEADER Cookie header is missing or has non-expected value N/A
UNAUTHORIZED_DEVICE User has no permission for some of the devices in this request or some devices are not available N/A
500

Failed to complete operation.

Message Code Message text Parameters
UNEXPECTED_ERROR_OCCURRED Unexpected error occurred N/A

Sample request

curl -X GET "https://192.168.11.23/FireFlow/api/change-requests/generic/5678" -H "accept: */*"

Sample response (success)

  {
  "status": "Success",
  "messages": [],
  "data": {
    "id": 3,
    "fields": [
      {
        "name": "Owner",
        "values": [
          "Nobody<>"
        ]
      },
      {
        "name": "Create tickets from attachment",
        "values": [
          "Yes"
        ]
      },
      {
        "name": "Creator",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Ticket Template Name",
        "values": [
          "120: Generic request"
        ]
      },
      {
        "name": "Resolved",
        "values": [
          "2022-07-07 09:45:51"
        ]
      },
      {
        "name": "LastUpdated",
        "values": [
          "2022-07-07 09:45:52"
        ]
      },
      {
        "name": "Requestor",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Form Type",
        "values": [
          "Generic Change"
        ]
      },
      {
        "name": "DependedOnBy",
        "values": [
          "4"
        ]
      },
      {
        "name": "Workflow",
        "values": [
          "Generic"
        ]
      },
      {
        "name": "Subject",
        "values": [
          "test - multiple mode"
        ]
      },
      {
        "name": "status",
        "values": [
          "resolved"
        ]
      }
    ]
  }
}

Sample response (Failure)

  {
  "status": "Failure",
  "messages": [
    {
      "code": "CHANGE_REQUEST_NOT_FOUND",
      "message": "Change request 7 not found"
    }
  ],
  "data": null
}

Sample response (Failure)

 {
  "status": "Failure",
  "messages": [
    {
      "code": "INVALID_FORM_TYPE",
      "message": "Invalid template form type, form type should be: Generic Change"
    }
  ],
  "data": null
}