View Calendars by Project and Workspace Code
get
/api/restapi/calendar/project/code
Send a request to this endpoint to view all project specific calendars under a project identified by the provided codes.
Request
Query Parameters
-
projectCode(required): string
The user-specified identifier of a project.
This is a required field. -
workspaceCode(required): string
Workspace code of the calendar to be found.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityCalendar>
Type:
array
Title:
Show Source
List<ApiEntityCalendar>
-
Array of:
object ApiEntityCalendar
Title:
ApiEntityCalendar
Nested Schema : ApiEntityCalendar
Type:
object
Title:
Show Source
ApiEntityCalendar
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the calendar and the workspace. Possible values are Owned and Inherited. -
calendarCode: string
Minimum Length:
0
Maximum Length:255
The unique code for the calendar. -
calendarExceptions: array
calendarExceptions
Defines exceptions to the specified calendar.
-
calendarId: integer
(int64)
The unique identifier for the calendar.
-
calendarName: string
Minimum Length:
0
Maximum Length:255
The name of the calendar. -
dayHourCount: number
(double)
The number of hours in a day.
-
holiday: integer
(int64)
The holiday list assigned to the calendar.
-
holidayMoveType: string
Allowed Values:
[ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ]
Specifies a holiday within calendar work time. -
isAssignableToProject: boolean
Indicates whether or not the calendar can be assigned to a project.
-
isAssignableToResource: boolean
Indicates whether or not the calendar can be assigned to a resource.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
monthHourCount: number
(double)
The number of hours in a month.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
Specifies how a workspace calendar is shared across child workspaces. -
updateDate: string
(date-time)
Date when the record was last updated.
-
weekHourCount: number
(double)
The number of hours in a week.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
-
workTimeFriday: string
Maximum Length:
48
The working time for Friday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
workTimeMonday: string
Maximum Length:
48
The working time for Monday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
workTimeSaturday: string
Maximum Length:
48
The working time for Saturday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
workTimeSunday: string
Maximum Length:
48
The working time for Sunday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
workTimeThursday: string
Maximum Length:
48
The working time for Thursday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
workTimeTuesday: string
Maximum Length:
48
The working time for Tuesday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
workTimeWednesday: string
Maximum Length:
48
The working time for Wednesday. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000 -
yearHourCount: number
(double)
The number of hours in a year.
Nested Schema : calendarExceptions
Type:
array
Defines exceptions to the specified calendar.
Show Source
-
Array of:
object ApiEntityCalendarException
Title:
ApiEntityCalendarException
Nested Schema : ApiEntityCalendarException
Type:
object
Title:
Show Source
ApiEntityCalendarException
-
calendarCode: string
Minimum Length:
0
Maximum Length:255
The unique code for the calendar. -
calendarExceptionId: integer
(int64)
The unique identifier for the calendar exception.
-
calendarId: integer
(int64)
The unique identifier for the calendar.
-
exceptionDate: string
(date-time)
The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.
-
exceptionName: string
Maximum Length:
60
The name of the exception for the calendar. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workTime: string
Maximum Length:
4000
Work time that is non-standard. The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters. For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. 000000000000000000111111111111111100000000000000
204 Response
Successful operation with no content.
404 Response
The requested calendar does not exist, or you do not have access to it.