Workflows can be retrieved using this API using the GET service.
This GET service will return the JSON representation of a workflow given a workflow Id.
http://host:port/flexdeploy/rest/v1/workflows/{workflowId} |
Parameter | Type | Required | Description |
---|---|---|---|
workflowId | URL | Yes | Path parameter for the workflow Id |
Workflow JSON objects have the following attributes:
Attribute | 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. Possible workflow types are:
|
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 | Workflow was found and returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
404 | Workflow not found |
500 | Unexpected internal server error |
If a workflow has an id of 12345 and a GET request was sent to http://host:port/flexdeploy/v1/rest/workflows/12345
A workflow JSON object will be returned with the following workflow information:
{ "workflowId": 12345, "workflowName": "Run SoapUI Test", "workflowType": "TEST_DEFINITION", "description": "SoapUI execute test workflow", "group": "FlexDeploy(read only)", "subgroup": "Testing", "activeVersionId": 21598, "isActive": true } |
This GET service will find a workflow by querying based on a name, type, group, and/or subgroup and will 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 | Query - String | The name of the workflow to search for. Uses contains ignore case search. |
workflowType | No | Query - String | The type of the workflow to search for. Uses equals ignore case search. Possible workflow types are:
|
group | No | Query - String | The group name to search workflows for. Uses equals ignore case search. |
subgroup | No | Query - String | The subgroup name to search workflows for. Uses equals ignore case search. |
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. Possible workflow types are:
|
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 | Search successful and results returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
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 } |