DAdagucloud
dags

Preview a business calendar

Changed on

Checks unsaved calendar content and describes each date of a year under it, marking the dates that differ from the saved calendar. A built-in calendar is described as it is.

post/calendars/{name}/preview

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

Request body

specstring required

Unsaved calendar file content; ignored for a built-in calendar

yearinteger required

Year whose dates are described

Response

The preview

errorsstring[] required

Problems of the content, each starting with its [line:column] when it has one. The dates use the valid parts.

warningsstring[] required
yearinteger required
todaystring date required

Today in the server's time zone

throughstring date

Last date the content's holidays are maintained for

Changes