Workflows can be accessed through this API using the GET service.
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.
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. |
Parameter | Required | Type | Description |
---|---|---|---|
workflowName | No | URL(query) | This is a URL query parameter for the name which is used to query the workflows with. |
workflowType | No | URL(query) | This is a URL query parameter for the type which is used to query the workflows with. |
group | No | URL(query) | This is a URL query parameter for the group which is used to query the workflows with. |
subgroup | No | URL(query) | This is a URL query parameter for the subgroup which is used to query the workflows with. |
Attributes | Type | Description |
---|---|---|
workflowId | Long | This is the unique Id of the workflow |
workflowName | String | This is the name of the workflow. |
workflowType | String | This is the type of the workflow. |
isActive | Boolean | This is a Boolean that tracks whether or not the workflow is active. |
Group | String | This is the group of the workflow. |
Subgroup | String | This is the subgroup of the workflow. |
Description | String | This is the description of the workflow. |
activeVersionId | Long | This is the id of the active version of the workflow. |
HTTP Code | Description |
---|---|
200 | Workflows were found and returned |
400 | Bad request |
401 | Unauthorized |
500 | Unexpected internal server error |
If we had a workflow in our database with a name 'JMeter-runTest' and had the following attributes
{ "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
{ "workflowId": 10111, "workflowName": "JMeter-runTest", "workflowType": "TEST_DEFINITION", "description": "JMeter execute test workflow", "group": "FlexDeploy(read only)", "subgroup": "Testing", "activeVersionId": 10862, "isActive": true } |