Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space MOBUD and version 3

Specifies one or more time constraints.

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

TimeConstraints Object Formats

Include Page
_TimeConstraints Formats
_TimeConstraints Formats

TimeConstraints Object Properties

(info)(info) Required properties are in bold.

PropertyTypeDescription
IDstring

Optional property.

This property uniquely identifies the time constraint object.

3.19.1

DescstringA human readable description of the time constraint
Typestring

Specifies the type of time constraint. The types are configured with the TimeConstraint Time Constraints system category.

Periodobject

Specifies one or more fixed time periods.

PropertyTypeDescription
StartstringThe start of the time period. This is a UTC date in ISO-8601 format YYYY-MM-DD'T'HH:mm:SS.sss'Z'
EndstringThe end of the time period. This is a UTC date in ISO-8601 format YYYY-MM-DD'T'HH:mm:SS.sss'Z'
Delete

 

boolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.

3.19.1