Get details for a specified change request
Returns full details about a specified change request, including custom fields configured for the template.
Perform the API again on each child request to get more details about those children.
For examples, see Sample response - parent change request and Example response - child change requests.
Resource Name: /api/v1/getticket
Request Method: GET
Header requirements:
| Key | Value |
|---|---|
| Cookie | FireFlow_Session=[sessionID]. The sessionId is retrieved from the authentication request. |
Request URL Parameters:
|
Element |
Type |
Description |
|---|---|---|
|
id |
Integer |
The ID of the change request you want to return data for. |
Response:
|
Code |
Description |
|---|---|
| 200 |
Operation completed successfully |
| 500 | Failed to complete operation. The response includes an error message indicating the failure. |
Sample request
https://12.34.5.67/FireFlow/api/change-requests/traffic/4595
Sample response - parent change request
In the following example, the subChangeRequests value shows that this change request has three child requests, with the IDs of 24, 25, and 26.
{
"status": "Success",
"messages": [
{
"code": "success",
"message": "Success"
}
],
"data": {
"id": 20,
"subChangeRequests": [
24,
25,
26
],
"fields": [
{
"name": "Risk Level",
"values": [
"No Risk"
]
},
{
"name": "Owner",
"values": [
"admin<[email protected]>"
]
},
{
"name": "Creator",
"values": [
"admin<[email protected]>"
]
},
{
"name": "Ticket Template Name",
"values": [
"Basic Change Traffic Request"
]
},
{
"name": "LastUpdated",
"values": [
"2020-02-07 13:14:19"
]
},
{
"name": "Requestor",
"values": [
"admin<[email protected]>"
]
},
{
"name": "Form Type",
"values": [
"Traffic Change"
]
},
{
"name": "Risks Number",
"values": [
"0"
]
},
{
"name": "Initial Plan status",
"values": [
"Result OK"
]
},
{
"name": "Workflow",
"values": [
"Basic"
]
},
{
"name": "status",
"values": [
"implement"
]
}
],
"originalTraffic": [
{
"source": {
"items": [
{
"value": "99.99.99.55",
"fields": []
}
]
},
"destination": {
"items": [
{
"value": "10.50.152.55",
"fields": []
}
]
},
"service": {
"items": [
{
"value": "tcp/22",
"fields": []
}
]
},
"application": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"user": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"fields": [],
"natDetails": null,
"action": "Drop"
},
{
"source": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"destination": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"service": {
"items": [
{
"value": "tcp/22",
"fields": []
}
]
},
"application": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"user": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"fields": [],
"natDetails": null,
"action": "Allow"
}
],
"plannedTraffic": [
{
"source": {
"items": [
{
"value": "99.99.99.55",
"fields": []
}
]
},
"destination": {
"items": [
{
"value": "10.50.152.55",
"fields": []
},
{
"value": "10.50.152.56",
"fields": []
}
]
},
"service": {
"items": [
{
"value": "tcp/22",
"fields": []
}
]
},
"application": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"user": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"fields": [],
"natDetails": null,
"action": "Drop"
},
{
"source": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"destination": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"service": {
"items": [
{
"value": "tcp/22",
"fields": []
}
]
},
"application": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"user": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"fields": [],
"natDetails": null,
"action": "Allow"
}
]
}
}
Example response - child change requests
In the following example, the subChangeRequests value is null because this is a child request with no further children.
{
"status": "Success",
"messages": [
{
"code": "success",
"message": "Success"
}
],
"data": {
"id": 24,
"subChangeRequests": null,
"fields": [
{
"name": "Owner",
"values": [
"admin<[email protected]>"
]
},
{
"name": "Creator",
"values": [
"admin<[email protected]>"
]
},
{
"name": "Devices",
"values": [
"10_20_150_3_puma_algosec_com_root_default"
]
},
{
"name": "Ticket Template Name",
"values": [
"Basic Change Traffic Request"
]
},
{
"name": "LastUpdated",
"values": [
"2020-02-07 14:00:13"
]
},
{
"name": "Workflow",
"values": [
"Basic"
]
},
{
"name": "status",
"values": [
"implement"
]
},
{
"name": "Requestor",
"values": [
"admin<[email protected]>"
]
},
{
"name": "Form Type",
"values": [
"Traffic Change"
]
}
],
"plannedTraffic": [
{
"source": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"destination": {
"items": [
{
"value": "any",
"fields": []
}
]
},
"service": {
"items": [
{
"value": "tcp/22",
"fields": []
}
]
},
"application": {
"items": [
{
"value": "Any",
"fields": []
}
]
},
"user": {
"items": [
{
"value": "Any",
"fields": []
}
]
},
"fields": [],
"natDetails": null,
"action": "Allow"
}
]
}
}
Yes 
No 
