AnchorTopTopApproval Tasks can be accessed through this API using GET. This API can also approve and reject approval tasks based on task id and other parameters.

...

Include Page

...

title	Base URL for Approval Tasks REST API

...

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

	REST V1 Authentication
	REST V1 Authentication

Table of Contents

maxLevel	2

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

...

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

Release Approval Task

...

Application Approval Task

...

Project Approval Task

...

Back to Top

GET

GET by TaskId

...

GET

GET by TaskId

This GET service will find an approval task with the given task Id and return the JSON representation of the object.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/tasks/approval/{Id}

...

Request

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.approval task.

Include Page

	REST V1 Approval Task Response
	REST V1 Approval Task Response

Example

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

Code Block

theme	Eclipse
title	Approval Task - 10000

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 10000,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}

When we run a GET request at the following URL

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

The GET request would return the following JSON approval task object

Code Block

theme	Eclipse
title	Approval Task - 10000

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 10000,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}

Back to Top

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/v1/tasks/approval?

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

workflowRequestId = {workflowRequestId}

folderRequestId = {folderRequestId}

pipelineStageExecId = {pipelineStageExecId}

projectId = {projectId}

applicationId = {applicationId}

environmentId = {environmentId}

externalId = {externalId}

externalSystemType = {externalSystemType}

externalSystemId = {externalSystemId}

notes = {notes}*

Examples:

To return all of the approval tasks:

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

To search by project Id only:

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

...

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

...

same as searching by name=example.

*notes are used to add a note, not search by a note.

Request

Parameter	Type	Required	Description
workflowRequestId	URL	No	This is a URL query parameter for the workflow request Id which is used to search the approval tasks.
folderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the approval tasks.
pipelineStageExecId	URL	No	This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks.
projectId	URL	No	This is a URL query parameter for the project Id which is used to search the approval tasks.
applicationId	URL	No	This is a URL query parameter for the application Id which is used to search the approval tasks.
environmentId	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.
notes	URL	No	Notes entered when approving or rejecting the task

Include Page

	REST V1 Approval Task Response
	REST V1 Approval Task Response

Example

If we had an approval task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

[
{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}
]

When we run a GET request at the following URL

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

...

Code Block

theme	Eclipse
title	Approval Task

[
{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1" 1",
   "notes": null
}
]

Back to Top

Approve By TaskId

This PUT service will approve an approval task with the given Id.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/tasks/approval/approve/{Id}

...

Request

Attributes	Type	Required	Description
Id	Long	Yes	The Id of the approval task you wish to approve

Include Page

	REST V1 Approval Task Response
	REST V1 Approval Task Response

Example

If we had an approval task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/approval/approve/11702?notes=Approved+by+George

The PUT request would approve the approval task and return the following JSON approval task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "APPROVED",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": "Approved by George"
}

Back to Top

Approve using Query Parameters

...

Info

title	API URLs

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

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

workflowRequestId = {workflowRequestId}

folderRequestId = {folderRequestId}

pipelineStageExecId = {pipelineStageExecId}

projectId = {projectId}

applicationId = {applicationId}

environmentId = {environmentId}

externalId = {externalId}

externalSystemType = {externalSystemType}

externalSystemId = {externalSystemId}

notes = {notes}

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.

...

Request

Parameter	Type	Required	Description
workflowRequestId	URL	No	This is a URL query parameter for the workflow request Id which is used to search the approval tasks.
folderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the approval tasks.
pipelineStageExecId	URL	No	This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks.
projectId	URL	No	This is a URL query parameter for the project Id which is used to search the approval tasks.
applicationId	URL	No	This is a URL query parameter for the application Id which is used to search the approval tasks.
environmentId	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.
notes	URL	No	Notes entered when approving or rejecting the task

Include Page

	REST V1 Approval Task Response
	REST V1 Approval Task Response

Example

If we had an approval task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/approval/approve?projectid=10002&notes=Approved+by+George

The PUT request would approve the approval task and return the following JSON approval task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "APPROVED",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": "Approved by George"
}

Back to Top

Reject By TaskId

This PUT service will reject an approval task with the given Id.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/tasks/approval/reject/{Id}

...

Request

Attributes	Type	Required	Description
Id	Long	Yes	The Id that is used to approve an approval task with the same approval task Id.of the approval task you wish to reject

Include Page

	REST V1 Approval Task Response
	REST V1 Approval Task Response

Example

If we had an approval task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1" / Application 1",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/approval/reject/11702?notes=Approved+by+George

The PUT request would reject the approval task and return the following JSON approval task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "REJECTED",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": "Approved by }

...

George"
}

Reject using Query Parameters

...

Info

title	API URLs

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

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

workflowRequestId = {workflowRequestId}

folderRequestId = {folderRequestId}

pipelineStageExecId = {pipelineStageExecId}

projectId = {projectId}

applicationId = {applicationId}

environmentId = {environmentId}

externalId = {externalId}

externalSystemType = {externalSystemType}

externalSystemId = {externalSystemId}

notes = {notes}

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.

notes are used to add a note, not search by a note.

...

Request

Parameter	Type	Required	Description
workflowRequestId	URL	No	This is a URL query parameter for the workflow request Id which is used to search the approval tasks.
folderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the approval tasks.
pipelineStageExecId	URL	No	This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks.
projectId	URL	No	This is a URL query parameter for the project Id which is used to search the approval tasks.
applicationId	URL	No	This is a URL query parameter for the application Id which is used to search the approval tasks.
environmentId	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.
notes	URL	No	Notes entered when approving or rejecting the task

Include Page

	REST V1 Approval Task Response
	REST V1 Approval Task Response

Example

If we had an approval task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "PENDING",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/approval/reject?projectid=10002&notes=Approved+by+George

The PUT request would reject the approval task and return the following JSON approval task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectName": "Project 1",
   "projectVersionName": "1.0.21",
   "workflowRequestId": 11701,
   "projectId": 10002,
   "taskId": 11702,
   "status": "REJECTED",
   "environmentId": 16109,
   "flexFields": [],
   "requestType": "Project",
   "requestorPath": "FlexDeploy / Application 1",
   "notes": null
}

...

Versions Compared

Old Version 18

New Version Current

Key

Release Approval Task

Application Approval Task

Project Approval Task

GET

GET by TaskId

GET

GET by TaskId

Request

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:

Request

Example

Approve By TaskId

Request

Example

Approve using Query Parameters

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

Request

Example

Reject By TaskId

Request

Example

Reject using Query Parameters

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

Request

Example

Page Comparison

Versions Compared

Old Version 18

New Version Current

Key

Release Approval Task

Application Approval Task

Project Approval Task

GET

GET by TaskId

GET

GET by TaskId

Request

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:

Request

Example

Approve By TaskId

Request

Example

Approve using Query Parameters

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

Request

Example

Reject By TaskId

Request

Example

Reject using Query Parameters

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

Request

Example