Update a traffic change request's custom fields
The FireFlow REST API updates a Traffic Change Request's Custom Fields.
FireFlow validates the API to ensure that mandatory elements are in place, such as permissions, template, date formats, that any specified device exists in AFA, and so on.
Resource Name: FireFlow/api/change-requests/traffic/{changeRequestID}/fields
Request Method: PUT
Header requirements:
Key |
Value |
Cookie
|
FireFlow_Session=[sessionId]. The sessionId is retrieved from the authentication request. |
Request Path:
Element
|
Type
|
Description
|
changeRequestID
Mandatory
|
Integer |
ID of the Change Request. |
Request Body:
A list of key:value fields where the key is the field name and the value is an array of update values.
For details, see Fields type.
Response: Response type
Code
|
Description
|
200 |
Operation completed successfully
|
400
|
Input validation failure
Error messages
Http status code 400:
Message Code |
Message text |
Parameters |
INVALID_DATE_PATTERN |
Invalid
date format in field: {0} |
0 -
field name |
NO_TEMPLATE_PERMISSION |
Access Denied. There are no permissions to use
template: {0}. |
0 - template name |
INVALID_CF_CONTENT |
{0}: Field supposed
to contain a single value |
0 - custom field name |
INSUFFICIENT_FIELD_PERMISSIONS |
User have insufficient permissions on field {0} |
0 - custom field name |
INVALID_USER_REQUIRED_PERMISSIONS |
elected user: {0} in
fields {1} doesn't have the permissions to perform this action |
0 - user name, 1 -
field name |
INVALID_USER_REQUIRED_PERMISSIONS |
elected user: {0} in fields {1} doesn't have the
permissions to perform this action |
0 - user name, 1 - field name |
INVALID_FILENAME |
Invalid filename for
{0} field ({1}) |
0 – field name ,
1 – file name |
UNSUPPORTED_FILENAME_EXTENSION |
Unsupported filename extension for {0} field
({1}) |
0 – field name , 1 – file name |
INVALID_BASE64_CONTENT |
Invalid content for
{0} field ({1}); attachments must be base64 encoded string(s) |
0 – field name ,
1 – file name |
EXCEEDED_MAX_FILE_SIZE |
File {0} exceeded maximum size quota ({1} bytes) |
0 – field name , 1 – file name |
UPDATE_FIELD_NOT_SUPPORTED |
Updating field {0} is
not supported |
0 – field
name |
FIREFLOW_FIELD_IS_DISABLED |
{0} field is disabled |
0 – fireflow field full name |
HIDDEN_FIELD |
{0} field cannot be
used while it is configured as hidden (HideFieldsFromTicket) |
0 – field
name |
FIELD_NOT_IN_TEMPLATE |
Change request template does not include the {0}
field |
0 – field name |
INVALID_EMAIL_ADDRESS |
Invalid email format
in field ({0}) |
0 - any user fields
like requestor, owner and cc |
INVALID_REQUEST_TYPE |
Change request {0} does not match request type {1} |
4 - CR id, 1 - request type |
CHANGE_REQUEST_NOT_FOUND |
Change request {0}
not found |
0 - CR id |
FIELD_NOT_FOUND |
{0} field was not found |
0- custom field |
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 example
[
{
"key": "string",
"values": [
"string"
]
}
]