Jump to

• Request
• Response

Create a calendar

post

/fscmRestApi/resources/11.13.18.05/hedCalendars

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the calendar is active. The default value is N.
• CalendarCode(required): string
  Title: Calendar Code

  Maximum Length: 32

  The code of a calendar.
• CalendarEndDate(required): string (date)
  Title: End Date

  The date when a calendar ends.
• calendarEvents: array Calendar Events
  Title: Calendar Events

  Calendar events for a calendar, such as calendar events for an academic calendar.
• CalendarName(required): string
  Title: Calendar Name

  Maximum Length: 240

  The name of a calendar.
• CalendarStartDate(required): string (date)
  Title: Start Date

  The date when a calendar starts.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of a calendar.
• entityAssignments: array Entity Assignments
  Title: Entity Assignments

  Academic entities which have been assigned to calendars.
• SourceCalendarId: integer
  Title: Source Calendar ID

  The unique identifier of a source calendar.
• tagAssignments: array Calendar Tags
  Title: Calendar Tags

  Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

{
    "required":[
        "ActiveFlag",
        "CalendarCode",
        "CalendarEndDate",
        "CalendarName",
        "CalendarStartDate"
    ],
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Calendar Tags",
            "type":"array",
            "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-post-request"
            }
        },
        "calendarEvents":{
            "title":"Calendar Events",
            "type":"array",
            "description":"Calendar events for a calendar, such as calendar events for an academic calendar.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-calendarEvents-item-post-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of a calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCalendarId":{
            "title":"Source Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a source calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":32,
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false
        },
        "entityAssignments":{
            "title":"Entity Assignments",
            "type":"array",
            "description":"Academic entities which have been assigned to calendars.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-entityAssignments-item-post-request"
            }
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar.",
            "nullable":false
        },
        "CalendarStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar starts.",
            "format":"date",
            "nullable":false
        },
        "CalendarEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar ends.",
            "format":"date",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the calendar is active. The default value is N.",
            "nullable":false
        }
    }
}

Nested Schema : Calendar Events

Type: array

Title: Calendar Events

Calendar events for a calendar, such as calendar events for an academic calendar.

Show Source

• Array of: object hedCalendars-calendarEvents-item-post-request

{
    "title":"Calendar Events",
    "type":"array",
    "description":"Calendar events for a calendar, such as calendar events for an academic calendar.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-calendarEvents-item-post-request"
    }
}

Nested Schema : Entity Assignments

Type: array

Title: Entity Assignments

Academic entities which have been assigned to calendars.

Show Source

• Array of: object hedCalendars-entityAssignments-item-post-request

{
    "title":"Entity Assignments",
    "type":"array",
    "description":"Academic entities which have been assigned to calendars.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-entityAssignments-item-post-request"
    }
}

Nested Schema : Calendar Tags

Type: array

Title: Calendar Tags

Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

Show Source

• Array of: object schema

{
    "title":"Calendar Tags",
    "type":"array",
    "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-post-request"
    }
}

Nested Schema : hedCalendars-calendarEvents-item-post-request

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Indicates whether the calendar event is an all-day event.
• CalendarEventCode(required): string
  Title: Calendar Event Code

  Maximum Length: 30

  The code of the calendar event.
• CalendarEventDescription: string (byte)
  Title: Calendar Event Description

  The description of a calendar event.
• CalendarEventEndDate: string (date-time)
  Title: End Date

  The date when a calendar event ends.
• CalendarEventName(required): string
  Title: Calendar Event Name

  Maximum Length: 240

  The name of a calendar event.
• CalendarEventStartDate(required): string (date-time)
  Title: Start Date

  The date when a calendar event starts.
• calendarEventTagAssignments: array Calendar Event Tags
  Title: Calendar Event Tags

  Tag assignments of calendar events.
• Location: string
  Title: Location

  Maximum Length: 1000

  The location of the calendar event.

{
    "required":[
        "CalendarEventCode",
        "CalendarEventName",
        "CalendarEventStartDate"
    ],
    "type":"object",
    "properties":{
        "CalendarEventName":{
            "title":"Calendar Event Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar event.",
            "nullable":false
        },
        "CalendarEventStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar event starts.",
            "format":"date-time",
            "nullable":false
        },
        "CalendarEventEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar event ends.",
            "format":"date-time",
            "nullable":true
        },
        "calendarEventTagAssignments":{
            "title":"Calendar Event Tags",
            "type":"array",
            "description":"Tag assignments of calendar events.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-calendarEvents-calendarEventTagAssignments-item-post-request"
            }
        },
        "CalendarEventDescription":{
            "title":"Calendar Event Description",
            "type":"string",
            "description":"The description of a calendar event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarEventCode":{
            "title":"Calendar Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the calendar event.",
            "nullable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the calendar event is an all-day event.",
            "nullable":false,
            "default":false
        },
        "Location":{
            "title":"Location",
            "maxLength":1000,
            "type":"string",
            "description":"The location of the calendar event.",
            "nullable":true
        }
    }
}

