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. See Authenticating

Request Path Parameters:

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

Request Example cURL

curl -k -X GET "https://<localhost>/FireFlow/api/change-requests/object/12345" -H

Status Codes and Errors

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 Parameters

1. Top-Level Response Object

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 in the change request
	name	String	Custom field name
	values	array	Custom field values
	subChangeRequests	list	Child change request IDs (present only if parent).
	originalRequestedActions	array	List of requested object actions.
	objectName	String	Object name
	requestedAction	String	Requested action type
	values	String	Requested action values
	objectType	String	Type of object. Can be: Network Service

Response example (Success)

Copy

{
  "status": "Success",
  "messages": [],
  "data": {
    "id": 8054,
    "fields": [
      { "name": "Owner", "values": ["[email protected]"] },
      { "name": "Creator", "values": ["[email protected]"] },
      { "name": "Devices", "values": ["root", "SEC01_SEC02"] },
      { "name": "status", "values": ["implement"] }
    ],
    "subChangeRequests": [8055, 8056],
    "originalRequestedActions": [
      {
        "objectName": "Test26Oct01",
        "requestedAction": "CREATE",
        "values": ["tcp/114"],
        "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
}