DAdagucloud
dags

Get a business calendar

Changed on

Returns a calendar's file content, its problems, and the calendars and DAGs that depend on it. DAGs in workspaces the caller cannot see are not listed.

get/calendars/{name}

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

namestring required

Name of a business calendar: a built-in one, or the file <name>.yaml in paths.calendars_dir

name of the calendar

Query parameters

remoteNodestring

name of the remote node

Response

The calendar

namestring required

Name of a business calendar: a built-in one, or the file <name>.yaml in paths.calendars_dir

builtinboolean required

Whether the calendar is built in rather than a file

descriptionstring
throughstring date

Last date the calendar's holidays are maintained for

specstring required

The calendar file's content; empty for a built-in calendar

errorsstring[] required

Problems of the saved file, each starting with its [line:column] in the file when it has one

warningsstring[] required
includesstring[] required

Calendars whose holidays this calendar adds

includedBystring[] required

Calendars that add this calendar's holidays, directly or through other calendars

Changes