Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top

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

Info
titleBase URL for Test Workflow REST API

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

...

Info
titleAPI URLs

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

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

workflownameworkflowName={name}

workflowtypeworkflowType={type}

group={group}

subgroup={subgroup}

Examples:
To search by name only:

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

To search by group only:

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

To search by subgroup and name:

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


Tip

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

Parameters

Parameter
Required
Type
Description
workflownameworkflowNameNoURL(query)This is a URL query parameter for the name which is used to query the workflows with.
workflowtypeworkflowTypeNoURL(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 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

...