Versions Compared

Key

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

Anchor
Top
Top

...

Info
titleBase URL for Scheduled Tasks REST API

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

Table of Contents
maxLevel2

...

Info
titleAPI URL

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

Parameters

...

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

The GET request would return the following JSON scheduled task object

...

GET (Using Query Parameters)

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

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/tasks/scheduled?

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

workflowRequestId = {workflowRequestId}

folderRequestId = {folderRequestId}

pipelineStageGateExecId = {pipelineStageGateExecId}

pipelineStageStepExecId = {pipelineStageStepExecId}

projectId = {projectId}

applicationId = {applicationId}

environmentId = {environmentId}

notes = {notes}

Examples:
To return all of the scheduled tasks:

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

To search by project Id only:

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

...

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

...

Info
titleAPI URL

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

...

http://host:port/flexdeploy/rest/v1/tasks/scheduled/runnow/14332?notes=Approved+by+George

...

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/tasks/scheduled/runnow?

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

workflowRequestId = {workflowRequestId}

folderRequestId = {folderRequestId}

pipelineStageGateExecId = {pipelineStageGateExecId}

pipelineStageStepExecId = {pipelineStageStepExecId}

projectId = {projectId}

applicationId = {applicationId}

environmentId = {environmentId}

notes = {notes}

...

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

...

Info
titleAPI URL

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

...

http://host:port/flexdeploy/rest/v1/tasks/scheduled/cancel/14332?notes=

...

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/tasks/scheduled/cancel?

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

workflowRequestId = {workflowRequestId}

folderRequestId = {folderRequestId}

pipelineStageGateExecId = {pipelineStageGateExecId}

pipelineStageStepExecId = {pipelineStageStepExecId}

projectId = {projectId}

applicationId = {applicationId}

environmentId = {environmentId}

notes = {notes}

...

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

...