Getting a specified flow definition by filter (GET)

Edit online

Description

URL

scheme://domain:port/platform/ws/flow/definitions

Description

Gets the flow definition by filter. By default gets all the flow definitions owned by the currently logged on users.

HTTP Method

GET

Parameters

Name

Description

flowname

Optional.

Flow definition name. Supports fuzzy matching and wildcard character (*).

username

Optional.

Flow definition owner. Use the keyword "all" to return flow definitions owned by all users.

status

Optional.

Flow definition status. Possible values:

  • ONHOLD
  • RELEASED

published

Optional.

Flow definition is published or not.

start

Optional.

The start index for flow definitions paging

pagesize

Optional.

Maximum number of flow definitions that are returned.

Request

Request

Request Information

Method

GET

Request-URI

/platform/ws/flow/definitions

or

/platform/ws/flow/definitions?flowname=%s&username=%s&status=%s&published=%s&start=%d&pagesize=%d

Request-Header

Name

Value

Accept

application/xml or application/json

Message-Body

empty

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 flow definitions 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

If successful, returns basic information about hosts.

{
  "pseudoFlowDefinitions": {
    "total": 2,
    " pseudoFlowDefinition": [
      {
        "user": "jsmith",
        "name": "flow1",
        "status": "RELEASED",
        "published": true,
        "version": "1.2"
      },
      {
        "user": "jsmith",
        "name": "flow2",
        "status": "ONHOLD",
        "published": true,
        "version": "1.0"
      }
    ]
  }
}
Failure Message

If not successful, returns an error message.

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

Example: Get flow definitions by user

# Request
GET /platform/ws/flow/definitions?username=jsmith
Accept: application/json;

# Response
200 Successful
Content-Type: application/json;
{
  " pseudoFlowDefinitions": {
    "total": 2,
    " pseudoFlowDefinition": [
      {
        "user": "jsmith",
        "name": "flow1",
        "status": "RELEASED",
        "published": true,
        "version": "1.2"
      },
      {
        "user": "jsmith",
        "name": "flow2",
        "status": "ONHOLD",
        "published": true,
        "version": "1.0"
              }
            ]
          }
        }


# Request
GET /platform/ws/flow/definitions?username=jsmith
Accept: application/xml;

# Response
200 Successful
Content-Type: application/xml;
<pseudoFlowDefinitions total="2">
	< pseudoFlowDefinition>
		<user>jsmith</user>
		<name>flow1</name>
		<status>ONHOLD</status>
		<published>true</published>
		<version>1.2</version>
	</pseudoFlowDefinition>
	<pseudoFlowDefinition>
		<user>jsmith</user>
		<name>flow2</name>
		<status>ONHOLD</status>
		<published>true</published>
		<version>1.0</version>
	</pseudoFlowDefinitions>
</pseudoFlowDefinitions>