Get rule removal ticket details by change request ID

Get rule removal ticket details by change request ID .

Resource name: /FireFlow/api/change-requests/rule-removal/{changeRequestId}

Request method: GET

Header requirements:

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

Request query parameters:

  Element Type Description

changeRequestId

mandatory

 String

The ID of the change request.

Response:

Element Type Description
status String

One of the following:

  • Success
  • Failure
messages Array
  code String A string that indicates the response code.
  message String Further details about the response, if needed.
data Array
  changeRequestID String The ID of the requested change request.
  fields array Custom fields
  originalRequestedActions array Original requested actions for each rule in the request
  ruleID String The rule’s ID
  action String The requested action for the rule (remove or disable)

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 - Change request 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

Request cURL

curl -k -X POST "https://<machine_IP>/FireFlow/api/change-requests/rule-removal/{changeRequestId}" -H "Cookie:RT_SID_FireFlow.443=<Cookie_value>"

Response example (success)

Copy 
{
  "status": "Success",
  "messages": [],
  "data": {
    "id": 7,
    "fields": [
      {
        "name": "Owner",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Creator",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Devices",
        "values": [
          "10_20_26_1_David_Bowie_Ashes_To_Ashes_Ashes_To_Ashes_VR"
        ]
      },
      {
        "name": "Ticket Template Name",
        "values": [
          "140: Rule Removal Request"
        ]
      },
      {
        "name": "LastUpdated",
        "values": [
          "2022-08-04 11:12:53"
        ]
      },
      {
        "name": "Requestor",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Form Type",
        "values": [
          "Rule Removal"
        ]
      },
      {
        "name": "Workflow",
        "values": [
          "Rule-Removal"
        ]
      },
      {
        "name": "Subject",
        "values": [
          "RRCR from API test with disable action"
        ]
      },
      {
        "name": "status",
        "values": [
          "open"
        ]
      }
    ],
    "ruleRemovalDetails": [
      {
        "ruleId": "SUP-6691_v2",
        "action": "Disable rule"
      },
      {
        "ruleId": "N2-Traffic",
        "action": "Disable rule"
      }
    ]
  }
}

Response example (failure) 1

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

Response example (failure) 2

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