Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Affected Resources Schedule

POST/api/v2/orchestration/schedules/{scheduleRid}/getAffectedResources
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-read.

Path parameters

scheduleRid
string

The RID of a Schedule.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

AffectedResourcesResponse
object
Hide child attributes

Hide child attributes

datasets
list<BuildableRid>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl -X POST \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/orchestration/schedules/ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871/getAffectedResources?preview=true"

Error responses

Error Name
GetAffectedResourcesSchedulePermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not getAffectedResources the Schedule.
ParametersscheduleRid