Trigger ActiveChange for change request
Trigger ActiveChange for a change request sub-ticket for Traffic Workflow.
Resource Name: /change-requests/traffic/{changeRequestId}/work-order/implement
Request Method: POST
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 new Change Request created. Should be the sub-ticket number (not the number of the parent ticket).
|
Response parameters
Element
|
Type
|
Description
|
status
|
String |
Status of the API request. One of these:
|
messages
|
List of message object type |
Populated when status is failure. |
code
|
string |
Headline of error. |
message
|
string |
Details of error. |
data
|
string |
Populated when status is success. One of the following:
- Trigger ActiveChange for change request {changeRequestId} has finished successfully.
- ActiveChange operation has finished with status failure.
|
Response:
Status codes:
Code
|
Description
|
200 |
ActiveChange was triggered
|
400
|
Input validation failure
Error messages:
Message Code |
Message text |
Parameters |
INVALID_REQUEST_TYPE |
Change request {0} does not
match request type {1} |
0 - CR id, 1 - request type |
CHANGE_REQUEST_NOT_FOUND |
Change request {0}
not found |
0 - CR id |
CHANGE_REQUEST_NOT_FOUND |
Change request {0} not found |
0 - CR id |
NOT_SUB_TICKET |
Change request {0} is
not a sub request |
0 - sub CR id |
INVALID_CHANGE_REQUEST_STATUS |
Change request {0} is not in the expected stage for
calculating {1} |
0 - CR id, 1 - CR stage |
OPERATION_FAILED |
{0} operation has
finished with status failure |
0 -operation name |
CHANGES_APPLIED_TO_TENANTS_FROM_TEMPLATE |
Changes are
applied to MSO: {0} and deployed on the tenants defined in the template: {1} |
{0} mso managing device, 1 - template name |
NO_ACTION_REQUIRED |
No action required
for implementing change request {0} |
0 -change request id |
ACTIVE_CHANGE_NOT_SUPPORTED_FOR_NOT_CONFIGURED_TENANT |
To implement changes on the device {0} set tenant
schema and templates in the CiscoMsoActiveChangePolicyTargets parameter in
FireFlow Configuration |
0 - mso tenant name |
ACTIVE_CHANGE_DISABLED_FOR_DEVICE |
Active change is
disabled for device {0} |
0 - device name |
OPERATION_IS_NOT_SUPPORTED |
{0} is not supported for change request with {1} |
0 - operation name |
FLOW_NOT_SUPPORTED_FOR_BRAND |
{0} flow is not supported for {1} |
0- Flow (for example : Multi object change-request…...) |
BAD_JSON_FORMAT |
Bad JSON format: {0} |
0 - "failed to parse
request body" |
BAD_MEDIA_TYPE |
Content-Type header is missing or has
unsuitable 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 |
|
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.
Error messages:
Message Code |
Message text |
Parameters |
UNEXPECTED_ERROR_OCCURRED |
Unexpected error occurred |
N/A |
|
Request cURL examples
curl -k -X POST "https://<machine_IP>/FireFlow/api/change-requests/traffic/<ChangeRequestID>/active-change/calculate" -H "Cookie:RT_SID_FireFlow.443=<Cookie_value>"
Response example for 200
{
"status": "Success",
"messages": [],
"data": "Trigger ActiveChange for change request 647 has finished successfully"
}
Response example for 400
{
"status": "Failure",
"messages": [
{
"code": "CHANGE_REQUEST_NOT_FOUND",
"message": "Change request 6354 not found"
}
],
"data": null
}