POST /{id}/flows

Edits an application's flows.

Resource Name: /applications/{id}/flows

Permissions Required:
  • editAllApplications
  • createSharedFlows
Request URL Parameters:

Parameter

Type

Description
idMandatory

String

The application's revision ID.
flowIDMandatory

Integer

Flow ID.
name

String

New flow name.
comment

String

New flow comment.
addSources

Array of NetworkObject (see NetworkObject )

Sources to add to flow.
removeSources

Array of NetworkObject (see NetworkObject )

Sources to remove from flow.
addNetworkUsers

Array of String

New usernames to add to flow.
removeNetworkUsers

Array of String

User names to remove from flow.
addDestinations

Array of NetworkObject (see NetworkObject )

Destinations to add to flow.
removeDestinations

Array of NetworkObject (see NetworkObject )

Destinations to remove from flow.
addServices

Array of NetworkObject (see NetworkObject )

Services to add to flow.
removeServices

Array of NetworkObject (see NetworkObject )

Services to remove from flow.
addNetworkApplications

Array of NetworkObject (see NetworkObject )

Network applications to add to flow.
removeNetworkApplications

Array of NetworkObject (see NetworkObject )

Network applications to remove from flow.
setCustomFeidls

Array of KeyValuePair (see KeyValuePair )

Custom fields to assign to flow.
clearCustomFields

Array of String

Custom fields to clear from flow.

Return:

Parameter

Type

Description
success

Boolean

Operation status.
flows

Array of Flow (see Flow )

List of all application flows after change.
Error Codes:
  • 404 (Not found) - Application wasn't found.
  • 404 (Not found) - Flow ID wasn't found.
  • 403 (Forbidden) - User doesn't have permission to edit the application.
  • 400 (Bad request) - Flow isn't editable due to status.
  • 400 (Bad request) - Duplicate name.
  • 400 (Bad request) - Request parameter has wrong or missing value.

Request example: 

POST <ip:port>/BusinessFlow/rest/v1/application/15/flows
[
  {
    "flowID": 50,
    "name": "new flow name",
    "addSources": [
      "device": "x_1231_dac",
      "name": "testSource"
    ],
    "removeDestinations": [
      {
        "name": "oldDst"
      }
    ]
    "setCustomFields": [
      {
        "name": "cfKey1",
        "value": "cfValue1"
      }
    ]
  }
]

Return Example:

{  "success": true,  "flows": [    {      "flowID": 50,      "name": "new flow name",      "flowType": "APPLICATION_FLOW",      …    }  ]}

See Flow ) object for more information.

 

â See also: