{ "info": { "_postman_id": "8c39752c-5a91-412a-8aa3-ffbe871b0b8a", "name": "Tufin Tufin SecureChange/SecureApp R19-3-GA", "description": "Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Access Portal", "item": [ { "name": "Retrieve an existing application access request by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_access_requests", "{{requestId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID" }, "response": [] }, { "name": "Update an application access request", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tAPPROVE\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_access_requests", "{{requestId}}" ] }, "description": "Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Retrieve existing application access requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_access_requests" ] }, "description": "Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Update application access requests", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_access_requests" ] }, "description": "Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Create application access request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_access_requests" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] } ] }, { "name": "Application Connections", "item": [ { "name": "Retrieve existing connections, with extended resources information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections_extended" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME." }, "response": [] }, { "name": "Create a ticket to repair a connection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "connections", "{{connection_id}}", "repair" ] }, "description": "Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
401: Logged in user: NAME do not have permission to perform on behalf actions.
401: You are not a participant in the first step of this workflow.
401: Access is denied.
401: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID." }, "response": [] }, { "name": "Retrieve existing connections", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME." }, "response": [] }, { "name": "Create connections", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Update connections", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID." }, "response": [] }, { "name": "Retrieve an existing connection by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections", "{{connectionId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID." }, "response": [] }, { "name": "Update a connection", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": " \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n " }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections", "{{connectionId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID." }, "response": [] }, { "name": "Delete connection", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" }, { "key": "connectionId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections", "{{connectionId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID." }, "response": [] } ] }, { "name": "Application Identities", "item": [ { "name": "Fetches application identities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "application_identities" ] }, "description": "Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
401: Access is denied." }, "response": [] } ] }, { "name": "Application Interfaces", "item": [ { "name": "Retrieve existing interface connections", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}", "interface_connections" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID." }, "response": [] }, { "name": "Create interface connections", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}", "interface_connections" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID." }, "response": [] }, { "name": "Retrieve an existing interface connection by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}", "interface_connections", "{{connectionInterfaceId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID." }, "response": [] }, { "name": "Delete interface connection", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" }, { "key": "applicationInterfaceId", "value": null, "type": "text" }, { "key": "connectionInterfaceId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}", "interface_connections", "{{connectionInterfaceId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID." }, "response": [] }, { "name": "Update an interface connection", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}", "interface_connections", "{{connectionInterfaceId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID." }, "response": [] }, { "name": "Update a connection to application", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections_to_applications", "{{connectionToApplicationId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID." }, "response": [] }, { "name": "Retrieve an existing connection to application by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections_to_applications", "{{connectionToApplicationId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID." }, "response": [] }, { "name": "Delete connection to application", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" }, { "key": "connectionToApplicationId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections_to_applications", "{{connectionToApplicationId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID." }, "response": [] }, { "name": "Create application interface", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tInterface to Application 1\n\tNew application interface\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID." }, "response": [] }, { "name": "Retrieve existing application interfaces", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces" ] }, "description": "To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME." }, "response": [] }, { "name": "Delete application interface", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" }, { "key": "applicationInterfaceId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID." }, "response": [] }, { "name": "Update an application interface", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tupdated name\n\tUpdated application interface\n\ttrue\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}" ] }, "description": "Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID." }, "response": [] }, { "name": "Retrieve an existing application interface by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "application_interfaces", "{{applicationInterfaceId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID." }, "response": [] }, { "name": "Retrieve existing connections to application", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections_to_applications" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID." }, "response": [] }, { "name": "Create connection to application", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "connections_to_applications" ] }, "description": "Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found." }, "response": [] } ] }, { "name": "Application Migration", "item": [ { "name": "Update connection to application mappings for source and target applications", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "migrate", "{{sourceApplicationId}},{{targetApplicationId}}", "connections_to_applications_mapping" ] }, "description": "Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Retrieve connection to application mappings for source and target applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "migrate", "{{sourceApplicationId}},{{targetApplicationId}}", "connections_to_applications_mapping" ] }, "description": "Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Copy application servers and connections to another application.", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "sourceApplicationId", "value": null, "type": "text" }, { "key": "targetApplicationId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "migrate", "{{sourceApplicationId}},{{targetApplicationId}}" ] }, "description": "This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published." }, "response": [] }, { "name": "Update server mappings for source and target applications", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "migrate", "{{sourceApplicationId}},{{targetApplicationId}}", "servers_mapping" ] }, "description": "Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found." }, "response": [] }, { "name": "Retrieve server mappings for source and target applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "migrate", "{{sourceApplicationId}},{{targetApplicationId}}", "servers_mapping" ] }, "description": "Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
401: You do not have permissions to edit this application.
404: There is no application with the specified ID." }, "response": [] } ] }, { "name": "Application Packs", "item": [ { "name": "Update an application pack", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}" ] }, "description": "Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID." }, "response": [] }, { "name": "Delete application pack", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "customer_id", "value": null, "type": "text" }, { "key": "application_pack_id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
401: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs." }, "response": [] }, { "name": "Retrieve an existing application pack by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID." }, "response": [] }, { "name": "Update application interfaces and tag mapping", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "application_interfaces" ] }, "description": "Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.
401: You do not have permissions to edit this application pack.
401: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid." }, "response": [] }, { "name": "Remove application interfaces from application pack", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "customer_id", "value": null, "type": "text" }, { "key": "application_pack_id", "value": null, "type": "text" }, { "key": "application_interface_id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "application_interfaces" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID." }, "response": [] }, { "name": "List all application pack tags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "tags" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
401: Access is denied
404: There is no application pack with the ID." }, "response": [] }, { "name": "Modify tags of an application pack", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "tags" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
401: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID." }, "response": [] }, { "name": "Create new Tag under an application pack ", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "tags" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID." }, "response": [] }, { "name": "Delete tags from application pack", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "customer_id", "value": null, "type": "text" }, { "key": "application_pack_id", "value": null, "type": "text" }, { "key": "tag_id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "tags" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty." }, "response": [] }, { "name": "Delete a connection to application pack", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "application_id", "value": null, "type": "text" }, { "key": "connection_to_application_pack_id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "connection_to_application_packs", "{{connection_to_application_pack_id}}" ] }, "description": "Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
401: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." }, "response": [] }, { "name": "Retrieve an existing connection to application pack by ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "connection_to_application_packs", "{{connection_to_application_pack_id}}" ] }, "description": "Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID." }, "response": [] }, { "name": "Update an application pack", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "connection_to_application_packs", "{{connection_to_application_pack_id}}" ] }, "description": "Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed." }, "response": [] }, { "name": "Update application packs", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "" ] }, "description": "Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID." }, "response": [] }, { "name": "List all application packs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID." }, "response": [] }, { "name": "Create new application packs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
401: Access is denied
401: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned." }, "response": [] }, { "name": "Get tag by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "customers", "{{customer_id}}", "application_packs", "{{application_pack_id}}", "tags", "{{tag_id}}" ] }, "description": "Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
401: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID." }, "response": [] }, { "name": "Create new connection to application packs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "connection_to_application_packs", "" ] }, "description": "Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
401: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found." }, "response": [] }, { "name": "Retrieve a list of all connection to application pack by application ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "connection_to_application_packs", "" ] }, "description": "Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID." }, "response": [] } ] }, { "name": "Application Pending Changes", "item": [ { "name": "Retrieve existing access rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "access_requests" ] }, "description": "Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
400: Application with ID ID was not found." }, "response": [] } ] }, { "name": "Application Servers (across all applications)", "item": [ { "name": "Fetches servers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "network_objects" ] }, "description": "Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE " }, "response": [] }, { "name": "Fetches server by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "network_objects", "{{serverId}}" ] }, "description": "Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance." }, "response": [] } ] }, { "name": "Application Servers (by application)", "item": [ { "name": "Retrieve existing servers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE " }, "response": [] }, { "name": "Update servers", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack." }, "response": [] }, { "name": "Create servers", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack." }, "response": [] }, { "name": "Delete server", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" }, { "key": "serverId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects", "{{serverId}}" ] }, "description": "To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID." }, "response": [] }, { "name": "Retrieve an existing server by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects", "{{serverId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID." }, "response": [] }, { "name": "If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects", "{{serverId}}", "members" ] }, "description": "Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
401: Access is denied
401: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found" }, "response": [] }, { "name": "Move server", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "application_id", "value": null, "type": "text" }, { "key": "server_id", "value": null, "type": "text" }, { "key": "target_application_id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "move_server" ] }, "description": "Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Export Server Impact Analysis to a CSV file.", "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "network_objects", "{{serverId}}", "impact_analysis_csv" ] }, "description": "Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID." }, "response": [] } ] }, { "name": "Application Services (global)", "item": [ { "name": "Modify unused and non predefined global services", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "services", "" ] }, "description": "Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
401: Access is denied." }, "response": [] }, { "name": "Delete unused and non predefined global service by name", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "services" ] }, "description": "Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
401: Access is denied." }, "response": [] }, { "name": "Fetches services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "services" ] }, "description": "Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
401: Access is denied." }, "response": [] }, { "name": "Create global services", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "services" ] }, "description": "Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Invalid service type <span style=\"font-style: italic\">TYPE</span>
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
401: Access is denied." }, "response": [] }, { "name": "Fetches service by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "services", "{{serviceId}}" ] }, "description": "Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
401: Access is denied." }, "response": [] }, { "name": "Delete unused and non predefined global service", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "serviceId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "services", "{{serviceId}}" ] }, "description": "Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
401: Access is denied." }, "response": [] } ] }, { "name": "Application Services (local)", "item": [ { "name": "Retrieve existing services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "services" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME." }, "response": [] }, { "name": "Create services", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "services" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <span style=\"font-style: italic\">TYPE</span>
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Update services", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "services" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found." }, "response": [] }, { "name": "Delete service", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" }, { "key": "serviceId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "services", "{{serviceId}}" ] }, "description": "Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <span style=\"font-style: italic\">SERVICE_ID</span> was not found in application with id <span style=\"font-style: italic\">APPLICATION_ID</span>" }, "response": [] }, { "name": "Retrieve an existing service by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "services", "{{serviceId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found." }, "response": [] } ] }, { "name": "Application Users", "item": [ { "name": "Fetches users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "users" ] }, "description": "Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
401: Access is denied." }, "response": [] }, { "name": "Create users", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "users" ] }, "description": "Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <span style=\"font-style: italic\">ID</span> was not found.
400: Invalid user type <span style=\"font-style: italic\">TYPE</span>
400: Name cannot be empty.
400: User with name <span style=\"font-style: italic\">NAME</span> already exists.
400: Invalid ip
401: Access is denied." }, "response": [] }, { "name": "Fetches user by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "users", "{{userId}}" ] }, "description": "Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <span style=\"font-style: italic\">ID</span> was not found.
401: Access is denied." }, "response": [] }, { "name": "Delete unused user", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "userId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "users", "{{userId}}" ] }, "description": "Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Cannot delete an object that is being referenced by other objects.
401: Access is denied." }, "response": [] } ] }, { "name": "Applications", "item": [ { "name": "Retrieve security policy violations from SecureTrack", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "compliance_violations" ] }, "description": "Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check." }, "response": [] }, { "name": "List all applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "" ] }, "description": "Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission [note: documentation needs to explain that this list does NOT include apps listed in app_editor] [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
401: Access is denied
401: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found." }, "response": [] }, { "name": "Create new applications", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "" ] }, "description": "Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME." }, "response": [] }, { "name": "Update applications", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "" ] }, "description": "This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Delete an application", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "applicationId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application." }, "response": [] }, { "name": "Retrieve an existing application by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}" ] }, "description": "Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID." }, "response": [] }, { "name": "Change an application", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}" ] }, "description": "This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Export application history to PDF", "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "history", "export_pdf" ] }, "description": "Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
401: Access is denied.
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date" }, "response": [] }, { "name": "Move applications to another customer", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "move_applications" ] }, "description": "Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Retrieve application history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{applicationId}}", "history" ] }, "description": "Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID." }, "response": [] }, { "name": "Export Impact Analysis to a CSV file.", "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "repository", "applications", "{{application_id}}", "impact_analysis_csv" ] }, "description": "To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID." }, "response": [] } ] }, { "name": "Cloud Console", "item": [ { "name": "Auto associate cloud servers from SecureTrack with an application", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tApplication\n\ttrue\n\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "cloud_console", "servers", "auto_association_rule" ] }, "description": "When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers." }, "response": [] }, { "name": "Retrieve cloud server listing from SecureTrack", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "cloud_console", "servers", "" ] }, "description": "Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned." }, "response": [] }, { "name": "Associate cloud servers from SecureTrack with an application", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "cloud_console", "servers", "" ] }, "description": "Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
401: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times." }, "response": [] } ] }, { "name": "Customers", "item": [ { "name": "import customers", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "import" ] }, "description": "Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
401: Access is denied
503: Not connected to SecureTrack." }, "response": [] }, { "name": "List all customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "" ] }, "description": "Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME." }, "response": [] }, { "name": "Retrieve existing applications for specific domain", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "{{customer_id}}", "applications" ] }, "description": "Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
401: Access is denied" }, "response": [] }, { "name": "List all imported customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "imported" ] }, "description": "

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode." }, "response": [] }, { "name": "Fetches customer by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "{{customer_id}}" ] }, "description": "Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found." }, "response": [] }, { "name": "Update a customer", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tNOT_IMPORTED\n" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "{{customer_id}}" ] }, "description": "Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
401: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it." }, "response": [] }, { "name": "List all non-imported customers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "customers", "not_imported" ] }, "description": "

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
503: Not connected to SecureTrack." }, "response": [] } ] }, { "name": "Domains", "item": [ { "name": "synchronize domains", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "domains", "synchronize" ] }, "description": "Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains" }, "response": [] }, { "name": "List all domains", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "domains", "" ] }, "description": "Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME." }, "response": [] }, { "name": "Fetches domain by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "domains", "{{domainId}}" ] }, "description": "Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found." }, "response": [] } ] }, { "name": "Load Balancers", "item": [ { "name": "Fetches virtual servers from SecureTrack", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers", "protocol": "https", "host": [ "{{SecureApp_IP}}" ], "path": [ "securechangeworkflow", "api", "secureapp", "external_resources", "f5_virtual_servers" ] }, "description": "Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
401: Access is denied
503: Not connected to SecureTrack." }, "response": [] } ] }, { "name": "SecureChange Devices", "item": [ { "name": "Returns the details of the devices that you can select as a target in SecureChange", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "devices", "" ] }, "description": "Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found" }, "response": [] }, { "name": "Get suggested targets for a given access request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "devices", "suggest_target" ] }, "description": "Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
401: Access is denied" }, "response": [] }, { "name": "Update the whole list of excluded devices in SecureChange", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t1\n\t12\n\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "devices", "excluded" ] }, "description": "Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

" }, "response": [] }, { "name": "Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "devices", "excluded" ] }, "description": "For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

