TabGeckoPOST
/api/v1/automation/schedule/preview
Calculate the next five start times for an RPA schedule
Request#
POSIX shell · curl
curl --fail-with-body --request POST \
"$ADBR_API_URL/api/v1/automation/schedule/preview" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonUse the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.
Authentication and permissions#
Authentication: Bearer token
Scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.
Parameters#
No path or query parameters declared.
Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
next_at | integer | Yes | |
interval_minutes | integer | Yes | |
time_zone | string | No | |
remaining_runs | integer | No | |
end_at | integer | No | |
revision | string | No | |
calendar | object | No |
Complete body schema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"next_at",
"interval_minutes"
],
"properties": {
"next_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"interval_minutes": {
"type": "integer",
"minimum": 0,
"maximum": 525600
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"remaining_runs": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"end_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"calendar": {
"type": "object",
"required": [
"frequency",
"start_date",
"time"
],
"properties": {
"frequency": {
"anyOf": [
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
},
{
"type": "string",
"enum": [
"monthly"
]
},
{
"type": "string",
"enum": [
"yearly"
]
}
]
},
"start_date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"time": {
"type": "string",
"pattern": "^[0-9]{2}:[0-9]{2}$"
},
"weekdays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"month_day": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 31
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
}Responses#
200 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"time_zone",
"next_at",
"starts"
],
"properties": {
"time_zone": {
"type": "string"
},
"next_at": {
"type": "integer"
},
"starts": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
}default · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}General authentication and transport errors may occur in addition to the documented responses.
OpenAPI definition#
Complete operation definition
OpenAPI JSON
{
"summary": "Die nächsten fünf Startzeiten eines RPA-Zeitplans berechnen",
"tags": [
"Automation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"next_at",
"interval_minutes"
],
"properties": {
"next_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"interval_minutes": {
"type": "integer",
"minimum": 0,
"maximum": 525600
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"remaining_runs": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"end_at": {
"type": "integer",
"minimum": 0,
"maximum": 253402300799999
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"calendar": {
"type": "object",
"required": [
"frequency",
"start_date",
"time"
],
"properties": {
"frequency": {
"anyOf": [
{
"type": "string",
"enum": [
"daily"
]
},
{
"type": "string",
"enum": [
"weekly"
]
},
{
"type": "string",
"enum": [
"monthly"
]
},
{
"type": "string",
"enum": [
"yearly"
]
}
]
},
"start_date": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"time": {
"type": "string",
"pattern": "^[0-9]{2}:[0-9]{2}$"
},
"weekdays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"minItems": 1,
"maxItems": 7,
"uniqueItems": true
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"month_day": {
"anyOf": [
{
"type": "number",
"enum": [
-1
]
},
{
"type": "integer",
"minimum": 1,
"maximum": 31
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"time_zone",
"next_at",
"starts"
],
"properties": {
"time_zone": {
"type": "string"
},
"next_at": {
"type": "integer"
},
"starts": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}