YQueue DocsDevelopers

Schema

Schedule Exception

The standardised representation of a schedule exception.

  • Foundation

Overview

object · 3 properties · 3 required

Properties

name

string Required

The exception's display name.

Example Christmas Day
Min length 1
Max length 255

start

string Required

The date-time that the exception "starts".

Format date-time
Pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

end

string Required

The date-time that the exception "ends".

Format date-time
Pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Used by

Raw YAML
Download source
title: Schedule Exception
x-tags:
  - Foundation
type: object
description: The standardised representation of a schedule exception.
properties:
  name:
    type: string
    minLength: 1
    maxLength: 255
    example: Christmas Day
    description: The exception's display name.
  start:
    type: string
    format: date-time
    pattern: '^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$'
    description: The date-time that the exception "starts".
  end:
    type: string
    description: The date-time that the exception "ends".
    format: date-time
    pattern: '^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$'
required:
  - name
  - start
  - end

Search documentation

Search across this documentation site.