Nested Schema : Calendar Event Tags

Type: array

Title: Calendar Event Tags

Tag assignments of calendar events.

Show Source

• Array of: object hedCalendars-calendarEvents-calendarEventTagAssignments-item-post-request

{
    "title":"Calendar Event Tags",
    "type":"array",
    "description":"Tag assignments of calendar events.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-calendarEvents-calendarEventTagAssignments-item-post-request"
    }
}

Nested Schema : hedCalendars-calendarEvents-calendarEventTagAssignments-item-post-request

Type: object

Show Source

• TagId: integer (int64)
  Title: Tag ID

  The identifier of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TagCode"
                ]
            }
        }
    }
}

Nested Schema : hedCalendars-entityAssignments-item-post-request

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the user during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the user during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AssignedEntityTypeCode"
                ]
            }
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AssignedEntityCode"
                ]
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code of the tag.
• TagId: integer (int64)
  Title: Tag ID

  The identifier of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedCalendars-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the calendar is active. The default value is N.
• CalendarCode: string
  Title: Calendar Code

  Maximum Length: 32

  The code of a calendar.
• CalendarCodeLockFlag: boolean
  Title: Calendar Code Lock Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether calendar code is editable.
• CalendarEndDate: string (date)
  Title: End Date

  The date when a calendar ends.
• calendarEvents: array Calendar Events
  Title: Calendar Events

  Calendar events for a calendar, such as calendar events for an academic calendar.
• CalendarId: integer (int64)
  Title: Calendar ID

  Read Only: true

  The unique identifier of a calendar.
• CalendarName: string
  Title: Calendar Name

  Maximum Length: 240

  The name of a calendar.
• CalendarStartDate: string (date)
  Title: Start Date

  The date when a calendar starts.
• CalendarTypeCode: string
  Title: Calendar Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_HEY_GENERAL

  The code of the calendar type.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of a calendar.
• entityAssignments: array Entity Assignments
  Title: Entity Assignments

  Academic entities which have been assigned to calendars.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the calendar was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceCalendarId: integer
  Title: Source Calendar ID

  The unique identifier of a source calendar.
• tagAssignments: array Calendar Tags
  Title: Calendar Tags

  Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.
• TimezoneCode: string
  Title: Time Zone Code

  Read Only: true

  Maximum Length: 50

  Time zone code selected by a user when specifying calendar start and end dates.
• TimezoneName: string
  Title: Time Zone Name

  Read Only: true

  Maximum Length: 80

  Time zone name selected by a user when specifying a date time.

