Delete job schedules

Removes the specified job schedules from the peer. 

This topic includes the following sections:

Request

HTTP method: DELETE

Request URL: Use of of the following URLs.

  • To delete schedule/s specified in the body

    https://<hostname>:<port>/baocdp/rest/schedule
  • To delete schedule/s for a specified module or by schedule name

    https://<hostname>:<port>/baocdp/rest/<modulename>?scheduleName=<schedulename>

    If no schedule name is specified, all schedules added for the specified module are deleted. 

Header: See HTTP request and response headers for header information, such as required authentication token.

Request body properties

PropertyTypeRequiredDescriptionValuesDefault value

name

StringYes

Schedule name

User-provided valueNA
processNameStringYesFully qualified process nameUser-provided valueNA

Example request JSON

{
   "schedules": [
      {
         "name": "Read files",
         "processName": ":AutoPilot-AD-Utilities:Terminal:File:Read"
      },
      {
         "name": "Get activated modules",
         "processName": ":AutoPilot-OA-BAOGridManagement:Module:Get All Activated Modules"
      }
   ]
}

Response

If successful, the specified scheduled jobs are removed from the peer.

Response body properties

PropertyDescription
responseStatus of the request

Example response JSON

{
  "response":"Success"
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP codeDescription
204Request succeeded
400

Bad request

An error occurred while deleting the schedules.

401Unauthorized
403

Forbidden

The client is not permitted to access the resource

500Internal Server Error

Related topics

HTTP request and response headers

Format of API examples

Get job schedules

Was this page helpful? Yes No Submitting... Thank you

Comments