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
data.type	string	Should be "template"
data.attributes.cron	string	Cron expression to schedule a job inside a workspace. For more information please visit Quartz documentation.
data.attributes.tcl	string	Terrakube configuration language in base64
data.attributes.templateReference	string	Terrakube template id

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

get

Returns the relationship schedule

Path parameters

workspaceIdstringRequired

workspace Identifier

Query parameters

filter[schedule]stringOptional

Filters the collection of schedule using a 'disjoint' RSQL expression

page[number]integer · int32Optional

Number of pages to return. Can be used with page[size]

page[size]integer · int32Optional

Number of elements per page. Can be used with page[number]

page[offset]integer · int32Optional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer · int32Optional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses

200

Successful response

application/vnd.api+json

get

/workspace/{workspaceId}/schedule

HTTPcURLJavaScriptPython

GET /api/v1/workspace/{workspaceId}/schedule HTTP/1.1
Accept: */*

200

Successful response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "createdBy": null,
        "createdDate": null,
        "cron": null,
        "description": null,
        "enabled": null,
        "tcl": null,
        "templateReference": null,
        "updatedBy": null,
        "updatedDate": null
      },
      "relationships": {
        "workspace": {
          "data": [
            null
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

post

Creates an item of type schedule and adds it to schedule

Path parameters

workspaceIdstringRequired

workspace Identifier

Body

application/vnd.api+json

Responses

201

Successful response

application/vnd.api+json

post

/workspace/{workspaceId}/schedule

HTTPcURLJavaScriptPython

POST /api/v1/workspace/{workspaceId}/schedule HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 327

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": null,
      "createdDate": null,
      "cron": null,
      "description": null,
      "enabled": null,
      "tcl": null,
      "templateReference": null,
      "updatedBy": null,
      "updatedDate": null
    },
    "relationships": {
      "workspace": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": null,
      "createdDate": null,
      "cron": null,
      "description": null,
      "enabled": null,
      "tcl": null,
      "templateReference": null,
      "updatedBy": null,
      "updatedDate": null
    },
    "relationships": {
      "workspace": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

delete

Deletes an instance of type schedule

Path parameters

workspaceIdstringRequired

workspace Identifier

scheduleIdstringRequired

schedule Identifier

Responses

204

Successful response

No content

delete

/workspace/{workspaceId}/schedule/{scheduleId}

HTTPcURLJavaScriptPython

DELETE /api/v1/workspace/{workspaceId}/schedule/{scheduleId} HTTP/1.1
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type schedule

Path parameters

workspaceIdstringRequired

workspace Identifier

scheduleIdstringRequired

schedule Identifier

Body

application/vnd.api+json

Responses

204

Successful response

No content

patch

/workspace/{workspaceId}/schedule/{scheduleId}

HTTPcURLJavaScriptPython

PATCH /api/v1/workspace/{workspaceId}/schedule/{scheduleId} HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 327

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": null,
      "createdDate": null,
      "cron": null,
      "description": null,
      "enabled": null,
      "tcl": null,
      "templateReference": null,
      "updatedBy": null,
      "updatedDate": null
    },
    "relationships": {
      "workspace": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

204

Successful response

No content

get

Returns an instance of type schedule

Path parameters

workspaceIdstringRequired

workspace Identifier

scheduleIdstringRequired

schedule Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get

/workspace/{workspaceId}/schedule/{scheduleId}

HTTPcURLJavaScriptPython

GET /api/v1/workspace/{workspaceId}/schedule/{scheduleId} HTTP/1.1
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "createdBy": null,
      "createdDate": null,
      "cron": null,
      "description": null,
      "enabled": null,
      "tcl": null,
      "templateReference": null,
      "updatedBy": null,
      "updatedDate": null
    },
    "relationships": {
      "workspace": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}

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