Run job schedules

Immediately runs the specified job schedules on the peer.

This topic includes the following sections:

Request

HTTP method: POST

Request URL: https://<hostname>:<port>/baocdp/rest/schedule/run

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

Request body properties

Property	Type	Required	Description	Values	Default value
name	String	Yes	Schedule name	User-provided value	NA
processName	String	Yes	Fully qualified process name	User-provided value	NA

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 schedules are run.

Response body properties

Property	Description
response	Status of the request

Example response JSON

{
"response":"Success"
}

Status codes and messages

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

HTTP code	Message	Description
202	ACCEPTED	Request succeeded
400		Bad request An error occurred while adding the schedule.
401		Unauthorized
405		Method not allowed