Create a workspace schedule :: TigerGraph Savanna

Creates a recurring workspace schedule.

POST /controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules

Authorizations

x-api-key string header required

Authorization for TigerGraph Savanna. Send the key in the x-api-key request header.

Create an API key

Path parameters

# workgroupID string path required

Workgroup ID

# workspaceID string path required

Workspace ID

Body

# date string

Date the action runs when the schedule does not repeat.

# id string

Unique identifier of the schedule.

# repeat string required

How often the action repeats: daily, weekly, or weekdays.

# repeat_on string

Days the action runs when it repeats weekly.

# time string required

Time of day the action runs.

# timezone string required

Time zone the schedule is interpreted in.

# workspace_id string required

Unique identifier of the scheduled workspace.

# workspace_type_name string

Workspace size to apply when the action runs.

Response

application/json

# Error boolean

Indicates whether the request returned an error.

# ErrorDetails object[]

Details about each error returned by the request.

Show child attributes Hide child attributes

FieldNamestring

Field associated with the error.

Reasonstring

Explanation of why the error occurred.

Typestring

Category of the error.

Available options: Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown

# Message string

Human-readable summary of the request result.

# RequestID string

Unique identifier for tracing the request.

# Result object

Payload returned by the request.

Show child attributes Hide child attributes

datestring

Date the action runs when the schedule does not repeat.

idstring

Unique identifier of the schedule.

repeatstringrequired

How often the action repeats: daily, weekly, or weekdays.

repeat_onstring

Days the action runs when it repeats weekly.

timestringrequired

Time of day the action runs.

timezonestringrequired

Time zone the schedule is interpreted in.

workspace_idstringrequired

Unique identifier of the scheduled workspace.

workspace_type_namestring

Workspace size to apply when the action runs.

Create a workspace schedule

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "<string>",
    "id": "<string>",
    "repeat": "<string>",
    "repeat_on": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "workspace_id": "<string>",
    "workspace_type_name": "<string>"
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "date": "<string>",
  "id": "<string>",
  "repeat": "<string>",
  "repeat_on": "<string>",
  "time": "<string>",
  "timezone": "<string>",
  "workspace_id": "<string>",
  "workspace_type_name": "<string>"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules",
  {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "date": "<string>",
      "id": "<string>",
      "repeat": "<string>",
      "repeat_on": "<string>",
      "time": "<string>",
      "timezone": "<string>",
      "workspace_id": "<string>",
      "workspace_type_name": "<string>"
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>",
  "Content-Type: application/json"
]);
curl_setopt($request, CURLOPT_POSTFIELDS, '{
    "date": "<string>",
    "id": "<string>",
    "repeat": "<string>",
    "repeat_on": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "workspace_id": "<string>",
    "workspace_type_name": "<string>"
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "date": "<string>",
    "id": "<string>",
    "repeat": "<string>",
    "repeat_on": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "workspace_id": "<string>",
    "workspace_type_name": "<string>"
  }`)

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules",
  payload,
)
request.Header.Add("x-api-key", "<your-api-key>")
request.Header.Add("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("POST", HttpRequest.BodyPublishers.ofString("""
{
      "date": "<string>",
      "id": "<string>",
      "repeat": "<string>",
      "repeat_on": "<string>",
      "time": "<string>",
      "timezone": "<string>",
      "workspace_id": "<string>",
      "workspace_type_name": "<string>"
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules"
)
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "date": "<string>",
    "id": "<string>",
    "repeat": "<string>",
    "repeat_on": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "workspace_id": "<string>",
    "workspace_type_name": "<string>"
  }
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "Error": false,
  "ErrorDetails": [],
  "Message": "<string>",
  "RequestID": "<string>",
  "Result": {
    "date": "<string>",
    "id": "<string>",
    "repeat": "<string>",
    "repeat_on": "<string>",
    "time": "<string>",
    "timezone": "<string>",
    "workspace_id": "<string>",
    "workspace_type_name": "<string>"
  }
}

{
  "Error": true,
  "ErrorDetails": [
    {
      "FieldName": "<string>",
      "Reason": "<string>",
      "Type": "Internal-Error"
    }
  ],
  "Message": "<string>",
  "RequestID": "<string>"
}

{
  "Error": true,
  "ErrorDetails": [
    {
      "FieldName": "<string>",
      "Reason": "<string>",
      "Type": "Internal-Error"
    }
  ],
  "Message": "<string>",
  "RequestID": "<string>"
}