Workflow API

Workflows can be accessed through this API using the GET service.

Authentication - Use Basic Authentication for this API.

GET

GET (Using Query Parameters)

This GET service will find a workflow by querying based on a name, type, group, and/or subgroup and return the JSON representations of the objects. If no query parameters are given this request will return the entire list of workflows.

API URLs

http://host:port/flexdeploy/rest/v1/workflows?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

workflowName={name}

workflowType={type}

group={group}

subgroup={subgroup}

Examples:
To search by name only:

http://host:port/flexdeploy/rest/v1/workflows?workflowName={name}

To search by group only:

http://host:port/flexdeploy/rest/v1/workflows?group={group}

To search by subgroup and name:

http://host:port/flexdeploy/rest/v1/workflows?subgroup={subgroup}&workflowName={name}

The query parameters are not case sensitive. Searching by name=NAME is the same as searching by name=name.

Request

Parameter
Required
Type
Description
workflowNameNoURL(query)This is a URL query parameter for the name which is used to query the workflows with.
workflowTypeNoURL(query)This is a URL query parameter for the type which is used to query the workflows with.
groupNoURL(query)This is a URL query parameter for the group which is used to query the workflows with.
subgroupNoURL(query)This is a URL query parameter for the subgroup which is used to query the workflows with.

Response

AttributesTypeDescription
workflowIdLongThis is the unique Id of the workflow
workflowNameStringThis is the name of the workflow.
workflowTypeStringThis is the type of the workflow.
isActiveBooleanThis is a Boolean that tracks whether or not the workflow is active.
GroupStringThis is the group of the workflow.
SubgroupStringThis is the subgroup of the workflow.
DescriptionStringThis is the description of the workflow.
activeVersionIdLongThis is the id of the active version of the workflow.

Response Codes

HTTP Code
Description
200Workflows were found and returned
400Bad request
401Unauthorized
500Unexpected internal server error

Example

If we had a workflow in our database with a name 'JMeter-runTest' and had the following attributes

Workflow - JMeter-runTest
{
"workflowId": 10111,
"workflowName": "JMeter-runTest",
"workflowType": "TEST_DEFINITION",
"description": "JMeter execute test workflow",
"group": "FlexDeploy(read only)",
"subgroup": "Testing",
"activeVersionId": 10862,
"isActive": true
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/workflows?name=JMeter-runTest&type=TEST_Definition

The GET request would return the  following JSON workflow object

Workflow GET Return JSON
{
"workflowId": 10111,
"workflowName": "JMeter-runTest",
"workflowType": "TEST_DEFINITION",
"description": "JMeter execute test workflow",
"group": "FlexDeploy(read only)",
"subgroup": "Testing",
"activeVersionId": 10862,
"isActive": true
}