Anchor

	Top
	Top

Each function returns a JSON approval task object. The approval task object has these attributes:

Application Approval Task

AttributesTypeDescriptionsnapshotIdLongThe snapshot id of the release approval task.pipelineNameStringThe pipeline name of the release approval task.environmentNameStringThe environment name of the release approval task.gateNameStringThe gate name of the release approval task.releaseNameStringThe release name of the release approval task.releaseDefinitionIdLongThe release definition Id of the release approval task. releaseSnapshotStringThe release snapshot of the release approval task.externalIdStringThe external Id of the release approval task. If the release

Attributes	Type	Description
taskId	Long	The task id of the approval task.
status	String	The status of the approval task.
environmentId	Long	The environment Id of the approval task.
requestType	String	The request type of the approval task. The request type can be a release, application, or project request.
flexFields	List<FlexField>	The list of flex fields for the approval task.
requestorPath	String	The requestor path of the approval task.

Each approval task can be one of three different types: Release, Application, and Project.

Release Approval Task

...

externalId	String	The externalId of the approval task. If the approval task is not an external approval task this will be null.
externalSystemId	Long	The externalSystemId of the approval task. If the approval task is not an external approval task this will be null.
externalSystemTyp	String	The externalSystemType of the approval task. If the approval task is not an external approval task this will be null.

externalSystemIdStringThe external System Id of the release approval task. If the release approval task is not an external approval this will be null.externalSystemTypeStringThe external System type

Each approval task can be one of three different types: Release, Application, and Project.

Release Approval Task

If is not an external approval this will be nullpipelineStageGateExecId pipeline stage execution Id

Attributes	Type	Description
snapshotId	Long	The snapshot id of the release approval task.
pipelineName	String	The pipeline name of the release approval task.
environmentName	String	The environment name of the release approval task	.
gateName	LongString	The	gate name of the release approval task.

Project Approval Task

The snapshot id pipelineName pipeline name environmentName environment name gateName gate name The release name of the release

Attributes	Type	Description
snapshotId	Long	releaseName	String	The release name of the release approval task.
releaseDefinitionId	StringLong	The	release definition Id of the release approval task.
releaseSnapshot	String	The	release snapshot of the release approval task.
pipelineStageGateExecId	StringLong	The	pipeline stage execution Id of the release approval task.	releaseName	String

Application Approval Task

releaseDefinitionId release definition Id release releaseSnapshot release snapshot release externalId external release If the release approval task is not an external approval this will be null.externalSystemId

Attributes	Type	Description
applicationId	Long	The application id of the application approval task.
applicationName	LongString	The	application name of the	application approval task.
folderVersionName	String	The	folder version name of the	application approval task.
folderRequestId	String	The	folder request Id of the	application approval task.

Project Approval Task

external System Id release If the release approval task is not an external approval this will be null.externalSystemType external System type release . If the release approval task is not an external approval this will be nullpipelineStageGateExecId pipeline stage execution Id release

Attributes	Type	Description
projectId	Long	The project id of the project approval task.
projectName	String	The	prohect name of the	project approval task.
projectVersionName	String	The	project version name of the	project approval task	.
workflowRequestId	Long	The	workflow request id of the	project approval task.

Back to Top

...

GET

GET by TaskId

...

Parameter	Type	Required	Description
Id	URL	Yes	This is a URL parameter for the Id which is used to find and return an approval task.

Example

If we had an application approval task in our database with an Id of 10000 and had the following attributes

...

GET (Using Query Parameters)

This GET service will return a list of approval tasks in the form of JSON objects based on a query parameter for the display name. Approval tasks are only returned if they contain the specified parameter. If no query parameters are given this request will return the entire list of approval tasks.

Info

title	API URLs

http://host:port/flexdeploy/rest/tasks/approval?

Append the following character sequences to the above URL to specify Query parameters.

workflowrequestid workflowRequestId = {workflowRequestId}

foldererquestid folderRequestId = {folderRequestId}

pipelinestageexecid pipelineStageExecId = {pipelineStageExecId}

projectid projectId = {projectId}

applicationid applicationId = {applicationId}

environmentid environmentId = {environmentId}

externalId = {externalId}

externalSystemType = {externalSystemType}

externalSystemId = {externalSystemId}

Examples:

To return all of the approval tasks:

http://host:port/flexdeploy/rest/tasks/approval

To search by project Id only:

http://host:port/flexdeploy/rest/tasks/approval?projectid=11001

...

