Skip to main content
REST API reference
A newer release of this product is available.

Retrieve schedules

PDFs

GET /cluster/schedules

Introduced In: 9.6

Retrieves a schedule.

Parameters

Name Type In Required Description

cron.minutes

integer

query

False

Filter by cron.minutes

  • Max value: 59

  • Min value: 0

cron.days

integer

query

False

Filter by cron.days

  • Max value: 31

  • Min value: 1

cron.hours

integer

query

False

Filter by cron.hours

  • Max value: 23

  • Min value: 0

cron.weekdays

integer

query

False

Filter by cron.weekdays

  • Max value: 6

  • Min value: 0

cron.months

integer

query

False

Filter by cron.months

  • Max value: 12

  • Min value: 1

name

string

query

False

Filter by name

  • maxLength: 256

  • minLength: 1

interval

string

query

False

Filter by interval

type

string

query

False

Filter by type

uuid

string

query

False

Filter by uuid

svm.uuid

string

query

False

Filter by svm.uuid

  • Introduced in: 9.10

svm.name

string

query

False

Filter by svm.name

  • Introduced in: 9.10

cluster.name

string

query

False

Filter by cluster.name

cluster.uuid

string

query

False

Filter by cluster.uuid

scope

string

query

False

Filter by scope

  • Introduced in: 9.10

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 15

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[schedule]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "cluster": {
        "name": "cluster1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "cron": {
        "days": [
          "integer"
        ],
        "hours": [
          "integer"
        ],
        "minutes": [
          "integer"
        ],
        "months": [
          "integer"
        ],
        "weekdays": [
          "integer"
        ]
      },
      "interval": "P1DT2H3M4S",
      "name": "string",
      "scope": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "string",
      "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

459760

The schedule specified is not a valid schedule.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

cluster

The cluster that owns the schedule. Defaults to the local cluster.

Name Type Description

name

string

Cluster name

uuid

string

Cluster UUID

cron

Details for schedules of type cron.

Name Type Description

days

array[integer]

The days of the month the schedule runs. Leave empty for all.

hours

array[integer]

The hours of the day the schedule runs. Leave empty for all.

minutes

array[integer]

The minutes the schedule runs. Required on POST for a cron schedule.

months

array[integer]

The months of the year the schedule runs. Leave empty for all.

weekdays

array[integer]

The weekdays the schedule runs. Leave empty for all.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

schedule

Complete schedule information

Name Type Description

_links

_links

cluster

cluster

The cluster that owns the schedule. Defaults to the local cluster.

cron

cron

Details for schedules of type cron.

interval

string

An ISO-8601 duration formatted string.

name

string

Schedule name. Required in the URL or POST body.

scope

string

If the schedule is owned by a data SVM, then the scope is set to svm. Otherwise it will be set to cluster.

svm

svm

type

string

Schedule type

uuid

string

Job schedule UUID

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.