AnchorTopTopScheduled Tasks can be accessed through this API using GET. This API can also run and cancel scheduled tasks based on task id and other parameters.

...

Include Page

...

title	Base URL for Scheduled Tasks REST API

REST V1 Authentication
	REST V1 Authentication

Table of Contents

maxLevel	2

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

...

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

...

Gate Scheduled Task

...

Application Scheduled Task

...

The folder request Id of the application scheduled task.

Project Scheduled Task

...

Back to Top

GET

GET by TaskId

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

Info

title	API URL

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

Parameters

...

Parameter

...

Type

...

Required

...

Description

...

Id

...

Example

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

...

theme	Eclipse
title	Scheduled Task - 10000

...

GET

GET by TaskId

This GET service will find a scheduled 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/scheduled/{Id}

Request

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

Include Page

	REST V1 Scheduled Task Response
	REST V1 Scheduled Task Response

Response Codes

HTTP Code	Description
200	Task was found and returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	Task not found
500	Unexpected internal server error

Example

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

Code Block

theme	Eclipse
title	Scheduled Task - 10000

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": "PENDING"null
}

When we run a GET request at the following URL

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

The GET request would return the following JSON scheduled task object

Code Block

theme	Eclipse
title	Scheduled Task - 10000

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
}

...

   "notes": null
}

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

title	API 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

...

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

...

Request

Parameter	Type

Required

Description

workflowRequestIdURL

Required	Description
workflowRequestId	Query - Long	No	This is a URL query parameter for the workflow request Id which is used to search the scheduled tasks.
folderRequestId	Query - Long	No	This is a URL query parameter for the

workflow

folder request Id which is used to search the scheduled tasks.

folderRequestId

pipelineStageGateExecId

URL

Query - Long

No

This is a URL query parameter for the

folder request

pipeline stage gate execution Id which is used to search the scheduled tasks.

pipelineStageGateExecId

pipelineStageStepExecId

URL

Query - Long

No

This is a URL query parameter for the pipeline stage

gate

step execution Id which is used to search the scheduled tasks.

pipelineStageStepExecIdURL

projectId	Query - Long	No	This is a URL query parameter for the project Id which is used to search the scheduled tasks.
applicationId	Query - Long	No	This is a URL query parameter for the

pipeline stage step execution

application Id which is used to search the scheduled tasks.

projectId

environmentId

URL

Query - Long

No

This is a URL query parameter for the

project

environment Id which is used to search the scheduled tasks.

applicationId

notes

URL

Query - String

No

This is a URL query parameter for

the application Id which is used to search the scheduled tasks.environmentIdURLNoThis is a URL query parameter for the environment Id which is used to search the scheduled tasks.

notes added to the task when running or canceling it.

Equals type search.

Include Page

	REST V1 Scheduled Task Response
	REST V1 Scheduled Task Response

Response Codes

HTTP Code	Description
200	Search successful and results returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Code Block

theme	Eclipse
title	scheduled Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "statusnotes": "PENDING"null
}

When we run a GET request at the following URL

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

...

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project"",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "workflowRequestIdrequestType": 656423"Project",
   "projectIdflexFields": 10002[],
   "scheduledDateenvironmentId": "2099-03-16 22:17:52.0"77954,
   "taskIdstatus": 14332"PENDING",
   "requestTypenotes": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING"
}

Back to Top

Run Now By TaskId

This PUT service will run a scheduled task with the given Id.

Info

title	API URL

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

Parameters

...

 null
}

Run Now By TaskId

This PUT service will run a scheduled task with the given Id.

Info

title	API URL

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

Request

Attributes	Type	Required	Description
Id	Long	Yes	The Id of the scheduled task you wish to run
notes	String	No	This is a URL query parameter to add notes to the task when running it.

Include Page

	REST V1 Scheduled Task Response
	REST V1 Scheduled Task Response

Response Codes

HTTP Code	Description
200	Task was found and schedule set to run immediately
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	Task not found
500	Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

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

The PUT request would run the scheduled task and return the following JSON scheduled task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "APPROVED",
   }

...

"notes": "Approved by George"
}

