Flow instance operations (POST)

Edit online

Description

URL

scheme://domain:port/platform/ws/flow/instances/kill

scheme://domain:port/platform/ws/flow/instances/suspend

scheme://domain:port/platform/ws/flow/instances/resume

scheme://domain:port/platform/ws/flow/instances/rerun

scheme://domain:port/platform/ws/flow/instances/setvar

Description

Flow instances operations:

  • /platform/ws/flow/instances/kill: Kill flow instances by IDs on PM server side.
  • /platform/ws/flow/instances/suspend: Suspend flow instances by IDs on PM server side.
  • /platform/ws/flow/instances/resume: Resume flow instances by IDs on PM server side.
  • /platform/ws/flow/instances/rerun: Rerun flow instances by IDs on PM server side.
  • /platform/ws/flow/instances/setvar: Set variables for flow instances by IDs on PM server side.

HTTP Method

POST

Parameters

API

Name

Description

kill, suspend, resume, rerun, setvar

ids

Flow instance IDs. Supports multiple flow instance IDs, split by a comma (,).

rerun, setvar

variables

Input variables, split by semicolon (;).

Request

Request

Request Information

Method

POST

Request-URI

/platform/ws/flow/instances/{operation}

Request-Header

Name

Value

Accept

application/xml or application/json
Content-Type

application/x-www-form-urlencoded

Message-Body
  1. ids=101,102,103
  2. ids=101,101&variables=a=1;b=3

Response

Response Code

  • 200 Successful: Request was successful.
  • 400 Bad Request: The request is not valid.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 404 Not Found: No flows that match the specified criteria found.
  • 500 Internal Server Error: Exception occurred

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

 Success Message 
{
  {
    "message": {
        "message": "%s"
    }
}
Failure Message

If not successful, returns an error message.

{
    "error": {
        "message": "%s"
    }
}

Example: Kill flow instances

# Request
POST /platform/ws/flow/instances/kill
Accept: application/json;
ids=101,102

# Response
200 Successful
Content-Type: application/json;
{
    "message": {
        "message": "kill flow 101 done. Kill flow 102 done."
    }
}


# Request
POST /platform/ws/flow/instances/kill
Accept: application/xml;
ids=101,102


# Response
200 Successful
Content-Type: application/xml;

<message>
        <message> Kill flow 101 done. Kill flow 102 done."</message>
</message>