{
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Calendar Tags",
            "type":"array",
            "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-response"
            }
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"Time zone code selected by a user when specifying calendar start and end dates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of a calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCalendarId":{
            "title":"Source Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a source calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarTypeCode":{
            "title":"Calendar Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the calendar type.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HEY_GENERAL",
            "x-queryable":true
        },
        "CalendarStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TimezoneName":{
            "title":"Time Zone Name",
            "maxLength":80,
            "type":"string",
            "description":"Time zone name selected by a user when specifying a date time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the calendar is active. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "calendarEvents":{
            "title":"Calendar Events",
            "type":"array",
            "description":"Calendar events for a calendar, such as calendar events for an academic calendar.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-calendarEvents-item-response"
            }
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":32,
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "entityAssignments":{
            "title":"Entity Assignments",
            "type":"array",
            "description":"Academic entities which have been assigned to calendars.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-entityAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalendarCodeLockFlag":{
            "title":"Calendar Code Lock Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether calendar code is editable.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the calendar was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Calendar Events

Type: array

Title: Calendar Events

Calendar events for a calendar, such as calendar events for an academic calendar.

Show Source

• Array of: object hedCalendars-calendarEvents-item-response

{
    "title":"Calendar Events",
    "type":"array",
    "description":"Calendar events for a calendar, such as calendar events for an academic calendar.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-calendarEvents-item-response"
    }
}

Nested Schema : Entity Assignments

Type: array

Title: Entity Assignments

Academic entities which have been assigned to calendars.

Show Source

• Array of: object hedCalendars-entityAssignments-item-response

{
    "title":"Entity Assignments",
    "type":"array",
    "description":"Academic entities which have been assigned to calendars.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-entityAssignments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Calendar Tags

Type: array

Title: Calendar Tags

Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

Show Source

• Array of: object hedCalendars-tagAssignments-item-response

{
    "title":"Calendar Tags",
    "type":"array",
    "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-response"
    }
}

Nested Schema : hedCalendars-calendarEvents-item-response

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Indicates whether the calendar event is an all-day event.
• CalendarEventCode: string
  Title: Calendar Event Code

  Maximum Length: 30

  The code of the calendar event.
• CalendarEventDescription: string (byte)
  Title: Calendar Event Description

  The description of a calendar event.
• CalendarEventEndDate: string (date-time)
  Title: End Date

  The date when a calendar event ends.
• CalendarEventId: integer (int64)
  Title: Calendar Event ID

  Read Only: true

  The unique identifier of a calendar event.
• CalendarEventName: string
  Title: Calendar Event Name

  Maximum Length: 240

  The name of a calendar event.
• CalendarEventStartDate: string (date-time)
  Title: Start Date

  The date when a calendar event starts.
• calendarEventTagAssignments: array Calendar Event Tags
  Title: Calendar Event Tags

  Tag assignments of calendar events.
• DisplayTimezoneCode: string
  Title: Time Zone Code

  Read Only: true

  Maximum Length: 50

  Default Value: UTC

  Time zone code selected by a user when specifying calendar start and end dates.
• DisplayTimezoneName: string
  Title: Time Zone Name

  Read Only: true

  Maximum Length: 80

  Time zone name selected by a user when specifying a date time.
• EventSeriesId: integer (int64)
  Title: Event Series ID

  Read Only: true

  The unique identifier of the calendar series which contains the calendar event.
• EventSeriesName: string
  Title: Event Series Name

  Read Only: true

  Maximum Length: 240

  The name of the calendar series which contains the calendar event.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the calendar event was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Maximum Length: 1000

  The location of the calendar event.
• RecurrenceRule: string
  Title: Recurrence Rule

  Read Only: true

  Maximum Length: 256

  The recurrence rule of the associated calendar series.
• RecurringFlag: boolean
  Title: Recurring

  Read Only: true

  Maximum Length: 1

  Indicates whether the calendar event is a recurring event. The default value is Does not repeat.

{
    "type":"object",
    "properties":{
        "EventSeriesName":{
            "title":"Event Series Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the calendar series which contains the calendar event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurrenceRule":{
            "title":"Recurrence Rule",
            "maxLength":256,
            "type":"string",
            "description":"The recurrence rule of the associated calendar series.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarEventName":{
            "title":"Calendar Event Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayTimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"Time zone code selected by a user when specifying calendar start and end dates.",
            "nullable":false,
            "readOnly":true,
            "default":"UTC",
            "x-queryable":true
        },
        "CalendarEventCode":{
            "title":"Calendar Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayTimezoneName":{
            "title":"Time Zone Name",
            "maxLength":80,
            "type":"string",
            "description":"Time zone name selected by a user when specifying a date time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarEventStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar event starts.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarEventEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar event ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "title":"Recurring",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the calendar event is a recurring event. The default value is Does not repeat.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EventSeriesId"
                ]
            },
            "x-queryable":true
        },
        "calendarEventTagAssignments":{
            "title":"Calendar Event Tags",
            "type":"array",
            "description":"Tag assignments of calendar events.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-calendarEvents-calendarEventTagAssignments-item-response"
            }
        },
        "EventSeriesId":{
            "title":"Event Series ID",
            "type":"integer",
            "description":"The unique identifier of the calendar series which contains the calendar event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalendarEventDescription":{
            "title":"Calendar Event Description",
            "type":"string",
            "description":"The description of a calendar event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the calendar event is an all-day event.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CalendarEventId":{
            "title":"Calendar Event ID",
            "type":"integer",
            "description":"The unique identifier of a calendar event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the calendar event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":1000,
            "type":"string",
            "description":"The location of the calendar event.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Calendar Event Tags

Type: array

Title: Calendar Event Tags

Tag assignments of calendar events.

Show Source

• Array of: object hedCalendars-calendarEvents-calendarEventTagAssignments-item-response

{
    "title":"Calendar Event Tags",
    "type":"array",
    "description":"Tag assignments of calendar events.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-calendarEvents-calendarEventTagAssignments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedCalendars-calendarEvents-calendarEventTagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the tag assignment.
• TagId: integer (int64)
  Title: Tag ID

  The identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TagCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedCalendars-entityAssignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the user during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the user during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AssignedEntityTypeCode"
                ]
            },
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AssignedEntityCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedCalendars-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  The identifier of the tag assignment.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code of the tag.
• TagId: integer (int64)
  Title: Tag ID

  The identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"The identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

calendarEvents

Operation: /fscmRestApi/resources/11.13.18.05/hedCalendars/{CalendarId}/child/calendarEvents

Parameters:

• CalendarId: $request.path.CalendarId

Calendar events for a calendar, such as calendar events for an academic calendar.

entityAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedCalendars/{CalendarId}/child/entityAssignments

Parameters:

• CalendarId: $request.path.CalendarId

Academic entities which have been assigned to calendars.

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedCalendars/{CalendarId}/child/tagAssignments

Parameters:

• CalendarId: $request.path.CalendarId

Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

timezoneCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTimezones

The following properties are defined on the LOV link relation:

• Source Attribute: TimezoneCode; Target Attribute: TimezoneCode
• Display Attribute: Name

Back to Top