Jump to

• Request
• Response

Get all calendars

get

/fscmRestApi/resources/11.13.18.05/hedCalendars

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • ByKeywordFinder Finds the calendar that matches the keyword criteria specified.
    Finder Variables
    • Keyword; string; The keyword of the calendar.
  • PrimaryKey Finds the calendar that matches the primary key criteria specified.
    Finder Variables
    • CalendarId; integer; The unique identifier of the calendar.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveFlag; boolean; Indicates whether the calendar is active. The default value is N.
  • CalendarCode; string; The code of a calendar.
  • CalendarCodeLockFlag; boolean; Indicates whether calendar code is editable.
  • CalendarEndDate; string; The date when a calendar ends.
  • CalendarId; integer; The unique identifier of a calendar.
  • CalendarName; string; The name of a calendar.
  • CalendarStartDate; string; The date when a calendar starts.
  • CalendarTypeCode; string; The code of the calendar type.
  • LastUpdateDate; string; The date and time when the calendar was last updated.
  • TimezoneCode; string; Time zone code selected by a user when specifying calendar start and end dates.
  • TimezoneName; string; Time zone name selected by a user when specifying a date time.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedCalendars-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-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-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":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the calendar is active. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":32,
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "CalendarEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "CalendarStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar starts.",
            "format":"date",
            "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
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of a calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "SourceCalendarId":{
            "title":"Source Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a source calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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":{
        "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
        },
        "CalendarEventCode":{
            "title":"Calendar Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarEventDescription":{
            "title":"Calendar Event Description",
            "type":"string",
            "description":"The description of a calendar event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarEventEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar event ends.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "CalendarEventName":{
            "title":"Calendar Event Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar event.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "RecurrenceRule":{
            "title":"Recurrence Rule",
            "maxLength":256,
            "type":"string",
            "description":"The recurrence rule of the associated calendar series.",
            "nullable":true,
            "readOnly":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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "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
        },
        "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
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "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
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "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
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "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
        },
        "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
        },
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Back to Top