Page Comparison

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

Include Page

	REST V1 Authentication
	REST V1 Authentication

...

Info

title	API URLs

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

workflowName={name}

workflowType={type}

group={group}

subgroup={subgroup}

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

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

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

Tip
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

...

Versions Compared