Get permitted request templates

The templates method gets a list of permitted change request templates.

Resource Name: /FireFlow/api/templates

Request Method: GET

Request Parameters: None

Response:

Element Type Description
data Array of Objects
  • description: String
  • enabled: Boolean
  • id: Integer
  • name: String
  • type: String - One of the AFF Change Request template types.
messages Array of MessageDetails type
  • code: String
  • message: String
status String

One of the following:

  • Success
  • Failure

Response:

Code

Description
200

Operation completed successfully

400

Input validation failure

Message Code Message text Parameters
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

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.

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

Response example 

{
 "status": "Success",
 "messages": [
 {
  "code": "success",
  "message": "Success"
 }
],
"data": [
 {
  "id": 142,
  "name": "110: Multi-Approval Request",
  "description": "Create a traffic change request which requires multiple approvals",
  "type": "Traffic Change",
  "enabled": true
  },
  {
   "id": 598,
   "name": "115: Automatic Traffic Change Request",
   "description": "Create a traffic change request that progresses automatically",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 141,
   "name": "120: Generic request",
   "description": "Create a generic change request",
   "type": "Generic Change",
   "enabled": true
  },
  {
   "id": 219,
   "name": "130: Object Change Request",
   "description": "Create an object change request
   (add/remove/edit network and service objects)",
   "type": "Object Change",
   "enabled": true
  },
  {
   "id": 599,
   "name": "135: Object Change Multi Device Request",
   "description": "Create an object change request on multiple devices
   (add/remove/edit network and service objects)",
   "type": "Object Change Multi Device",
   "enabled": true
  },
  {
   "id": 307,
   "name": "140: Rule Removal Request",
   "description": "Create a change request for removing a device rule",
   "type": "Rule Removal",
   "enabled": true
  },
  {
   "id": 556,
   "name": "145: Rule Modification Request",
   "description": "Create change request for editing a device rule",
   "type": "Rule Modification",
   "enabled": true
  },
  {
   "id": 356,
   "name": "150: Parallel-Approval Request",
   "description": "Create a traffic change request which requires parallel approvals",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 431,
   "name": "160: Web Filter-Change Request (Blue Coat)",
   "description": "Create a web-filter change request",
   "type": "Web Filter Change",
   "enabled": true
  },
  {
   "id": 566,
   "name": "170: Traffic Change Request (IPv6)",
   "description": "Create a request for IPv6 traffic change in Cisco devices",
   "type": "Traffic Change IPv6",
   "enabled": true
  },
  {
   "id": 596,
   "name": "180: Traffic Change Request (Multicast)",
   "description": "Create a request for Multicast traffic change in Cisco devices",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 597,
   "name": "190: Verbatim Rule Addition",
   "description": "Create a traffic change request for bulk rules addition exactly as specified",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 601,
   "name": "BBB",
   "description": "",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 607,
   "name": "Duplicate Test",
   "description": "Create a basic change traffic request",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 550,
   "name": "Duplicate2",
   "description": "Create a basic change traffic request",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 608,
   "name": "Duplicate3",
   "description": "Create a basic change traffic request",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 609,
   "name": "Duplicate4",
   "description": "Create a basic change traffic request",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 603,
   "name": "No Workflow",
   "description": "",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 604,
   "name": "Test upgrade",
   "description": "Create a basic change traffic request",
   "type": "Traffic Change",
   "enabled": true
  },
  {
   "id": 600,
   "name": "aaa",
   "description": "",
   "type": "Traffic Change",
   "enabled": true
  }
 ]
}