Get object change request

Get object change request.

Note: The response will return change requests created using the Create object change request endpoint. Change requests created from the Web Interface are not returned.

Resource Name: /FireFlow/api/change-requests/object/{changeRequestId}

Request Method: GET

Header requirements:

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

Request Query Body:

Element	Type	Description
`changeRequestId`	integer	The ID of the change request.

Request cURL

curl -k -X POST "https://<localhost>/FireFlow/api/change-requests/object/<changeRequestId>" -H "Cookie:RT_SID_FireFlow.443=<Cookie_value>"

Response

Element		Type	Description
`status`		String	One of the following: `Success` `Failure`
`messages`			Array
	`code`	String	Code (when error)
	`message`	String	Details (when error)
`data`			Array


	`id`	String	The ID of the Change Request .
	`fields`	array	Custom fields
	name	String	Custom field name
	values	array	Custom field contents
	subChangeRequests	list	Displayed only when the change request is a parent ticket
	originalRequestedActions	array	Original requested actions for each rule in the request
	objectName	String	Object name
	requestedAction	String	Requested action type
	values	String	Requested action values
	objectType	String	Type of object. Can be: Network Service

Code

Description

200

Operation completed successfully

400

Input validation failure

403

Authentication failure

Error messages:

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.

Response example (success)

{
  "status": "Success",
  "messages": [],
  "data": {
    "id": 8054,
    "fields": [
      {
        "name": "Owner",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Creator",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Devices",
        "values": [
          "root",
          "SEC01_SEC02"
        ]
      },
      {
        "name": "Ticket Template Name",
        "values": [
          "135: Object Change Multi Device Request"
        ]
      },
      {
        "name": "LastUpdated",
        "values": [
          "2022-10-26 09:56:21"
        ]
      },
      {
        "name": "Requestor",
        "values": [
          "admin<[email protected]>"
        ]
      },
      {
        "name": "Form Type",
        "values": [
          "Object Change Multi Device"
        ]
      },
      {
        "name": "Workflow",
        "values": [
          "Object-Change-Multi-Device"
        ]
      },
      {
        "name": "Subject",
        "values": [
          "Create Service Objects"
        ]
      },
      {
        "name": "status",
        "values": [
          "implement"
        ]
      }
    ],
    "subChangeRequests": [
      8055,
      8056
    ],
    "originalRequestedActions": [
      {
        "objectName": "Test26Oct01",
        "requestedAction": "CREATE",
        "values": [
          "tcp/114"
        ],
        "objectType": "Service"
      },
      {
        "objectName": "Test26Oct02",
        "requestedAction": "CREATE",
        "values": [
          "tcp/115"
        ],
        "objectType": "Service"
      },
      {
        "objectName": "Test26Oct03",
        "requestedAction": "CREATE",
        "values": [
          "tcp/116"
        ],
        "objectType": "Service"
      },
      {
        "objectName": "Test26Oct04",
        "requestedAction": "CREATE",
        "values": [
          "tcp/117"
        ],
        "objectType": "Service"
      },
      {
        "objectName": "Test26Oct05",
        "requestedAction": "CREATE",
        "values": [
          "tcp/118"
        ],
        "objectType": "Service"
      },
      {
        "objectName": "Test26Oct06",
        "requestedAction": "CREATE",
        "values": [
          "tcp/119"
        ],
        "objectType": "Service"
      }
    ]
  }
}

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:  Object Change Multi Device"
    }
  ],
  "data": null
}