A day on the time schedule (workday)

Table of Contents

Description
Limitations
Fields
- Intraday schedule list item
See also
- API
- Logical roles

Description

Determines the work schedule for a particular day.
It is used when building a schedule and correlating the activity of a number of entities and resulting processes to it.

Limitations

The collection is available in any domain.

Fields

Entity structure

{
  "id": uuid,
  "date": date,
  "isannual": intbool,
  "isworkday": int,
  "asdow": int,
  "periods": array<object>,
  "opts": {
    "title": str,
    "comment": str,
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}

Description of the specification’s characteristics

Table 1. Fields
Specification	Description
Field: `id` Mode: `inout` Type: `uuid` Default: generated	Identifier. Can be specified at creation, otherwise generated by the system.
Field: `date` Mode: `in` Type: `date` Default: required	Date. Format `"YYYY-MM-DD"`.
Field: `isannual` Mode: `in` Type: `intbool` Default: `0`	Indication of annual application. `1` – regardless of the year specified in the date, the day will apply each year. `0` – applies on a particular date.
Field: `isworkday` Mode: `in` Type: `intbool` Default: `0`	Indication `0` – of the weekend, `1` – of the workday, `2` – of the workday on an individualized schedule.
Field: `asdow` Mode: `in` Type: `int` Default: `0`	The day of the week for which the schedule of the customized date is replaced. `0` – there is no change in the day of the week, `1` – for Friday, 7 for Sunday
Field: `periods` Mode: `in` Type: `array<object>` Default: empty	Activity interval during the week. Each item in the list covers a specific segment within the day. Based on the aggregate of these segments, an overall schedule is generated. Intraday schedule list item.
Field: `opts` Mode: `in` Type: `object` Composite field
Field: `opts.title` Mode: `in` Type: `str` Default: empty	Arbitrary header
Field: `opts.comment` Mode: `in` Type: `str` Default: empty	Arbitrary comment
Field: `ext` Mode: `inout` Type: `object` Compound field	Allows you to extend the compound with arbitrary keys and values
Field: `ext.ct` Mode: `out` Type: `date` Default: generated	Object creation time
Field: `ext.lwt` Mode: `out` Type: `date` Default: generated	Time of last modification of the object

Intraday schedule list item

Table 2. Intraday schedule list item
Field	Value	Description
`timestart`	`0` – `1440`	Intraday segment start time in minutes
`timestop`	`0` – `1440`	Intraday segment end time in minutes

A day on the time schedule (workday)

Description

Limitations

Fields

Intraday schedule list item

See also

API

Logical roles