Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 3.34 KB

File metadata and controls

109 lines (72 loc) · 3.34 KB

ScheduleVersion

Method HTTP request Release Stage
get GET /v2/orchestration/scheduleVersions/{scheduleVersionRid} Public Beta
schedule GET /v2/orchestration/scheduleVersions/{scheduleVersionRid}/schedule Public Beta

get

Get the ScheduleVersion with the specified rid.

Parameters

Name Type Description Notes
schedule_version_rid ScheduleVersionRid The RID of a schedule version
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

ScheduleVersion

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ScheduleVersionRid | The RID of a schedule version
schedule_version_rid = "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.orchestration.ScheduleVersion.get(schedule_version_rid, preview=preview)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling ScheduleVersion.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ScheduleVersion application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

schedule

Parameters

Name Type Description Notes
schedule_version_rid ScheduleVersionRid The RID of a schedule version
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

Optional[Schedule]

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ScheduleVersionRid | The RID of a schedule version
schedule_version_rid = "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.orchestration.ScheduleVersion.schedule(
        schedule_version_rid, preview=preview
    )
    print("The schedule response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling ScheduleVersion.schedule: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Optional[Schedule] application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]