Versions Compared

Key

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

Anchor
Top
Top

...

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

Info
titleAPI URL

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

Parameters

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return an approval task.

...

When we run a GET request at the following URL

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

The GET request would return the following JSON approval task object

...

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
titleAPI URLs

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

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

workflowrequestid = {workflowRequestId}

foldererquestid = {folderRequestId}

pipelinestageexecid = {pipelineStageExecId}

projectid = {projectId}

applicationid = {applicationId}

environmentid = {environmentId}

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


Tip

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

...

When we run a GET request at the following URL

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

The GET request would return the  following JSON approval task object

...

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

Info
titleAPI URL

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

Parameters

AttributesTypeRequiredDescription
IdLongYesThe Id that is used to approve an approval task with the same approval task Id.

...

When we run a PUT request at the following URL

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

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

...

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

Info
titleAPI URLs

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

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

workflowrequestid = {workflowRequestId}

foldererquestid = {folderRequestId}

pipelinestageexecid = {pipelineStageExecId}

projectid = {projectId}

applicationid = {applicationId}

environmentid = {environmentId}

...

When we run a PUT request at the following URL

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

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

...

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

Info
titleAPI URL

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

Parameters

...

When we run a PUT request at the following URL

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

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

...

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

Info
titleAPI URLs

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

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

workflowrequestid = {workflowRequestId}

foldererquestid = {folderRequestId}

pipelinestageexecid = {pipelineStageExecId}

projectid = {projectId}

applicationid = {applicationId}

environmentid = {environmentId}

...

When we run a PUT request at the following URL

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

...