Oracle Prime Cloud Release 16

Returns the calendar specified by the calendar code.

get

/primeapi/restapi/v16.2/calendar/code/{code}

Path Parameters

Supported Media Types

200 Response

successful operation

Body

Root Schema : ApiEntityCalendar

Type: object

calendarCode: Type: string

The unique code for the calendar.
calendarExceptions: Type: array calendarExceptions

Unique Items Required: true
calendarId: Type: integer (int64)

The unique identifier for the calendar.
calendarName: Type: string

The name of the calendar.
dayHourCount: Type: number (double)
holiday: Type: integer (int64)

The holiday list assigned to the calendar.
holidayMoveType: Type: string

Allowed Values: [ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ]

ENUM
isAssignableToProject: Type: boolean

Default Value: false
isAssignableToResource: Type: boolean

Default Value: false
monthHourCount: Type: number (double)
weekHourCount: Type: number (double)
workspaceId: Type: integer (int64)

The unique identifier for the workspace for which the calendar belongs.
workTimeFriday: Type: string
workTimeMonday: Type: string
workTimeSaturday: Type: string
workTimeSunday: Type: string
workTimeThursday: Type: string
workTimeTuesday: Type: string
workTimeWednesday: Type: string
yearHourCount: Type: number (double)

Nested Schema : calendarExceptions

Type: array

Unique Items Required: true

Nested Schema : ApiEntityCalendarException

Type: object

calendar: Type: integer (int64)

The unique identifier for the calendar.
calendarExceptionId: Type: integer (int64)

The unique identifier for the calendar exception.
exceptionDate: Type: 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: Type: string

The name of the exception for the calendar.
workTime: Type: string

Work time that is non-standard.

404 Response

Calendar does not exist or you do not have access to it.