Run Now using Query Parameters

...

Info

title	API 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}

Info

title	Returned Tasks

Only one scheduled task can be ran run 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 scheduled tasks.
folderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the scheduled tasks.
pipelineStageGateExecId	URL	No	This is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks.
pipelineStageStepExecId	URL	No	This is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks.
projectId	URL	No	This is a URL query parameter for the project Id which is used to search the scheduled tasks.
applicationId	URL	No	This is a URL query parameter for the project application Id which is used to search the scheduled tasks.
environmentId	URL	No	This is a URL query parameter for the environment Id which is used to search the scheduled the scheduled tasks.
applicationIdnotes	URL	No	This is a URL query parameter for the application Id which is used to search the scheduled tasks.	environmentId	URL	No	This is a URL query parameter for the environment Id which is used to search the scheduled tasks.to add notes to the task when running it.

Include Page

	REST V1 Scheduled Task Response
	REST V1 Scheduled Task Response

Response Codes

HTTP Code	Description
200	Task was found and schedule set to run immediately
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	Task not found
500	Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

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

The PUT request would run the scheduled task and return the following JSON scheduled task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "APPROVED",
   "notes": "Approved by "environmentId": 77954,
   "status": "APPROVED"
}

Back to Top

Cancel By TaskId

This PUT service will reject a scheduled task with the given Id.

Info

title	API URL

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

Parameters

...

George"
}

Cancel By TaskId

This PUT service will reject a scheduled task with the given Id.

Info

title	API URL

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

Request

Attributes	Type	Required	Description
Id	Long	Yes	The Id of the scheduled task you wish to cancel
notes	String	No	This is a URL query parameter to add notes to the task when canceling it.

Include Page

	REST V1 Scheduled Task Response
	REST V1 Scheduled Task Response

Response Codes

HTTP Code	Description
200	Task was found and cancelled
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	Task not found
500	Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": 77954"PENDING",
   "statusnotes": "PENDING"null
}

When we run a PUT request at the following URL

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

The PUT request would cancel the scheduled task and return the following JSON scheduled task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "REJECTED",
  }

...

 "notes": null
}

Cancel using Query Parameters

...

Info

title	API 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}

Info

title	Returned Tasks

Only one scheduled task can be canceled 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 scheduled tasks.
folderRequestId	URL	No	This is a URL query parameter for the folder request Id which is used to search the scheduled tasks.
pipelineStageGateExecId	URL	No	This is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks.
pipelineStageStepExecId	URL	No	This is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks.
projectId	URL	No	This is a URL query parameter for the project project Id which is used to search the scheduled tasks.
applicationId	URL	No	This is a URL query parameter for the application Id which is used to search the scheduled tasks.
applicationIdenvironmentId	URL	No	This is a URL query parameter for the application environment Id which is used to search the scheduled tasks.
environmentIdnotes	URL	No	This is a URL query parameter for the environment Id which is used to search the scheduled tasks.to add notes to the task when canceling it.

Include Page

	REST V1 Scheduled Task Response
	REST V1 Scheduled Task Response

Response Codes

HTTP Code	Description
200	Task was found and cancelled
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
404	Task not found
500	Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

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

The PUT request would cancel the scheduled task and return the following JSON scheduled task object

Code Block

theme	Eclipse
title	Approval Task

{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 10002,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "REJECTED",
   }

...

"notes": "Approved by George"
}

Page Comparison

Versions Compared

Old Version 8

New Version Current

Key

Step Scheduled Task

Gate Scheduled Task

Application Scheduled Task

Project Scheduled Task

GET

GET by TaskId

Parameters

Example

GET

GET by TaskId

Request

Response Codes

Example

GET (Using Query Parameters)

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

Examples:

To return all of the scheduled tasks:

To search by project Id only:

Request

Response Codes

Example

Run Now By TaskId

Parameters

Run Now By TaskId

Request

Response Codes

Example

Run Now using Query Parameters

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

Request

Response Codes

Example

Cancel By TaskId

Parameters

Cancel By TaskId

Request

Response Codes

Example

Cancel using Query Parameters

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

Request

Response Codes

Example