Create a device object change request

Mandatory basic change request fields:

template

Additional, optional basic change request fields, such as:

description

due

expire

externalId

owner

priority

refersTo

referredBy

requestor

subject

String

The change request's value for the field.

For example, the externalID in this API is the same as the CMS ticket id in the traffic ticket API, and referredBy in this API is the same as ReferredBy in traffic ticket APIs.

customFields

Optional

A customFields object

See customFields type.

requestedActions:
devices

Mandatory

List of strings

The list of devices for which the object change request will be created.

This element is mandatory only if you do not use the objectContainers element.

Retrieve device database names using the following API:

https://<server_IP>/fa/server/rules/read?session=<FA_session_Id>&entity=<AFA_UI_display_name>

Any error messages that include the device name include the name displayed in AFA.

requestedActions:
action

String

One of the following:

• create
• delete
• addObjectsToGroup
• removeObjectsFromGroup
• replaceContent

requestedActions:
isGroup

String

Whether the object is able to hold multiple values within it. Non-group objects may not be transformed into group objects, and group objects may not become non-group objects(though they may contain only 1 value).

One of the following::

• True
• False

Example of a non-group object: host_1.1.1.1

Example of group object: ntp_servers

The type of object.

One of the following:

• network
• service

requestedActions:
values

Array of String

List of values being added, removed, or placed.

Example for Service Object: ["tcp/23","udp/53"]

Example for Network Object: ["object2"]

String

The device/management level on which to change the object.

One of the following:

• highest. To change the object at the highest level/management.

  Note: For Check Point devices, choosing highest will change the object on the CMA, not the PV1.

• lowest. To change the object on the lowest level/individual device.

• automatic. (Default) The level on which to change the object is determined based on an algorithm.

String

One of the following:

• Success
• Failure

Object containing the code and the message.

Strings that indicate success or failure.

In case of failure, contains a list of strings that detail why the change request was not created.

A changeRequestId object or a list of strings

One of the following:

• In case of success, the change request ID and a redirect URL
• In case of failure, null.

Operation completed successfully

400

Input validation failure

Error messages:

Http status code 400:

Message Code	Message text	Parameters
INVALID_DEVICES	Failed to create the request. Please specify 'devices'.	N/A
NO_CONTENT	'values' field is empty ({0} line(s) {1})	0-Request line type 1 - Line index(an integer)
NO_NAME	'name' field is empty ({0} line(s) {1})	0-Request line type 1 - Line index(an integer)
INVALID_TYPE	'type' field is invalid ({0} line(s) {1})	0-Request line type 1 - Line index(an integer)
INVALID_RULE_REMOVAL_ACTION	Rule Removal action should be one of [disable, remove, automatic]	N/A
INVALID_OBJECT_CHANGE_ACTION	action' field is invalid	N/A
INVALID_VALUE_FOR_FIELD	{0} field contains invalid value(s): {1}	0 - field name, 1 - value
INVALID_VALUE_FOR_FIELD_IN_LINE	{0} field contains invalid value(s): {1} ({2} line {3})	0 - field name, 1 - line index, 2 - type, 3 - value
PATTERN_NOT_MATCH	{0}: Input must match {1}	0 - input value 1 - pattern
INVALID_PATTERN	Invalid Pattern	N/A
INVALID_TEMPLATE_NAME	Invalid Template Name: {0}	0 - template name
INVALID_OBJECT_VALUE	Multiple values are not allowed when isGroup is false ({0} line {1})	0 - field name 1 - line index
INVALID_DOMAIN	New change requests cannot be created under the 'Management' domain. Please authenticate to a specific domain.
USER_NOT_FOUND	User: {0} in field: {1} was not found	0 - user 1 - field name
OBJECT_GROUP_NOT_FOUND	On action: {0} the object group: {1} doesn''t exist on devices: ''{2}''	0 - action 1 - object group 2 - device
OBJECT_TO_REMOVE_FROM_GROUP_NOT_FOUND	The network objects: {0} that was requested to be removed from group: {1} doesn't exist on all of the requested devices: '{2}' ('{3}')'	0 - missing content from group 1 - group name 2 - devices tree names 3 - devices display names
DEVICES_NOT_FOUND	Cannot find devices: {0}	0 - not found devices
DEVICES_NOT_SUPPORTED	Those devices are not supported: {0} for {1}	0 - unsupported device 1 - "Object Change"
DEVICES_NOT_SUPPORTED_BY_AFF	{0} device(s) not supported by FireFlow	0 - unsupported device
INVALID_FORM_TYPE	Invalid template form type, form type should be: {0}	0 - RequestType ("Traffic Change"/"Rule Removal"...)
NO_TEMPLATE_PERMISSION	Access Denied. There are no permissions to use template: {0}.	0 - template name
OBJECT_CONTAINERS_NOT_FOUND_FOR_SOME_DEVICES	Cannot find object container for devices: {0}	0 - devices names
CANNOT_ADD_OBJECT_TO_GROUP	The object: {0} that was requested to be added to group: {1} cannot be added because group hierarchy is higher than the requested object	0 - object name, 1 - group 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
NO_VALID_OBJECT_CONTAINERS_FOUND	No valid object containers found for request	N/A
INVALID_OBJECT_CONTAINER_LEVEL	Invalid objectContainerLevel valid values are {0}	0 - Lowest,
GROUP_MEMBERS_NOT_IN_SAME_ZONE	The requested objects {0} do not exist in the same zone as the requested group {1} ({2} line {3})	0- Objects name , 1-Group name, 2-RequestLineType (OBJECT("requested action")), 3- line index
OBJECT_EXIST_IN_FEW_ZONES	The requested objects {0}, exist in more than one zone. ({1} line {2})	0- Objectsname , 1-object values, 2- line index
CREATE_GROUP_MEMBERS_NOT_IN_SAME_ZONE	The requested objects {0} to add to group {1} do not exist in the same zone ({2} line {3})	0- Objects name , 1- Group name, 2- RequestLineType, 3- line index
CREATE_ZONE_BASED_DEVICE_NOT_SUPPORT_GLOBAL_OBJECTS	Device {0} does not support global objects ({1} line {2})	0- device name, 1- objects name, 2-request line index
FLOW_NOT_SUPPORTED_FOR_BRAND	{0} flow is not supported for {1}	0- Flow (for example : Multi object change-request…...) 1- device/brand
DUPLICATED_VALUE	Same {0} value(s) repeated multiple times ({1})	0- param name that duplicated in the request (for now : ruleId/devices) 1- The value
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}byte)	0 – field name , 1 – file name
TEMPLATE_IS_DISABLED	{0} template is disabled	0 – Template display name
TEMPLATE_CANNOT_BE_USED_WITH_SELECTED_DEVICE	{0} template cannot be used with device {1}	0 – Template display name , 1 - device
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
DUPLICATED_ACTIONS_FOR_OBJECT	Same action(s) repeated multiple times ({0}) for Object {1}	0 – action type, 1 – object name
MIXED_ACTIONS_FOR_OBJECT_NOT_ALLOWED	Mixed actions {0} for Object [{1}] cannot be performed per request	0 – action (set) , 1 - object 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
UNSUPPORTED_SPECIAL_SERVICES	The following special service objects are with numeric values and not supported: {0}	0 - numeric services names
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

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

Failed to complete operation.

Error messages:

Message Code	Message text	Parameters
UNEXPECTED_ERROR_OCCURRED	Unexpected error occurred	N/A