Document toolboxDocument toolbox

TimeConstraints Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 18, 2024 by Jason Andrew

Specifies one or more time constraints.

On this page:

TimeConstraints Object Formats

JSON Format 
{
	"ID": "",
	"Desc": "",
	"Type": "",
	"Period": {
		"Start": "",
		"End": ""
	},
	"Delete": false
}

TimeConstraints Object Properties

(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 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