Batch Update Calendars
put
/api/restapi/calendar/batch
Send a request to this endpoint to update one or more calendars. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityCalendarInput>
Type:
array
Title:
Show Source
List<ApiEntityCalendarInput>
-
Array of:
object ApiEntityCalendarInput
Title:
ApiEntityCalendarInput
This entity represents a Calendar object, a unique Calendar object can be identified by the following combinations of the fields.- calendarId
- calendarCode,workspaceId
- calendarCode,workspaceCode
- calendarCode,projectId
- calendarCode,projectCode,workspaceCode
- calendarCode,projectCode,workspaceId
Nested Schema : ApiEntityCalendarInput
Type:
object
Title:
ApiEntityCalendarInput
This entity represents a Calendar object, a unique Calendar object can be identified by the following combinations of the fields.
Show Source
- calendarId
- calendarCode,workspaceId
- calendarCode,workspaceCode
- calendarCode,projectId
- calendarCode,projectCode,workspaceCode
- calendarCode,projectCode,workspaceId
-
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(required): 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.
-
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. -
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(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
-
workTimeFriday(required): 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(required): 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(required): 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(required): 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(required): 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(required): 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(required): 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 ApiEntityCalendarExceptionInput
Title:
ApiEntityCalendarExceptionInput
Nested Schema : ApiEntityCalendarExceptionInput
Type:
object
Title:
Show Source
ApiEntityCalendarExceptionInput
-
calendarExceptionId: integer
(int64)
The unique identifier for the calendar exception.
-
calendarId(required): integer
(int64)
The unique identifier for the calendar.
-
exceptionDate(required): 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. -
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
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request.