" }, "response": [] } ] }, { "name": "Server Decommissioning", "item": [ { "name": "Run server decommission designer for given task", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": null, "type": "text" }, { "key": "taskId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "current", "tasks", "{{taskId}}", "multi_server_decommission_request", "designer" ] }, "description": "Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance." }, "response": [] }, { "name": "Run Impact Analysis for given task", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": null, "type": "text" }, { "key": "taskId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "current", "tasks", "{{taskId}}", "multi_server_decommission_request", "impact_analysis" ] }, "description": "Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance." }, "response": [] }, { "name": "Get impact analysis results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "multi_server_decommission_request", "{{fieldId}}", "impact_analysis" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>." }, "response": [] }, { "name": "Run Verifier for given task", "request": { "method": "PUT", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": null, "type": "text" }, { "key": "taskId", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "current", "tasks", "{{taskId}}", "multi_server_decommission_request", "verifier" ] }, "description": "Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance." }, "response": [] }, { "name": "Get verifier results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "multi_server_decommission_request", "{{fieldId}}", "verifier" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>." }, "response": [] }, { "name": "Get server decommission designer results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "multi_server_decommission_request", "{{fieldId}}", "designer" ] }, "description": "Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>." }, "response": [] } ] }, { "name": "System Configuration", "item": [ { "name": "Modify the SecureTrack connection settings and test the connection status", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "integration_with_secureTrack", "" ] }, "description": "Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty." }, "response": [] }, { "name": "Retrieve the SecureTrack connection settings and status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "integration_with_secureTrack", "" ] }, "description": "

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
" }, "response": [] } ] }, { "name": "System Users", "item": [ { "name": "Import user from LDAP", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "users", "" ] }, "description": "Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
401: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found." }, "response": [] }, { "name": "Return the list of users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "users", "" ] }, "description": "user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
" }, "response": [] }, { "name": "Return the specified user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "users", "{{id}}" ] }, "description": "Parameters:
id: The user's ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found." }, "response": [] } ] }, { "name": "Ticket Lifecycle", "item": [ { "name": "Reject a ticket", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\trejected\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "reject" ] }, "description": "Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
401: User is not permitted to reject this ticket on behalf another user
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
401: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>." }, "response": [] }, { "name": "Map rules to ticket", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "map_rules" ] }, "description": "Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
401: Access is denied.
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status" }, "response": [] }, { "name": "Reassigns the specified ticket task to the specified user.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tPlease complete the AR\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "reassign", "{{assigneeId}}" ] }, "description": "Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query" }, "response": [] }, { "name": "Confirm the request", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tconfirmed\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "confirm" ] }, "description": "Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
401: Access is denied.
404: There is no ticket with ID ." }, "response": [] }, { "name": "Change the requester of the specified ticket task to the specified user.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tuser was deleted moving tickets to Bob\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "change_requester", "{{assigneeId}}" ] }, "description": "Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID." }, "response": [] }, { "name": "Returns the specified ticket to the specified step", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\tplease fix source \n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "redo", "{{toStepId}}" ] }, "description": "Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
401: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query" }, "response": [] }, { "name": "Returns the history of the specified ticket", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "history" ] }, "description": "Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
401: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID." }, "response": [] }, { "name": "Cancel a ticket", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": null, "type": "text" } ] }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "cancel" ] }, "description": "Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
401: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found" }, "response": [] } ] }, { "name": "Tickets", "item": [ { "name": "Returns the details of a the fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ." }, "response": [] }, { "name": "Change multiple fields within a task of a ticket", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"fields\": {\n\t\t\"field\": {\n\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\"id\": 71,\n\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\"read_only\": false,\n\t\t\t\"devices\": {\n\t\t\t\t\"device\": {\n\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"rule_modifications\": {\n\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t},\n\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\"id\": 20,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\"id\": 19,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"designer_result\": {\n\t\t\t\t\"status\": \"not run\"\n\t\t\t}\n\t\t}\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields" ] }, "description": "
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
    \"fields\": {
        \"field\": {
            \"@xsi.type\": \"rule_modification_field\",
            \"id\": 71,
            \"name\": \"Fire Wall Rule\",
            \"read_only\": false,
            \"devices\": {
                \"device\": {
                    \"revision_id\": 4,
                    \"management_name\": \"Panorama/DG_1\",
                    \"management_id\": 4,
                    \"management_ip\": \"10.100.111.120\",
                    \"revision_number\": 1,
                    \"number_of_rules\": 1,
                    \"bindings\": {
                        \"binding\": {
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"binding\": {
                                \"@xsi.type\": \"policy__binding\",
                                \"policy_name\": \"Standard\"
                            },
                            \"rules\": {
                                \"rule\": {
                                    \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                    \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                    \"name\": \"Application test\",
                                    \"is_disabled\": false,
                                    \"ruleNumber\": 13,
                                    \"from_zone\": \"any\",
                                    \"to_zone\": \"any\",
                                    \"sourceNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                        \"name\": \"H_5.3.2.5\",
                                        \"display_name\": \"H_5.3.2.5\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"comment\",
                                        \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"5.3.2.5\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                        \"name\": \"22.22.2.2\",
                                        \"display_name\": \"22.22.2.2\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"id\": \"5df1f2a5e9023c311ae4a016\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"22.22.2.2\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationServices\": {
                                        \"@xsi.type\": \"transport_service\",
                                        \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                        \"name\": \"TCP82\",
                                        \"display_name\": \"TCP82\",
                                        \"class_name\": \"tcp_service\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"TCP82\",
                                        \"id\": \"5df1f2a5e9023c311ae4a018\",
                                        \"version_id\": 4,
                                        \"referenced\": \"UNKNOWN\",
                                        \"type_on_device\": \"\",
                                        \"negate\": false,
                                        \"match_for_any\": false,
                                        \"timeout\": 0,
                                        \"protocol\": 6,
                                        \"min_port\": 82,
                                        \"max_port\": 82
                                    },
                                    \"applications\": {
                                        \"@xsi.type\": \"single_application\",
                                        \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                        \"name\": \"web-browsing\",
                                        \"display_name\": \"web-browsing\",
                                        \"class_name\": \"application_object\",
                                        \"origin\": \"DEVICE_PREDEFINED\",
                                        \"global\": true,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"service\": [
                                            {
                                                \"@xsi.type\": \"transport_service\",
                                                \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                \"name\": \"st_implicit_app_web-browsing\",
                                                \"display_name\": \"st_implicit_app_web-browsing\",
                                                \"class_name\": \"tcp_service\",
                                                \"origin\": \"DEVICE\",
                                                \"global\": false,
                                                \"implicit\": true,
                                                \"shared\": false,
                                                \"comment\": \"\",
                                                \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                \"version_id\": 4,
                                                \"referenced\": \"UNKNOWN\",
                                                \"type_on_device\": \"\",
                                                \"negate\": false,
                                                \"match_for_any\": false,
                                                \"timeout\": 0,
                                                \"protocol\": 6,
                                                \"min_port\": 80,
                                                \"max_port\": 80
                                            }
                                        ]
                                    },
                                    \"action\": \"ACCEPT\",
                                    \"additional_parameters\": \"\",
                                    \"options\": {
                                        \"option\": \"LOG_SESSION\"
                                    },
                                    \"rule_location\": \"DG_1\",
                                    \"users\": {
                                        \"user\": [
                                            {
                                                \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                \"name\": \"Any\",
                                                \"class_name\": \"any_object\",
                                                \"displayName\": \"Any\"
                                            }
                                        ]
                                    },
                                    \"track\": {
                                        \"track_level\": \"LOG\"
                                    },
                                    \"install_ons\": \"\",
                                    \"communities\": \"\",
                                    \"times\": \"\",
                                    \"rule_metadata\": {
                                        \"permissiveness_level\": \"LOW\",
                                        \"violations\": \"\",
                                        \"last_hit\": \"No hits\",
                                        \"shadowed_status\": \"FALSE\",
                                        \"ticket_ids\": \"\",
                                        \"business_owners\": \"\",
                                        \"expirations\": \"\",
                                        \"applications\": \"\",
                                        \"last_modified\": \"Today\"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            \"rule_modifications\": {
                \"rule_modification\": {
                    \"@xsi.type\": \"modify_rule_modification\",
                    \"id\": 10,
                    \"rule_key\": {
                        \"device_id\": 4,
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                    },
                    \"source_modifications\": {
                        \"id\": 20,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 69,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 65,
                                        \"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 65,
                                                \"name\": \"My New Host\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 68,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 64,
                                        \"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 64,
                                                \"name\": \"My New Address Ragne\",
                                                \"comment\": \"some comment\",
                                                \"min_ip\": \"192.168.0.1\",
                                                \"max_ip\": \"192.168.0.254\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 70,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 68,
                                        \"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 68,
                                                \"name\": \"My New Network\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    \"destination_modifications\": {
                        \"id\": 19,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 66,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 67,
                                        \"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 67,
                                                \"name\": \"Range-Test\",
                                                \"comment\": \"\",
                                                \"min_ip\": \"1.1.2.0\",
                                                \"max_ip\": \"1.1.2.55\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 67,
                                    \"action\": \"REMOVE\",
                                    \"device_network_object\": {
                                        \"id\": 66,
                                        \"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 66,
                                                \"name\": \"22.22.2.2\",
                                                \"comment\": \"\",
                                                \"ip\": \"22.22.2.2\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 65,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 70,
                                        \"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",
                                        \"device_id\": 2,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 70,
                                                \"name\": \"Net_10.108.151.0\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.108.151.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 64,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 69,
                                        \"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 69,
                                                \"name\": \"Host_10.10.10.10\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.10.10.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            \"designer_result\": {
                \"status\": \"not run\"
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Get commands for device from designer results of a specific field id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields", "{{fieldId}}", "designer", "device", "{{deviceId}}", "commands" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature." }, "response": [] }, { "name": "Change the ticket properties", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "\n\t\n\t\t\n\t\n" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "ticket_properties" ] }, "description": "Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id>10</id>
    </notification_group>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
