TimeRangeObject
Description
An object that represents a time interval. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
- addTimeRangeObject
- getTimeRangeObjectList
- getTimeRangeObject
- deleteTimeRangeObject
- editTimeRangeObject
- upsertTimeRangeObject
Model Properties
| Property | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| version | False | string | A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected. | |||
| name | True | string | The name of the object. | |||
| description | False | string | An optional description of the object. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| effectiveStartDateTime | False | string | Optional Field.If Specified, defines the date and time on which the time range should become effective. Prior to date and time, the time range object will not be effective, and any policy in which you use the object will act as if there are no time period restrictions. Specify the date and time in YYYY-MM-DDTHH:MM format.To indicate that the time range should start immediately,don't pass the field. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| effectiveEndDateTime | False | string | Optional Field.The date and time on which the time range should no longer apply. After this date and time passes, the time range object will not be effective, and any policy in which you use the object will henceforth act as if there are no time period restrictions. Specify the date and time in YYYY-MM-DDTHH:MM format.To indicate that the time range should should never end,don't pass the field. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| recurrenceList | False | [object] | list of mutliple recurring Interval Object of type DAILY_INTERVAL Or RANGE | |||
| timeRangeObjectId | False | integer | A unique Id assigned to each TimeRangeObject | |||
| id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | |||