Jump to

• Request
• Response

Get a Calendar

get

/calendars/{calendarGid}

Request

Path Parameters

• calendarGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : calendars

Type: object

Show Source

• calendarGid: string
  CALENDAR_GID is the unique identifier for a calendar.
• calendarName: string
  CALENDAR_NAME is text that describes the purpose of the calendar. Examples include: office hours, summer calendar, pickup, etc.
• calendarXid: string
  CALENDAR_XID is the unique external identifier for a calendar.
• daysInCycle: number (int32)
  DAYS_IN_CYLCE specifies the number of days for which this calendar is in effect.
• details: details
• domainName: string
  No description.
• holidayProfileGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• notes: string
  NOTES contains text that describes additional information about the calendar. Examples include: "ALL THE TIME," "CAL_ANNUAL," "OFFICE HOURS - 8AM TO 6PM," etc.
• startDate: startDate
  START_DATE contains the effective date of the calendar.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "calendarGid":{
            "description":"CALENDAR_GID is the unique identifier for a calendar.",
            "type":"string"
        },
        "calendarXid":{
            "description":"CALENDAR_XID is the unique external identifier for a calendar.",
            "type":"string"
        },
        "calendarName":{
            "description":"CALENDAR_NAME is text that describes the purpose of the calendar. Examples include: office hours, summer calendar, pickup, etc.",
            "type":"string"
        },
        "startDate":{
            "description":"START_DATE contains the effective date of the calendar.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "daysInCycle":{
            "description":"DAYS_IN_CYLCE specifies the number of days for which this calendar is in effect.",
            "type":"number",
            "format":"int32"
        },
        "holidayProfileGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "notes":{
            "description":"NOTES contains text that describes additional information about the calendar. Examples include: \"ALL THE TIME,\" \"CAL_ANNUAL,\" \"OFFICE HOURS - 8AM TO 6PM,\" etc.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/calendars.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/calendars.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : startDate

START_DATE contains the effective date of the calendar.

Match All

START_DATE contains the effective date of the calendar.

Show Source

• object dateTimeType

{
    "description":"START_DATE contains the effective date of the calendar.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object calendars.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/calendars.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : calendars.details

Type: object

Show Source

• activityCalendarId: number (int64)
  ACTIVITY_CALENDAR_ID is the system-generated unique ID for ACTIVITY_CALENDAR. (IDs are internal system indexes; therefore, they are usually not recognizable to users.)
• activityGid: string
  ACTIVITY_GID is the unique identifier of an activity. This entry defines an activity with the time(s) when that activity can occur.
• activityTimeFactor: number (double)
  Acitivity factor provides a multiplication factor for the activity.
• begin: number (int64)
  BEGIN contains the time when an activity can start.
• domainName: string
  No description.
• duration: number (int64)
  DURATION contains the length of time an activity can take place.
• isWorkOn: boolean
  IS_WORK_ON is a flag describing whether a specific activity calendar is active. (Valid values are Y for yes (the calendar is active) or N for no (the calendar is not active).
• links: array links
  Read Only: true

{
    "properties":{
        "activityCalendarId":{
            "description":"ACTIVITY_CALENDAR_ID is the system-generated unique ID for ACTIVITY_CALENDAR. (IDs are internal system indexes; therefore, they are usually not recognizable to users.)",
            "type":"number",
            "format":"int64"
        },
        "activityGid":{
            "description":"ACTIVITY_GID is the unique identifier of an activity. This entry defines an activity with the time(s) when that activity can occur.",
            "type":"string"
        },
        "isWorkOn":{
            "description":"IS_WORK_ON is a flag describing whether a specific activity calendar is active. (Valid values are Y for yes (the calendar is active) or N for no (the calendar is not active).",
            "type":"boolean"
        },
        "begin":{
            "description":"BEGIN contains the time when an activity can start.",
            "type":"number",
            "format":"int64"
        },
        "duration":{
            "description":"DURATION contains the length of time an activity can take place.",
            "type":"number",
            "format":"int64"
        },
        "activityTimeFactor":{
            "description":"Acitivity factor provides a multiplication factor for the activity.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top