Resource Object


A resource represents an entity that can be scheduled for use, such as a room or a staff member. The availability of a resource is tracked to ensure that it can be allocated at a requested time slot and to prevent double bookings. Read more about resources in this article.

Properties
idstringRead-onlyformat GUID

Resource ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the resource is updated. To prevent conflicting changes, the current revision must be passed when updating the resource.


createdDatestringRead-onlyformat date-time

Represents the time in YYYY-MM-DDThh:mm:ss.sssZ format this resource was created.


updatedDatestringRead-onlyformat date-time

Represents the time in YYYY-MM-DDThh:mm:ss.sssZ format this resource was last updated.


namestringmaxLength 40minLength 1

Name of the resource.


typeIdstringformat GUID

ID of the resource type.

Once a type has been set it can't be modified. You can create a resource without specifying a type. However, such resources cannot be booked.


workingHoursSchedulesWorkingHoursSchedules

Schedule details that specify the working hours and locations of this resource.

Resources without this field are available 24/7 at the locations specified in the field locationOptions. When both workingHoursSchedules and locationOptions are set then workingHoursSchedules takes precedence.


locationOptionsLocationOptions

Location details that specify where this resource is available.


eventsScheduleEventsScheduleRead-only

This schedule contains the sessions in which this resource has been booked.


extendedFieldsExtendedFields

Extensions enabling users to save custom data related to the resource.

Did this help?