Versions Compared

Key

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

...

Request

Parameter
Required
Type
Description
workflowNameNoQuery - StringThe name of the workflow to search for.  Uses contains ignore case search.
workflowTypeNoQuery - StringThe type of the workflow to search for.  Uses equals ignore case search.  Possible workflow types are:
  • BUILD
  • DEPLOY
  • OTHER
  • TEST
  • TEST_DEFINITION
  • UTILITY
groupNoQuery - StringThe group name to search workflows for.  Uses equals ignore case search.
subgroupNoQuery - StringThe subgroup name to search workflows for.  Uses equals ignore case search.

Response

AttributesTypeDescription
workflowIdLongThis is the unique Id of the workflow
workflowNameStringThis is the name of the workflow.
workflowTypeString

This 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 Code
Description
200Workflows were found Search successful and results returned
400Bad request
401UnauthorizedAuthentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

...