Read Calendars
get
/calendar
Reads Calendar objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
Name,ObjectId
-
Filter(required): string
Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:Example:
ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'
-
OrderBy(required): string
OrderBy conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<Calendar>
Type:
array
Title:
Show Source
List<Calendar>
-
Array of:
object Calendar
Title:
Calendar
Calendar Entity
Nested Schema : Calendar
Type:
object
Title:
Calendar
Calendar Entity
Show Source
-
BaseCalendarObjectId: integer
(int32)
The unique ID of the global calendar to which this calendar is linked. Any changes to the global calendar are automatically propagated to this calendar.
-
CreateDate: string
(date-time)
The date this calendar was created.
-
CreateUser: string
The name of the user that created this calendar.
-
HolidayOrExceptions: object
HolidayOrExceptions
HolidayOrExceptions
-
HoursPerDay: number
(double)
The number of work hours per day. This conversion factor is used for displaying time units and durations in the user's selected display formats.
-
HoursPerMonth: number
(double)
The number of work hours per month. This conversion factor is used for displaying time units and durations in the user's selected display formats.
-
HoursPerWeek: number
(double)
The number of work hours per week. This conversion factor is used for displaying time units and durations in the user's selected display formats.
-
HoursPerYear: number
(double)
The number of work hours per year. This conversion factor is used for displaying time units and durations in the user's selected display formats.
-
IsBaseline: boolean
The boolean value indicating if this business object is related to a Project or Baseline
-
IsDefault: boolean
The flag that identifies the default global calendar (applies to global calendars only).
-
IsPersonal: boolean
The flag indicating if this calendar is a personal calendar (applies to resource calendars only).
-
IsTemplate: boolean
The boolean value indicating if this business object is related to a template Project.
-
LastUpdateDate: string
(date-time)
The date this calendar was last updated.
-
LastUpdateUser: string
The name of the user that last updated this calendar.
-
Name(required): string
The name of the calendar.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
ProjectId: string
The ID for the project for which this change request is associated.
-
ProjectObjectId: integer
(int32)
The unique ID of the associated project.
-
StandardWorkWeek: object
StandardWorkWeek
-
Type(required): string
The calendar type - either 'Global', 'Resource', or 'Project'. 'Global' calendars can be assigned to projects and resources. 'Resource' calendars can be assigned only to resources. 'Project' calendars are specific to projects.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.