This is an archive version of the document. To get the most up-to-date information, see the current version.Schedule Plan to Run at Specific Time
You can create a schedule for a plan with the specified ID to run at a specific time.
Request
To schedule execution of a plan at a specific time, send the startTime parameter in the HTTP PUT request to the /Plans/{planId}/Schedule/SaveTime endpoint.
Parameter | Type | Description |
|---|---|---|
startTime | boolean | Exact date and time when a plan will run. |
HTTP Request
PUT https://<hostname>:<port>/api/v3/Plans/{planId}/Schedule/SaveTime?startTime |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns 200 response code.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Example
The following example configures a schedule for a plan with the ID be0d799a-cd89-4fd5-b612-5973384a6704 to run on July,12th, 2020 at 11 AM.
|