Versions Compared

Key

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

...

GET (By Id)

This GET service will return the JSON representation of a workflow given a workflow Id.

Info
titleAPI URL

http://host:port/flexdeploy/rest/v1/workflows/{workflowId}

Request

ParameterTypeRequiredDescription
workflowIdURLYesPath parameter for the workflow Id

Response

Workflow JSON objects have the following attributes:

AttributeTypeDescription
workflowIdLongThis is the unique Id of the workflow
workflowNameStringThis is the name of the workflow.
workflowTypeStringThis is the type of the workflow.  Possible workflow types are:
  • BUILD
  • DEPLOY
  • OTHER
  • TEST
  • TEST_DEFINITION
  • UTILITY
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 CodeDescription
200Workflow was found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Workflow not found
500Unexpected internal server error

Example

If a workflow has an id of 12345 and a GET request was sent to http://host:port/flexdeploy/rest/v1/rest/workflows/12345

A workflow JSON object will be returned with the following workflow information:

Code Block
themeEclipse
titleWorkflow GET Return JSON
{
"workflowId": 12345,
"workflowName": "Run SoapUI Test",
"workflowType": "TEST_DEFINITION",
"description": "SoapUI execute test workflow",
"group": "FlexDeploy(read only)",
"subgroup": "Testing",
"activeVersionId": 21598,
"isActive": true
}

GET (Using Query Parameters)

...