Parameter	Type	Required	Description
workflowrequestidworkflowRequestId	URL	No	This is a URL query parameter for the workflow request Id which is used to search the approval tasks.
foldererquestid folderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the approval tasks.
pipelinestageexecidpipelineStageExecId	URL	No	This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks.
projectidprojectId	URL	No	This is a URL query parameter for the project Id which is used to search the approval tasks.
applicationidapplicationId	URL	No	This is a URL query parameter for the application Id which is used to search the approval tasks.
environmentidenvironmentId	URL	No	This is a URL query parameter for the environment Id which is used to search the approval tasks.
externalId	URL	No	This is a URL query paramter for the external Id which is used to search the approval tasks.
externalSystemType	URL	No	This is a URL query parameter for the external system type which is used to search the approval tasks.
externalSystemId	URL	No	This is a URL query parameter for the external system Id which is used to seach the approval tasks.

...

Info

title	API URLs

http://host:port/flexdeploy/rest/tasks/approval/approve?

Append the following character sequences to the above URL to specify Query parameters.

workflowrequestid workflowRequestId = {workflowRequestId}

foldererquestid folderRequestId = {folderRequestId}

pipelinestageexecid pipelineStageExecId = {pipelineStageExecId}

projectid projectId = {projectId}

applicationid applicationId = {applicationId}

environmentid environmentId = {environmentId}

externalId = {externalId}

externalSystemType = {externalSystemType}

externalSystemId = {externalSystemId}

Info

title	Returned Tasks

Only one approval task can be approved at a time. If more than one task matches the query parameters an exception will be thrown.

...

Parameter	Type	Required	Description
workflowrequestidworkflowRequestId	URL	No	This is a URL query parameter for the workflow request Id which is used to search the approval tasks.
foldererquestidfolderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the approval tasks.
pipelinestageexecidpipelineStageExecId	URL	No	This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks.
projectidprojectId	URL	No	This is a URL query parameter for the project Id which is used to search the approval tasks.
applicationidapplicationId	URL	No	This is a URL query parameter for the application Id which is used to search the approval tasks.
environmentidenvironmentId	URL	No	This is a URL query parameter for the environment Id which is used to search the approval tasks.
externalId	URL	No	This is a URL query parameter for the external Id which is used to search the approval tasks.
externalSystemType	URL	No	This is a URL query parameter for the external Id which is used to search the approval tasks.
externalSystemId	URL	No	This is a URL query parameter for the external Id which is used to search the approval tasks.

...

Info

title	API URLs

http://host:port/flexdeploy/rest/tasks/approval/reject?

Append the following character sequences to the above URL to specify Query parameters.

workflowrequestid workflowRequestId = {workflowRequestId}

foldererquestid folderRequestId = {folderRequestId}

pipelinestageexecid pipelineStageExecId = {pipelineStageExecId}

projectid projectId = {projectId}

applicationid applicationId = {applicationId}

environmentid environmentId = {environmentId}

externalId = {externalId}

externalSystemType = {externalSystemType}

externalSystemId = {externalSystemId}

Info

title	Returned Tasks

Only one approval task can be rejected at a time. If more than one task matches the query parameters an exception will be thrown.

...

Parameter	Type	Required	Description
workflowrequestidworkflowRequestId	URL	No	This is a URL query parameter for the workflow request Id which is used to search the approval tasks.
foldererquestidfolderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the approval tasks.
pipelinestageexecidpipelineStageExecId	URL	No	This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks.
projectidprojectId	URL	No	This is a URL query parameter for the project Id which is used to search the approval tasks.
applicationidapplicationId	URL	No	This is a URL query parameter for the application Id which is used to search the approval tasks.
environmentidenvironmentId	URL	No	This is a URL query parameter for the environment Id which is used to search the approval tasks.
externalId	URL	No	This is a URL query parameter for the external Id which is used to search the approval tasks.
externalSystemType	URL	No	This is a URL query paramater for the external Id which is used to search the approval tasks.
externalSystemId	URL	No	This is a URL query parameter for the external Id which is used to search the approval tasks.

...

Versions Compared

Old Version 16

New Version 17

Key

Application Approval Task

Release Approval Task

Release Approval Task

Project Approval Task

Application Approval Task

Project Approval Task

GET

GET by TaskId

Example

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Examples:

To return all of the approval tasks:

To search by project Id only:

Append the following character sequences to the above URL to specify Query parameters.

Append the following character sequences to the above URL to specify Query parameters.

Page Comparison

Versions Compared

Old Version 16

New Version 17

Key

Application Approval Task

Release Approval Task

Release Approval Task

Project Approval Task

Application Approval Task

Project Approval Task

GET

GET by TaskId

Example

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Examples:

To return all of the approval tasks:

To search by project Id only:

Append the following character sequences to the above URL to specify Query parameters.

Append the following character sequences to the above URL to specify Query parameters.