401: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>." }, "response": [] }, { "name": "Change a task of a ticket at the current step", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"task\": {\n\t\t\"id\": 4,\n\t\t\"assignee_id\": 4,\n\t\t\"assignee\": \"a\",\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 71,\n\t\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\t\"read_only\": false,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"id\": 13,\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"id\": 26,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"id\": 25,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"designer_result\": {\n\t\t\t\t\t\"status\": \"not run\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "current", "tasks", "{{taskId}}" ] }, "description": "
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/
BODY{
    \"task\": {
        \"id\": 4,
        \"assignee_id\": 4,
        \"assignee\": \"a\",
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 71,
                \"name\": \"Fire Wall Rule\",
                \"read_only\": false,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 4,
                        \"management_name\": \"Panorama/DG_1\",
                        \"management_id\": 4,
                        \"management_ip\": \"10.100.111.120\",
                        \"revision_number\": 1,
                        \"number_of_rules\": 1,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{00-FACED0-00}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"Standard\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                        \"name\": \"Application test\",
                                        \"is_disabled\": false,
                                        \"ruleNumber\": 13,
                                        \"from_zone\": \"any\",
                                        \"to_zone\": \"any\",
                                        \"sourceNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                            \"name\": \"H_5.3.2.5\",
                                            \"display_name\": \"H_5.3.2.5\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"comment\",
                                            \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"5.3.2.5\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                            \"name\": \"22.22.2.2\",
                                            \"display_name\": \"22.22.2.2\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a016\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"22.22.2.2\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationServices\": {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                            \"name\": \"TCP82\",
                                            \"display_name\": \"TCP82\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"TCP82\",
                                            \"id\": \"5df1f2a5e9023c311ae4a018\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 82,
                                            \"max_port\": 82
                                        },
                                        \"applications\": {
                                            \"@xsi.type\": \"single_application\",
                                            \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                            \"name\": \"web-browsing\",
                                            \"display_name\": \"web-browsing\",
                                            \"class_name\": \"application_object\",
                                            \"origin\": \"DEVICE_PREDEFINED\",
                                            \"global\": true,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"service\": [
                                                {
                                                    \"@xsi.type\": \"transport_service\",
                                                    \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                    \"name\": \"st_implicit_app_web-browsing\",
                                                    \"display_name\": \"st_implicit_app_web-browsing\",
                                                    \"class_name\": \"tcp_service\",
                                                    \"origin\": \"DEVICE\",
                                                    \"global\": false,
                                                    \"implicit\": true,
                                                    \"shared\": false,
                                                    \"comment\": \"\",
                                                    \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                    \"version_id\": 4,
                                                    \"referenced\": \"UNKNOWN\",
                                                    \"type_on_device\": \"\",
                                                    \"negate\": false,
                                                    \"match_for_any\": false,
                                                    \"timeout\": 0,
                                                    \"protocol\": 6,
                                                    \"min_port\": 80,
                                                    \"max_port\": 80
                                                }
                                            ]
                                        },
                                        \"action\": \"ACCEPT\",
                                        \"additional_parameters\": \"\",
                                        \"options\": {
                                            \"option\": \"LOG_SESSION\"
                                        },
                                        \"rule_location\": \"DG_1\",
                                        \"users\": {
                                            \"user\": [
                                                {
                                                    \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                    \"name\": \"Any\",
                                                    \"class_name\": \"any_object\",
                                                    \"displayName\": \"Any\"
                                                }
                                            ]
                                        },
                                        \"track\": {
                                            \"track_level\": \"LOG\"
                                        },
                                        \"install_ons\": \"\",
                                        \"communities\": \"\",
                                        \"times\": \"\",
                                        \"rule_metadata\": {
                                            \"permissiveness_level\": \"LOW\",
                                            \"violations\": \"\",
                                            \"last_hit\": \"No hits\",
                                            \"shadowed_status\": \"FALSE\",
                                            \"ticket_ids\": \"\",
                                            \"business_owners\": \"\",
                                            \"expirations\": \"\",
                                            \"applications\": \"\",
                                            \"last_modified\": \"Today\"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"id\": 13,
                        \"rule_key\": {
                            \"device_id\": 4,
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                        },
                        \"source_modifications\": {
                            \"id\": 26,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 89,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 88,
                                            \"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 88,
                                                    \"name\": \"My New Host\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 91,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 89,
                                            \"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 89,
                                                    \"name\": \"My New Address Ragne\",
                                                    \"comment\": \"some comment\",
                                                    \"min_ip\": \"192.168.0.1\",
                                                    \"max_ip\": \"192.168.0.254\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 90,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 87,
                                            \"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 87,
                                                    \"name\": \"My New Network\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"id\": 25,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 88,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 91,
                                            \"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 91,
                                                    \"name\": \"Host_10.10.10.10\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.10.10.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 85,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 90,
                                            \"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 90,
                                                    \"name\": \"Range-Test\",
                                                    \"comment\": \"\",
                                                    \"min_ip\": \"1.1.2.0\",
                                                    \"max_ip\": \"1.1.2.55\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 86,
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"id\": 86,
                                            \"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 86,
                                                    \"name\": \"22.22.2.2\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"22.22.2.2\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 87,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 85,
                                            \"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",
                                            \"device_id\": 2,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 85,
                                                    \"name\": \"Net_10.108.151.0\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.108.151.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                \"designer_result\": {
                    \"status\": \"not run\"
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Returns the details of a specified field", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields", "{{fieldId}}" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID ." }, "response": [] }, { "name": "Change a field within a task of a ticket", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"rule_modification_field\": {\n\t\t\"id\": 71,\n\t\t\"name\": \"Fire Wall Rule\",\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\"management_id\": 4,\n\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"id\": 12,\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"id\": 24,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"id\": 23,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"designer_result\": {\n\t\t\t\"status\": \"not run\"\n\t\t}\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields", "{{fieldId}}" ] }, "description": "
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"id\": 71,
        \"name\": \"Fire Wall Rule\",
        \"devices\": {
            \"device\": {
                \"revision_id\": 4,
                \"management_name\": \"Panorama/DG_1\",
                \"management_id\": 4,
                \"management_ip\": \"10.100.111.120\",
                \"revision_number\": 1,
                \"number_of_rules\": 1,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"Standard\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                \"name\": \"Application test\",
                                \"is_disabled\": false,
                                \"ruleNumber\": 13,
                                \"from_zone\": \"any\",
                                \"to_zone\": \"any\",
                                \"sourceNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                    \"name\": \"H_5.3.2.5\",
                                    \"display_name\": \"H_5.3.2.5\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"comment\",
                                    \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"5.3.2.5\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                    \"name\": \"22.22.2.2\",
                                    \"display_name\": \"22.22.2.2\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"id\": \"5df1f2a5e9023c311ae4a016\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"22.22.2.2\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationServices\": {
                                    \"@xsi.type\": \"transport_service\",
                                    \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                    \"name\": \"TCP82\",
                                    \"display_name\": \"TCP82\",
                                    \"class_name\": \"tcp_service\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"TCP82\",
                                    \"id\": \"5df1f2a5e9023c311ae4a018\",
                                    \"version_id\": 4,
                                    \"referenced\": \"UNKNOWN\",
                                    \"type_on_device\": \"\",
                                    \"negate\": false,
                                    \"match_for_any\": false,
                                    \"timeout\": 0,
                                    \"protocol\": 6,
                                    \"min_port\": 82,
                                    \"max_port\": 82
                                },
                                \"applications\": {
                                    \"@xsi.type\": \"single_application\",
                                    \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                    \"name\": \"web-browsing\",
                                    \"display_name\": \"web-browsing\",
                                    \"class_name\": \"application_object\",
                                    \"origin\": \"DEVICE_PREDEFINED\",
                                    \"global\": true,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"service\": [
                                        {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                            \"name\": \"st_implicit_app_web-browsing\",
                                            \"display_name\": \"st_implicit_app_web-browsing\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": true,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a014\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 80,
                                            \"max_port\": 80
                                        }
                                    ]
                                },
                                \"action\": \"ACCEPT\",
                                \"additional_parameters\": \"\",
                                \"options\": {
                                    \"option\": \"LOG_SESSION\"
                                },
                                \"rule_location\": \"DG_1\",
                                \"users\": {
                                    \"user\": [
                                        {
                                            \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                            \"name\": \"Any\",
                                            \"class_name\": \"any_object\",
                                            \"displayName\": \"Any\"
                                        }
                                    ]
                                },
                                \"track\": {
                                    \"track_level\": \"LOG\"
                                },
                                \"install_ons\": \"\",
                                \"communities\": \"\",
                                \"times\": \"\",
                                \"rule_metadata\": {
                                    \"permissiveness_level\": \"LOW\",
                                    \"violations\": \"\",
                                    \"last_hit\": \"No hits\",
                                    \"shadowed_status\": \"FALSE\",
                                    \"ticket_ids\": \"\",
                                    \"business_owners\": \"\",
                                    \"expirations\": \"\",
                                    \"applications\": \"\",
                                    \"last_modified\": \"Today\"
                                }
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"id\": 12,
                \"rule_key\": {
                    \"device_id\": 4,
                    \"binding_uid\": \"{00-FACED0-00}\",
                    \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                },
                \"source_modifications\": {
                    \"id\": 24,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 84,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 81,
                                    \"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 81,
                                            \"name\": \"My New Address Ragne\",
                                            \"comment\": \"some comment\",
                                            \"min_ip\": \"192.168.0.1\",
                                            \"max_ip\": \"192.168.0.254\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 83,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 80,
                                    \"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 80,
                                            \"name\": \"My New Network\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 82,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 79,
                                    \"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 79,
                                            \"name\": \"My New Host\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"id\": 23,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 80,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 82,
                                    \"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",
                                    \"device_id\": 2,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 82,
                                            \"name\": \"Net_10.108.151.0\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.108.151.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 81,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 78,
                                    \"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 78,
                                            \"name\": \"Host_10.10.10.10\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.10.10.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 79,
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"id\": 83,
                                    \"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 83,
                                            \"name\": \"22.22.2.2\",
                                            \"comment\": \"\",
                                            \"ip\": \"22.22.2.2\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 78,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 84,
                                    \"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 84,
                                            \"name\": \"Range-Test\",
                                            \"comment\": \"\",
                                            \"min_ip\": \"1.1.2.0\",
                                            \"max_ip\": \"1.1.2.55\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            }
        },
        \"designer_result\": {
            \"status\": \"not run\"
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Get rule decommision verifier results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "rule_decommission", "verifier" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request." }, "response": [] }, { "name": "Get designer results according to field id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields", "{{fieldId}}", "designer" ] }, "description": "Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request." }, "response": [] }, { "name": "Returns the results of the Commit action", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "fields", "{{fieldId}}", "designer", "commit_report", "{{managementId}}" ] }, "description": "GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request." }, "response": [] }, { "name": "Returns the details of a specified ticket stages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found" }, "response": [] }, { "name": "Change a field within a task of a ticket at the current step", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"rule_modification_field\": {\n\t\t\"id\": 71,\n\t\t\"name\": \"Fire Wall Rule\",\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\"management_id\": 4,\n\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"id\": 12,\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"id\": 24,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"id\": 23,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"designer_result\": {\n\t\t\t\"status\": \"not run\"\n\t\t}\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "current", "tasks", "{{taskId}}", "fields", "{{fieldId}}" ] }, "description": "
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"id\": 71,
        \"name\": \"Fire Wall Rule\",
        \"devices\": {
            \"device\": {
                \"revision_id\": 4,
                \"management_name\": \"Panorama/DG_1\",
                \"management_id\": 4,
                \"management_ip\": \"10.100.111.120\",
                \"revision_number\": 1,
                \"number_of_rules\": 1,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"Standard\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                \"name\": \"Application test\",
                                \"is_disabled\": false,
                                \"ruleNumber\": 13,
                                \"from_zone\": \"any\",
                                \"to_zone\": \"any\",
                                \"sourceNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                    \"name\": \"H_5.3.2.5\",
                                    \"display_name\": \"H_5.3.2.5\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"comment\",
                                    \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"5.3.2.5\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                    \"name\": \"22.22.2.2\",
                                    \"display_name\": \"22.22.2.2\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"id\": \"5df1f2a5e9023c311ae4a016\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"22.22.2.2\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationServices\": {
                                    \"@xsi.type\": \"transport_service\",
                                    \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                    \"name\": \"TCP82\",
                                    \"display_name\": \"TCP82\",
                                    \"class_name\": \"tcp_service\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"TCP82\",
                                    \"id\": \"5df1f2a5e9023c311ae4a018\",
                                    \"version_id\": 4,
                                    \"referenced\": \"UNKNOWN\",
                                    \"type_on_device\": \"\",
                                    \"negate\": false,
                                    \"match_for_any\": false,
                                    \"timeout\": 0,
                                    \"protocol\": 6,
                                    \"min_port\": 82,
                                    \"max_port\": 82
                                },
                                \"applications\": {
                                    \"@xsi.type\": \"single_application\",
                                    \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                    \"name\": \"web-browsing\",
                                    \"display_name\": \"web-browsing\",
                                    \"class_name\": \"application_object\",
                                    \"origin\": \"DEVICE_PREDEFINED\",
                                    \"global\": true,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"service\": [
                                        {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                            \"name\": \"st_implicit_app_web-browsing\",
                                            \"display_name\": \"st_implicit_app_web-browsing\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": true,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a014\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 80,
                                            \"max_port\": 80
                                        }
                                    ]
                                },
                                \"action\": \"ACCEPT\",
                                \"additional_parameters\": \"\",
                                \"options\": {
                                    \"option\": \"LOG_SESSION\"
                                },
                                \"rule_location\": \"DG_1\",
                                \"users\": {
                                    \"user\": [
                                        {
                                            \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                            \"name\": \"Any\",
                                            \"class_name\": \"any_object\",
                                            \"displayName\": \"Any\"
                                        }
                                    ]
                                },
                                \"track\": {
                                    \"track_level\": \"LOG\"
                                },
                                \"install_ons\": \"\",
                                \"communities\": \"\",
                                \"times\": \"\",
                                \"rule_metadata\": {
                                    \"permissiveness_level\": \"LOW\",
                                    \"violations\": \"\",
                                    \"last_hit\": \"No hits\",
                                    \"shadowed_status\": \"FALSE\",
                                    \"ticket_ids\": \"\",
                                    \"business_owners\": \"\",
                                    \"expirations\": \"\",
                                    \"applications\": \"\",
                                    \"last_modified\": \"Today\"
                                }
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"id\": 12,
                \"rule_key\": {
                    \"device_id\": 4,
                    \"binding_uid\": \"{00-FACED0-00}\",
                    \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                },
                \"source_modifications\": {
                    \"id\": 24,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 84,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 81,
                                    \"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 81,
                                            \"name\": \"My New Address Ragne\",
                                            \"comment\": \"some comment\",
                                            \"min_ip\": \"192.168.0.1\",
                                            \"max_ip\": \"192.168.0.254\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 83,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 80,
                                    \"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 80,
                                            \"name\": \"My New Network\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 82,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 79,
                                    \"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 79,
                                            \"name\": \"My New Host\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"id\": 23,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 80,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 82,
                                    \"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",
                                    \"device_id\": 2,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 82,
                                            \"name\": \"Net_10.108.151.0\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.108.151.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 81,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 78,
                                    \"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 78,
                                            \"name\": \"Host_10.10.10.10\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.10.10.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 79,
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"id\": 83,
                                    \"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 83,
                                            \"name\": \"22.22.2.2\",
                                            \"comment\": \"\",
                                            \"ip\": \"22.22.2.2\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 78,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 84,
                                    \"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 84,
                                            \"name\": \"Range-Test\",
                                            \"comment\": \"\",
                                            \"min_ip\": \"1.1.2.0\",
                                            \"max_ip\": \"1.1.2.55\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            }
        },
        \"designer_result\": {
            \"status\": \"not run\"
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Change multiple field within a task of a ticket in the current step", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"fields\": {\n\t\t\"field\": {\n\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\"id\": 71,\n\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\"read_only\": false,\n\t\t\t\"devices\": {\n\t\t\t\t\"device\": {\n\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"rule_modifications\": {\n\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t},\n\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\"id\": 20,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\"id\": 19,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"designer_result\": {\n\t\t\t\t\"status\": \"not run\"\n\t\t\t}\n\t\t}\n\t}\n}}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "current", "tasks", "{{taskId}}", "fields" ] }, "description": "
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
    \"fields\": {
        \"field\": {
            \"@xsi.type\": \"rule_modification_field\",
            \"id\": 71,
            \"name\": \"Fire Wall Rule\",
            \"read_only\": false,
            \"devices\": {
                \"device\": {
                    \"revision_id\": 4,
                    \"management_name\": \"Panorama/DG_1\",
                    \"management_id\": 4,
                    \"management_ip\": \"10.100.111.120\",
                    \"revision_number\": 1,
                    \"number_of_rules\": 1,
                    \"bindings\": {
                        \"binding\": {
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"binding\": {
                                \"@xsi.type\": \"policy__binding\",
                                \"policy_name\": \"Standard\"
                            },
                            \"rules\": {
                                \"rule\": {
                                    \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                    \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                    \"name\": \"Application test\",
                                    \"is_disabled\": false,
                                    \"ruleNumber\": 13,
                                    \"from_zone\": \"any\",
                                    \"to_zone\": \"any\",
                                    \"sourceNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                        \"name\": \"H_5.3.2.5\",
                                        \"display_name\": \"H_5.3.2.5\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"comment\",
                                        \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"5.3.2.5\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                        \"name\": \"22.22.2.2\",
                                        \"display_name\": \"22.22.2.2\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"id\": \"5df1f2a5e9023c311ae4a016\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"22.22.2.2\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationServices\": {
                                        \"@xsi.type\": \"transport_service\",
                                        \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                        \"name\": \"TCP82\",
                                        \"display_name\": \"TCP82\",
                                        \"class_name\": \"tcp_service\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"TCP82\",
                                        \"id\": \"5df1f2a5e9023c311ae4a018\",
                                        \"version_id\": 4,
                                        \"referenced\": \"UNKNOWN\",
                                        \"type_on_device\": \"\",
                                        \"negate\": false,
                                        \"match_for_any\": false,
                                        \"timeout\": 0,
                                        \"protocol\": 6,
                                        \"min_port\": 82,
                                        \"max_port\": 82
                                    },
                                    \"applications\": {
                                        \"@xsi.type\": \"single_application\",
                                        \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                        \"name\": \"web-browsing\",
                                        \"display_name\": \"web-browsing\",
                                        \"class_name\": \"application_object\",
                                        \"origin\": \"DEVICE_PREDEFINED\",
                                        \"global\": true,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"service\": [
                                            {
                                                \"@xsi.type\": \"transport_service\",
                                                \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                \"name\": \"st_implicit_app_web-browsing\",
                                                \"display_name\": \"st_implicit_app_web-browsing\",
                                                \"class_name\": \"tcp_service\",
                                                \"origin\": \"DEVICE\",
                                                \"global\": false,
                                                \"implicit\": true,
                                                \"shared\": false,
                                                \"comment\": \"\",
                                                \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                \"version_id\": 4,
                                                \"referenced\": \"UNKNOWN\",
                                                \"type_on_device\": \"\",
                                                \"negate\": false,
                                                \"match_for_any\": false,
                                                \"timeout\": 0,
                                                \"protocol\": 6,
                                                \"min_port\": 80,
                                                \"max_port\": 80
                                            }
                                        ]
                                    },
                                    \"action\": \"ACCEPT\",
                                    \"additional_parameters\": \"\",
                                    \"options\": {
                                        \"option\": \"LOG_SESSION\"
                                    },
                                    \"rule_location\": \"DG_1\",
                                    \"users\": {
                                        \"user\": [
                                            {
                                                \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                \"name\": \"Any\",
                                                \"class_name\": \"any_object\",
                                                \"displayName\": \"Any\"
                                            }
                                        ]
                                    },
                                    \"track\": {
                                        \"track_level\": \"LOG\"
                                    },
                                    \"install_ons\": \"\",
                                    \"communities\": \"\",
                                    \"times\": \"\",
                                    \"rule_metadata\": {
                                        \"permissiveness_level\": \"LOW\",
                                        \"violations\": \"\",
                                        \"last_hit\": \"No hits\",
                                        \"shadowed_status\": \"FALSE\",
                                        \"ticket_ids\": \"\",
                                        \"business_owners\": \"\",
                                        \"expirations\": \"\",
                                        \"applications\": \"\",
                                        \"last_modified\": \"Today\"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            \"rule_modifications\": {
                \"rule_modification\": {
                    \"@xsi.type\": \"modify_rule_modification\",
                    \"id\": 10,
                    \"rule_key\": {
                        \"device_id\": 4,
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                    },
                    \"source_modifications\": {
                        \"id\": 20,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 69,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 65,
                                        \"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 65,
                                                \"name\": \"My New Host\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 68,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 64,
                                        \"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 64,
                                                \"name\": \"My New Address Ragne\",
                                                \"comment\": \"some comment\",
                                                \"min_ip\": \"192.168.0.1\",
                                                \"max_ip\": \"192.168.0.254\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 70,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 68,
                                        \"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 68,
                                                \"name\": \"My New Network\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    \"destination_modifications\": {
                        \"id\": 19,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 66,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 67,
                                        \"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 67,
                                                \"name\": \"Range-Test\",
                                                \"comment\": \"\",
                                                \"min_ip\": \"1.1.2.0\",
                                                \"max_ip\": \"1.1.2.55\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 67,
                                    \"action\": \"REMOVE\",
                                    \"device_network_object\": {
                                        \"id\": 66,
                                        \"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 66,
                                                \"name\": \"22.22.2.2\",
                                                \"comment\": \"\",
                                                \"ip\": \"22.22.2.2\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 65,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 70,
                                        \"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",
                                        \"device_id\": 2,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 70,
                                                \"name\": \"Net_10.108.151.0\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.108.151.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 64,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 69,
                                        \"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 69,
                                                \"name\": \"Host_10.10.10.10\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.10.10.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            \"designer_result\": {
                \"status\": \"not run\"
            }
        }
    }
}}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Modify the Designer suggestions for Access Request or Clone Server Policy", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "tasks", "{{taskId}}", "designer", "instruction", "{{instructionId}}" ] }, "description": " GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
400: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
401: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device." }, "response": [] }, { "name": "Returns the details of a specified ticket stages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID." }, "response": [] }, { "name": "Returns a list of tickets by search parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "free_text_search" ] }, "description": "Parameters:
parameter: Free text search parameter (Search syntax details) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query" }, "response": [] }, { "name": "Get server clone policy verifier results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "clone_server_policy", "verifier" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request." }, "response": [] }, { "name": "Returns the details of a specified ticket", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query" }, "response": [] }, { "name": "Submit a new ticket to Secure Change", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"ticket\": {\n\t\t\"application_details\": { \"id\": \"1\" },\n\t\t\"subject\": \"topology mode_AR1-with topology_AR2-no topology\",\n\t\t\"priority\": \"Normal\",\n\t\t\"workflow\": { \"name\": \"ar\" }\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "" ] }, "description": " GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
401: You do not have permissions to edit this application.
401: Logged in user: NAME do not have permission to perform on behalf actions
401: You are not a participant in the first step of this workflow
401: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Returns the details of a specified tickets (max 100 tickets in a single query)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied" }, "response": [] }, { "name": "Returns a list of tickets by search parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "search" ] }, "description": "If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
401: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>" }, "response": [] }, { "name": "Returns topology map image (png file) for specific verifier results", "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "multi_access_request", "{{fieldId}}", "verifier", "topology_map" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field." }, "response": [] }, { "name": "Get access request verifier results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}", "multi_access_request", "{{fieldId}}", "verifier" ] }, "description": "Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request." }, "response": [] }, { "name": "Returns the details of a specified task", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ." }, "response": [] }, { "name": "Change a task of a ticket", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": { "mode": "raw", "raw": "{\n\t\"task\": {\n\t\t\"id\": 4,\n\t\t\"assignee_id\": 4,\n\t\t\"assignee\": \"a\",\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 71,\n\t\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\t\"read_only\": false,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"id\": 13,\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"id\": 26,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"id\": 25,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"designer_result\": {\n\t\t\t\t\t\"status\": \"not run\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks", "{{taskId}}" ] }, "description": "
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <object_UID>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</object_UID>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <object_UID>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</object_UID>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <object_UID>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</object_UID>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/
BODY{
    \"task\": {
        \"id\": 4,
        \"assignee_id\": 4,
        \"assignee\": \"a\",
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 71,
                \"name\": \"Fire Wall Rule\",
                \"read_only\": false,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 4,
                        \"management_name\": \"Panorama/DG_1\",
                        \"management_id\": 4,
                        \"management_ip\": \"10.100.111.120\",
                        \"revision_number\": 1,
                        \"number_of_rules\": 1,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{00-FACED0-00}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"Standard\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                        \"name\": \"Application test\",
                                        \"is_disabled\": false,
                                        \"ruleNumber\": 13,
                                        \"from_zone\": \"any\",
                                        \"to_zone\": \"any\",
                                        \"sourceNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                            \"name\": \"H_5.3.2.5\",
                                            \"display_name\": \"H_5.3.2.5\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"comment\",
                                            \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"5.3.2.5\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                            \"name\": \"22.22.2.2\",
                                            \"display_name\": \"22.22.2.2\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a016\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"22.22.2.2\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationServices\": {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                            \"name\": \"TCP82\",
                                            \"display_name\": \"TCP82\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"TCP82\",
                                            \"id\": \"5df1f2a5e9023c311ae4a018\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 82,
                                            \"max_port\": 82
                                        },
                                        \"applications\": {
                                            \"@xsi.type\": \"single_application\",
                                            \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                            \"name\": \"web-browsing\",
                                            \"display_name\": \"web-browsing\",
                                            \"class_name\": \"application_object\",
                                            \"origin\": \"DEVICE_PREDEFINED\",
                                            \"global\": true,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"service\": [
                                                {
                                                    \"@xsi.type\": \"transport_service\",
                                                    \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                    \"name\": \"st_implicit_app_web-browsing\",
                                                    \"display_name\": \"st_implicit_app_web-browsing\",
                                                    \"class_name\": \"tcp_service\",
                                                    \"origin\": \"DEVICE\",
                                                    \"global\": false,
                                                    \"implicit\": true,
                                                    \"shared\": false,
                                                    \"comment\": \"\",
                                                    \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                    \"version_id\": 4,
                                                    \"referenced\": \"UNKNOWN\",
                                                    \"type_on_device\": \"\",
                                                    \"negate\": false,
                                                    \"match_for_any\": false,
                                                    \"timeout\": 0,
                                                    \"protocol\": 6,
                                                    \"min_port\": 80,
                                                    \"max_port\": 80
                                                }
                                            ]
                                        },
                                        \"action\": \"ACCEPT\",
                                        \"additional_parameters\": \"\",
                                        \"options\": {
                                            \"option\": \"LOG_SESSION\"
                                        },
                                        \"rule_location\": \"DG_1\",
                                        \"users\": {
                                            \"user\": [
                                                {
                                                    \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                    \"name\": \"Any\",
                                                    \"class_name\": \"any_object\",
                                                    \"displayName\": \"Any\"
                                                }
                                            ]
                                        },
                                        \"track\": {
                                            \"track_level\": \"LOG\"
                                        },
                                        \"install_ons\": \"\",
                                        \"communities\": \"\",
                                        \"times\": \"\",
                                        \"rule_metadata\": {
                                            \"permissiveness_level\": \"LOW\",
                                            \"violations\": \"\",
                                            \"last_hit\": \"No hits\",
                                            \"shadowed_status\": \"FALSE\",
                                            \"ticket_ids\": \"\",
                                            \"business_owners\": \"\",
                                            \"expirations\": \"\",
                                            \"applications\": \"\",
                                            \"last_modified\": \"Today\"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"id\": 13,
                        \"rule_key\": {
                            \"device_id\": 4,
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                        },
                        \"source_modifications\": {
                            \"id\": 26,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 89,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 88,
                                            \"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 88,
                                                    \"name\": \"My New Host\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 91,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 89,
                                            \"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 89,
                                                    \"name\": \"My New Address Ragne\",
                                                    \"comment\": \"some comment\",
                                                    \"min_ip\": \"192.168.0.1\",
                                                    \"max_ip\": \"192.168.0.254\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 90,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 87,
                                            \"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 87,
                                                    \"name\": \"My New Network\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"id\": 25,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 88,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 91,
                                            \"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 91,
                                                    \"name\": \"Host_10.10.10.10\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.10.10.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 85,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 90,
                                            \"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 90,
                                                    \"name\": \"Range-Test\",
                                                    \"comment\": \"\",
                                                    \"min_ip\": \"1.1.2.0\",
                                                    \"max_ip\": \"1.1.2.55\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 86,
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"id\": 86,
                                            \"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 86,
                                                    \"name\": \"22.22.2.2\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"22.22.2.2\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 87,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 85,
                                            \"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",
                                            \"device_id\": 2,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 85,
                                                    \"name\": \"Net_10.108.151.0\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.108.151.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                \"designer_result\": {
                    \"status\": \"not run\"
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object" }, "response": [] }, { "name": "Returns the details of the tasks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks", "protocol": "https", "host": [ "{{SecureChange_IP}}" ], "path": [ "securechangeworkflow", "api", "securechange", "tickets", "{{id}}", "steps", "{{stepId}}", "tasks" ] }, "description": "For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID." }, "response": [] } ] } ] }