1 of 1

Schedule

This endpoint is used to create, update, search or delete schedules for a particular workspace inside an organization, this is useful when you need to create schedule task or running jobs in a particular time.

Entity fields:

Path

Type

Description

To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.

Example:

{
  "data": {
    "type": "schedule",
    "attributes": {
      "cron": "0 0/1 * * * ?",
      "tcl": "{{templateSample}}"
    }
  }
}

Supported Operations

For a complete list of organization operation please visit the OpenAPI specification

Schedule

Entity fields:

Path

Type

Description

To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.

Example:

{
  "data": {
    "type": "schedule",
    "attributes": {
      "cron": "0 0/1 * * * ?",
      "tcl": "{{templateSample}}"
    }
  }
}

Supported Operations

Returns an instance of type schedule

GET/api/v1/workspace/{workspaceId}/schedule/{scheduleId}

Path parameters

workspaceId*string

workspace Identifier

scheduleId*string

schedule Identifier

Query parameters

fields[schedule]array of enum

Selects the set of schedule fields that should be returned in the result.

itemsenum

createdBycreatedDatecrondescriptionenabledtclupdatedByupdatedDateworkspace

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

workspace

Response

Successful response

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

Creates an item of type schedule and adds it to schedule

POST/api/v1/workspace/{workspaceId}/schedule

Path parameters

workspaceId*string

workspace Identifier

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Response

Successful response

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Request

Response

Deletes an instance of type schedule

DELETE/api/v1/workspace/{workspaceId}/schedule/{scheduleId}

Path parameters

workspaceId*string

workspace Identifier

scheduleId*string

schedule Identifier

Response

Successful response

Request

Modifies an instance of type schedule

PATCH/api/v1/workspace/{workspaceId}/schedule/{scheduleId}

Path parameters

workspaceId*string

workspace Identifier

scheduleId*string

schedule Identifier

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Response

Successful response

Request

For a complete list of organization operation please visit the OpenAPI specification

Deletes an instance of type schedule

DELETE/api/v1/workspace/{workspaceId}/schedule/{scheduleId}

Path parameters

workspaceId*string

workspace Identifier

scheduleId*string

schedule Identifier

Response

Successful response

Request

Modifies an instance of type schedule

PATCH/api/v1/workspace/{workspaceId}/schedule/{scheduleId}

Path parameters

workspaceId*string

workspace Identifier

scheduleId*string

schedule Identifier

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Response

Successful response

Request

Creates an item of type schedule and adds it to schedule

POST/api/v1/workspace/{workspaceId}/schedule

Path parameters

workspaceId*string

workspace Identifier

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Response

Successful response

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

Request

Response

Returns an instance of type schedule

GET/api/v1/workspace/{workspaceId}/schedule/{scheduleId}

Path parameters

workspaceId*string

workspace Identifier

scheduleId*string

schedule Identifier

Query parameters

fields[schedule]array of enum

Selects the set of schedule fields that should be returned in the result.

itemsenum

createdBycreatedDatecrondescriptionenabledtclupdatedByupdatedDateworkspace

includearray of enum

Selects the set of relationships that should be expanded as a compound document in the result.

itemsenum

workspace

Response

Successful response

Body

dataschedule (object)

typestring

idstring

attributesobject

createdBystring

createdDatestring (date-time)

cronstring

descriptionstring

enabledboolean

tclstring

updatedBystring

updatedDatestring (date-time)

relationshipsobject

workspaceobject

idstring

typeenum

workspace

includedarray of object

Included resources

attributesobject

idstring

relationshipsobject

typestring

Request

Response

const response = await fetch('/api/v1/workspace/{workspaceId}/schedule/{scheduleId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

const response = await fetch('/api/v1/workspace/{workspaceId}/schedule/{scheduleId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('/api/v1/workspace/{workspaceId}/schedule', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2024-11-24T00:44:48.373Z",
      "cron": "text",
      "description": "text",
      "enabled": false,
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2024-11-24T00:44:48.373Z"
    },
    "relationships": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  }
}

const response = await fetch('/api/v1/workspace/{workspaceId}/schedule/{scheduleId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": "text",
      "createdDate": "2024-11-24T00:44:48.373Z",
      "cron": "text",
      "description": "text",
      "enabled": false,
      "tcl": "text",
      "updatedBy": "text",
      "updatedDate": "2024-11-24T00:44:48.373Z"
    },
    "relationships": {
      "workspace": {
        "id": "text",
        "type": "workspace"
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}