Jump to

• Request
• Response

Get Details

get

/calendars/{calendarGid}/details

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.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/calendars.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

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

Show Source

• Array of: object links

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

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"
        }
    }
}

Back to Top