Jump to

• Request
• Response

Update an event

patch

/hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}

Request

Path Parameters

• learningEventsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learning Events resource and used to uniquely identify an instance of Learning Events. The client should not generate the hash key value. Instead, the client should query on the Learning Events collection resource in order to navigate to a specific instance of Learning Events to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• activities: array Activities
  Title: Activities

  The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.
• assets: array Learning Content Assets
  Title: Learning Content Assets

  The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
• dataSecurityPrivilege: string
  Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.
• eventCancelDate: string (date-time)
  Title: Event Cancel Date

  Date when the event was canceled.
• eventCancelReasonCode: string
  Title: Event Cancel Reason Code

  Maximum Length: 30

  Reason for canceling the event.
• eventCapacityEnabled: string
  Title: Event Capacity Enabled

  Maximum Length: 30

  Indicates whether the event capacity is enabled or not. Valid values are Y or N.
• eventCapacityMaximum: integer (int64)
  Title: Event Maximum Capacity

  Maximum capacity for the event.
• eventCapacityMinimum: integer (int64)
  Title: Event Minimum Capacity

  Minimum capacity for the event.
• eventEndDate: string
  Title: Event End Date

  Maximum Length: 255

  End date for the event.
• eventStartDate: string
  Title: Event Start Date

  Maximum Length: 255

  Start date for the event.
• eventTimezone: string
  Title: Event Time Zone

  Maximum Length: 30

  Time zone for the event.
• eventTrainingSupplierNumber: string
  Title: Event Supplier Number

  Friendly number identifying the training supplier.
• eventWaitlistEnabled: string
  Title: Event Waitlist Enabled

  Maximum Length: 30

  Indicates whether a waitlist is enabled or not. Valid values are Y or N.
• eventWaitlistMaximum: integer (int64)
  Title: Event Waitlist Maximum

  Maximum number of learners allowed on the waitlist.
• eventWaitlistMaximumEnabled: string
  Title: Event Waitlist Maximum Enabled

  Maximum Length: 30

  Indicates whether a maximum capacity is enabled for the waitlist or not. Valid values are Y or N.
• eventWaitlistRule: string
  Title: Event Waitlist Rule

  Maximum Length: 30

  Determines who can add to the event waitlist, such as learners or managers.
• eventWithdrawalPeriod: string
  Maximum Length: 30

  Indicates when a learner can withdraw from an event.
• eventWithdrawalPeriodBefore: string
  Maximum Length: 30

  Relative date before which withdrawal can occur, such as event start date.
• eventWithdrawalPeriodUnits: integer (int64)
  Number of units for the event withdrawal period.
• eventWithdrawalPeriodUOM: string
  Maximum Length: 20

  Unit of measure for the event withdrawal period, such as hours, days, or weeks.
• learnerFeedback: array Learner Feedback
  Title: Learner Feedback

  The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.
• learningItemApprovalRuleESS: string
  Maximum Length: 30

  Determines how approvals are configured for self-service enrollment.
• learningItemApprovalRuleMSS: string
  Maximum Length: 30

  Determines how approvals are configured for manager enrollment.
• learningItemAuthorDisplayName: string
  Title: Learning Author Display Name

  Maximum Length: 2000

  Display name the learning item author.
• learningItemAuthorPersonId: integer (int64)
  Title: Learning Author Person ID

  Person identifier for the learning item author.
• learningItemAuthorPersonNumber: string
  Title: Learning Author Person Number

  Maximum Length: 30

  Person number of the learning item author.
• learningItemAuthorType: string
  Title: Learning Author Type

  Maximum Length: 32

  Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.
• learningItemBusinessDriver: string
  Title: Learning Business Driver

  Maximum Length: 32

  Business driver, such as Compliance or Self Development.
• learningItemCatalogProfileId: integer
  Title: Learning Catalog Profile ID

  Unique identifier for the learning catalog profile.
• learningItemCatalogProfileNumber: string
  Title: Learning Catalog Profile Number

  Number for the learning catalog profile.
• learningItemCommunityOverridesVisibility: string
  Title: Learning Community Override

  Maximum Length: 1

  Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N.
• learningItemCompletionCertificateEnabled: string
  Maximum Length: 1

  Indicates if a completion certificate is enabled or not. Valid values are Y or N.
• learningItemCompletionCertificateFileName: string
  Maximum Length: 255

  File name of the completion certificate.
• learningItemCompletionCertificateLink: string
  Maximum Length: 255

  Preview link for the completion certificate.
• learningItemCompletionCertificateTitle: string
  Maximum Length: 255

  Title of the completion certificate.
• learningItemCoordPersonId: integer (int64)
  Title: Learning Coordinator Person ID

  Person identifier for the learning item coordinator.
• learningItemCoordPersonNumber: string
  Title: Learning Coordinator Person Number

  Maximum Length: 32

  Person number of the learning item coordinator.
• learningItemDeletionReasonCode: string
  Title: Learning Deletion Reason Code

  Maximum Length: 30

  Reason for deleting the learning item.
• learningItemDescription: string
  Title: Learning Description

  Maximum Length: 4000

  Plain text version of the long description of the learning item.
• learningItemDFF: array learningItemDFF
• learningItemEnrollCondition: string
  Maximum Length: 30

  Indicates when a learner can enroll in this learning item.
• learningItemEnrollmentEndDate: string (date-time)
  Date when the enrollment period ends.
• learningItemEnrollmentStartDate: string (date-time)
  Date when the enrollment period begins.
• learningItemEnrollmentVisibilityMSS: string
  Maximum Length: 30

  Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW.
• learningItemExcludeFromHistory: string
  Title: Learning Exclude from History

  Indicates whether to exclude the learning from the transcript. Valid values are Y or N.
• learningItemExpectedEffortInSeconds: number
  Title: Learning Expected Effort

  Expected effort needed by the learner to complete the learning item.
• learningItemFeatureEndDate: string (date-time)
  Title: Learning Feature Start Date

  Date when the learning item stops being featured.
• learningItemFeatureStartDate: string (date-time)
  Title: Learning Feature End Date

  Date when the learning item starts being featured.
• learningItemKeepCompletionsOnDelete: string
  Title: Learning Keep Completions on Delete

  Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.
• learningItemLearnerDataCollectionTypeESS: string
  Maximum Length: 255

  Determines how the learner information is collected, such as questionnaire or form.
• learningItemLearnerDataQuestionnaireCodeESS: string
  Maximum Length: 255

  Unique code for the questionnaire.
• learningItemLearningLevel: string
  Title: Learning Level

  Maximum Length: 32

  Learning level, such as Beginner, Moderate, or Advanced.
• learningItemLearningPathOverridesVisibility: string
  Title: Learning Path Override

  Maximum Length: 1

  Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N.
• learningItemLongDescription: string
  Title: Learning Long Description

  Long, rich text description of the learning item.
• learningItemMarkCompleteMSS: string
  Maximum Length: 30

  Indicates if the manager can mark an enrollment as complete. Possible values are Y or N. Default value is Y.
• learningItemNotificationMessage: string
  Maximum Length: 255

  Notification message text sent to the learners.
• learningItemNotificationPattern: string
  Title: Learning Notification Pattern

  Maximum Length: 32

  Notification pattern, such as Default Notification Pattern.
• learningItemNumber: string
  Title: Learning Number

  Maximum Length: 2000

  User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.
• learningItemParentId: integer (int64)
  Learning item identifier for the parent.
• learningItemParentNumber: string
  Maximum Length: 255

  Learning item number for the parent.
• learningItemPublishEndDate: string (date-time)
  Title: Learning Publish End Date

  Date when the learning item stops being visible in the learning catalog.
• learningItemPublisher: string
  Title: Learning Publisher

  Maximum Length: 32

  Learning item publisher, such as Learning Department.
• learningItemPublisherName: string
  Maximum Length: 2000

  Name of the publisher of the learning item.
• learningItemPublishStartDate: string (date-time)
  Title: Learning Publish Start Date

  Date when the learning item starts being visible in the learning catalog.
• learningItemReactivationReasonCode: string
  Title: Learning Reactivation Reason Code

  Maximum Length: 30

  Reason for moving the inactive learning item to active status.
• learningItemShortDescription: string
  Title: Learning Short Description

  Short description of the learning item.
• learningItemStatus: string
  Title: Learning Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  Status of the learning item.
• learningItemStatusComment: string
  Title: Learning Status Comment

  Maximum Length: 4000

  Status change comment for the learning item.
• learningItemSupportedLanguages: string
  Title: Learning Supported Languages

  List of languages the learning item supports.
• learningItemTitle: string
  Title: Learning Title

  Maximum Length: 250

  Title of the learning item.
• learningItemType: string
  Title: Learning Type

  Maximum Length: 30

  Default Value: ORA_EVENT

  Type of learning item, such as video, online course, document, assessment, or observation checklist.
• learningItemVisibility: string
  Title: Learning Visibility

  Maximum Length: 32

  Visibility of the learning item, such as Public or Secret.
• learningItemWithdrawalRuleESS: string
  Maximum Length: 30

  Determines how the learner's assignment withdrawals are processed.
• learningItemWithdrawalRuleMSS: string
  Maximum Length: 30

  Determines how the manager's assignment withdrawals are processed.
• messages: array Messages
  Title: Messages

  The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
• metrics: array Learning Catalog Item Metrics
  Title: Learning Catalog Item Metrics

  The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.
• userActionHints: array User Action Hints
  Title: User Action Hints

  The userActionHints resource provides hints for possible actions on its parent resource.
• whereUsed: array Where Used
  Title: Where Used

  The whereUsed resource provides details about the uses of a learning item in topics and learning communities.

{
    "type":"object",
    "properties":{
        "activities":{
            "title":"Activities",
            "type":"array",
            "description":"The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-item-patch-request"
            }
        },
        "assets":{
            "title":"Learning Content Assets",
            "type":"array",
            "description":"The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-assets-item-patch-request"
            }
        },
        "dataSecurityPrivilege":{
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "eventCancelDate":{
            "title":"Event Cancel Date",
            "type":"string",
            "description":"Date when the event was canceled.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Cancel Date"
                }
            }
        },
        "eventCancelReasonCode":{
            "title":"Event Cancel Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for canceling the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Cancel Reason Code"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "eventCapacityEnabled":{
            "title":"Event Capacity Enabled",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the event capacity is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Capacity Enabled"
                },
                "controlType":"choice"
            }
        },
        "eventCapacityMaximum":{
            "title":"Event Maximum Capacity",
            "type":"integer",
            "description":"Maximum capacity for the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Maximum Capacity"
                },
                "precision":18
            }
        },
        "eventCapacityMinimum":{
            "title":"Event Minimum Capacity",
            "type":"integer",
            "description":"Minimum capacity for the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Minimum Capacity"
                },
                "precision":18
            }
        },
        "eventEndDate":{
            "title":"Event End Date",
            "maxLength":255,
            "type":"string",
            "description":"End date for the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event End Date"
                }
            }
        },
        "eventStartDate":{
            "title":"Event Start Date",
            "maxLength":255,
            "type":"string",
            "description":"Start date for the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Start Date"
                }
            }
        },
        "eventTimezone":{
            "title":"Event Time Zone",
            "maxLength":30,
            "type":"string",
            "description":"Time zone for the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Time Zone"
                }
            }
        },
        "eventTrainingSupplierNumber":{
            "title":"Event Supplier Number",
            "type":"string",
            "description":"Friendly number identifying the training supplier.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Supplier Number"
                }
            }
        },
        "eventWaitlistEnabled":{
            "title":"Event Waitlist Enabled",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a waitlist is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Enabled"
                },
                "controlType":"choice"
            }
        },
        "eventWaitlistMaximum":{
            "title":"Event Waitlist Maximum",
            "type":"integer",
            "description":"Maximum number of learners allowed on the waitlist.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Maximum"
                },
                "precision":18
            }
        },
        "eventWaitlistMaximumEnabled":{
            "title":"Event Waitlist Maximum Enabled",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a maximum capacity is enabled for the waitlist or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Maximum Enabled"
                },
                "controlType":"choice"
            }
        },
        "eventWaitlistRule":{
            "title":"Event Waitlist Rule",
            "maxLength":30,
            "type":"string",
            "description":"Determines who can add to the event waitlist, such as learners or managers.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Rule"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "eventWithdrawalPeriod":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when a learner can withdraw from an event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "eventWithdrawalPeriodBefore":{
            "maxLength":30,
            "type":"string",
            "description":"Relative date before which withdrawal can occur, such as event start date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "eventWithdrawalPeriodUOM":{
            "maxLength":20,
            "type":"string",
            "description":"Unit of measure for the event withdrawal period, such as hours, days, or weeks.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "eventWithdrawalPeriodUnits":{
            "type":"integer",
            "description":"Number of units for the event withdrawal period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "learnerFeedback":{
            "title":"Learner Feedback",
            "type":"array",
            "description":"The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-learnerFeedback-item-patch-request"
            }
        },
        "learningItemApprovalRuleESS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how approvals are configured for self-service enrollment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemApprovalRuleMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how approvals are configured for manager enrollment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemAuthorDisplayName":{
            "title":"Learning Author Display Name",
            "maxLength":2000,
            "type":"string",
            "description":"Display name the learning item author.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Display Name"
                }
            }
        },
        "learningItemAuthorPersonId":{
            "title":"Learning Author Person ID",
            "type":"integer",
            "description":"Person identifier for the learning item author.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Person ID"
                },
                "precision":18
            }
        },
        "learningItemAuthorPersonNumber":{
            "title":"Learning Author Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the learning item author.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Person Number"
                }
            }
        },
        "learningItemAuthorType":{
            "title":"Learning Author Type",
            "maxLength":32,
            "type":"string",
            "description":"Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Type"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemBusinessDriver":{
            "title":"Learning Business Driver",
            "maxLength":32,
            "type":"string",
            "description":"Business driver, such as Compliance or Self Development.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Business Driver"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemCatalogProfileId":{
            "title":"Learning Catalog Profile ID",
            "type":"integer",
            "description":"Unique identifier for the learning catalog profile.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Catalog Profile ID"
                }
            }
        },
        "learningItemCatalogProfileNumber":{
            "title":"Learning Catalog Profile Number",
            "type":"string",
            "description":"Number for the learning catalog profile.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Catalog Profile Number"
                }
            }
        },
        "learningItemCommunityOverridesVisibility":{
            "title":"Learning Community Override",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Community Override"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemCompletionCertificateEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a completion certificate is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemCompletionCertificateFileName":{
            "maxLength":255,
            "type":"string",
            "description":"File name of the completion certificate.",
            "nullable":true
        },
        "learningItemCompletionCertificateLink":{
            "maxLength":255,
            "type":"string",
            "description":"Preview link for the completion certificate.",
            "nullable":true
        },
        "learningItemCompletionCertificateTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the completion certificate.",
            "nullable":true
        },
        "learningItemCoordPersonId":{
            "title":"Learning Coordinator Person ID",
            "type":"integer",
            "description":"Person identifier for the learning item coordinator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Coordinator Person ID"
                },
                "precision":18
            }
        },
        "learningItemCoordPersonNumber":{
            "title":"Learning Coordinator Person Number",
            "maxLength":32,
            "type":"string",
            "description":"Person number of the learning item coordinator.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Coordinator Person Number"
                }
            }
        },
        "learningItemDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learningEvents-learningItemDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "learningItemDeletionReasonCode":{
            "title":"Learning Deletion Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for deleting the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Deletion Reason Code"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemDescription":{
            "title":"Learning Description",
            "maxLength":4000,
            "type":"string",
            "description":"Plain text version of the long description of the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Description"
                }
            }
        },
        "learningItemEnrollCondition":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when a learner can enroll in this learning item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemEnrollmentEndDate":{
            "type":"string",
            "description":"Date when the enrollment period ends.",
            "format":"date-time",
            "nullable":true
        },
        "learningItemEnrollmentStartDate":{
            "type":"string",
            "description":"Date when the enrollment period begins.",
            "format":"date-time",
            "nullable":true
        },
        "learningItemEnrollmentVisibilityMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemExcludeFromHistory":{
            "title":"Learning Exclude from History",
            "type":"string",
            "description":"Indicates whether to exclude the learning from the transcript. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Exclude from History"
                },
                "controlType":"choice"
            }
        },
        "learningItemExpectedEffortInSeconds":{
            "title":"Learning Expected Effort",
            "type":"number",
            "description":"Expected effort needed by the learner to complete the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Expected Effort"
                }
            }
        },
        "learningItemFeatureEndDate":{
            "title":"Learning Feature Start Date",
            "type":"string",
            "description":"Date when the learning item stops being featured.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Feature Start Date"
                }
            }
        },
        "learningItemFeatureStartDate":{
            "title":"Learning Feature End Date",
            "type":"string",
            "description":"Date when the learning item starts being featured.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Feature End Date"
                }
            }
        },
        "learningItemKeepCompletionsOnDelete":{
            "title":"Learning Keep Completions on Delete",
            "type":"string",
            "description":"Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Keep Completions on Delete"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemLearnerDataCollectionTypeESS":{
            "maxLength":255,
            "type":"string",
            "description":"Determines how the learner information is collected, such as questionnaire or form.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "learningItemLearnerDataQuestionnaireCodeESS":{
            "maxLength":255,
            "type":"string",
            "description":"Unique code for the questionnaire.",
            "nullable":true
        },
        "learningItemLearningLevel":{
            "title":"Learning Level",
            "maxLength":32,
            "type":"string",
            "description":"Learning level, such as Beginner, Moderate, or Advanced.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Level"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "learningItemLearningPathOverridesVisibility":{
            "title":"Learning Path Override",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Path Override"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemLongDescription":{
            "title":"Learning Long Description",
            "type":"string",
            "description":"Long, rich text description of the learning item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Long Description"
                }
            }
        },
        "learningItemMarkCompleteMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the manager can mark an enrollment as complete. Possible values are Y or N. Default value is Y.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemNotificationMessage":{
            "maxLength":255,
            "type":"string",
            "description":"Notification message text sent to the learners.",
            "nullable":true
        },
        "learningItemNotificationPattern":{
            "title":"Learning Notification Pattern",
            "maxLength":32,
            "type":"string",
            "description":"Notification pattern, such as Default Notification Pattern.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Notification Pattern"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemNumber":{
            "title":"Learning Number",
            "maxLength":2000,
            "type":"string",
            "description":"User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Number"
                },
                "includeInCompactView":true
            }
        },
        "learningItemParentId":{
            "type":"integer",
            "description":"Learning item identifier for the parent.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "learningItemParentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Learning item number for the parent.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "learningItemParentId"
                ]
            }
        },
        "learningItemPublishEndDate":{
            "title":"Learning Publish End Date",
            "type":"string",
            "description":"Date when the learning item stops being visible in the learning catalog.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Publish End Date"
                }
            }
        },
        "learningItemPublishStartDate":{
            "title":"Learning Publish Start Date",
            "type":"string",
            "description":"Date when the learning item starts being visible in the learning catalog.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Publish Start Date"
                }
            }
        },
        "learningItemPublisher":{
            "title":"Learning Publisher",
            "maxLength":32,
            "type":"string",
            "description":"Learning item publisher, such as Learning Department.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Publisher"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemPublisherName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the publisher of the learning item.",
            "nullable":true
        },
        "learningItemReactivationReasonCode":{
            "title":"Learning Reactivation Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for moving the inactive learning item to active status.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Reactivation Reason Code"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemShortDescription":{
            "title":"Learning Short Description",
            "type":"string",
            "description":"Short description of the learning item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Short Description"
                }
            }
        },
        "learningItemStatus":{
            "title":"Learning Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item.",
            "nullable":false,
            "default":"ORA_DRAFT",
            "x-hints":{
                "help":{
                    "instruction":"Learning Status"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemStatusComment":{
            "title":"Learning Status Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Status change comment for the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Status Comment"
                }
            }
        },
        "learningItemSupportedLanguages":{
            "title":"Learning Supported Languages",
            "type":"string",
            "description":"List of languages the learning item supports.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Supported Languages"
                }
            }
        },
        "learningItemTitle":{
            "title":"Learning Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Title"
                }
            }
        },
        "learningItemType":{
            "title":"Learning Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of learning item, such as video, online course, document, assessment, or observation checklist.",
            "nullable":true,
            "default":"ORA_EVENT",
            "x-hints":{
                "help":{
                    "instruction":"Learning Type"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "learningItemVisibility":{
            "title":"Learning Visibility",
            "maxLength":32,
            "type":"string",
            "description":"Visibility of the learning item, such as Public or Secret.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Visibility"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemWithdrawalRuleESS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how the learner's assignment withdrawals are processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemWithdrawalRuleMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how the manager's assignment withdrawals are processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "messages":{
            "title":"Messages",
            "type":"array",
            "description":"The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-messages-item-patch-request"
            }
        },
        "metrics":{
            "title":"Learning Catalog Item Metrics",
            "type":"array",
            "description":"The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-metrics-item-patch-request"
            }
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-relatedMaterials-item-patch-request"
            }
        },
        "userActionHints":{
            "title":"User Action Hints",
            "type":"array",
            "description":"The userActionHints resource provides hints for possible actions on its parent resource.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-userActionHints-item-patch-request"
            }
        },
        "whereUsed":{
            "title":"Where Used",
            "type":"array",
            "description":"The whereUsed resource provides details about the uses of a learning item in topics and learning communities.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-whereUsed-item-patch-request"
            }
        }
    }
}

Nested Schema : Activities

Type: array

Title: Activities

The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.

Show Source

• Array of: object learningEvents-activities-item-patch-request

{
    "title":"Activities",
    "type":"array",
    "description":"The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-item-patch-request"
    }
}

Nested Schema : Learning Content Assets

Type: array

Title: Learning Content Assets

The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.

Show Source

• Array of: object learningEvents-assets-item-patch-request

{
    "title":"Learning Content Assets",
    "type":"array",
    "description":"The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-assets-item-patch-request"
    }
}

Nested Schema : Learner Feedback

Type: array

Title: Learner Feedback

The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.

Show Source

• Array of: object schema

{
    "title":"Learner Feedback",
    "type":"array",
    "description":"The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-learnerFeedback-item-patch-request"
    }
}

Nested Schema : learningItemDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learningEvents-learningItemDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Messages

Type: array

Title: Messages

The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.

Show Source

• Array of: object learningEvents-messages-item-patch-request

{
    "title":"Messages",
    "type":"array",
    "description":"The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-messages-item-patch-request"
    }
}

Nested Schema : Learning Catalog Item Metrics

Type: array

Title: Learning Catalog Item Metrics

The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.

Show Source

• Array of: object learningEvents-metrics-item-patch-request

{
    "title":"Learning Catalog Item Metrics",
    "type":"array",
    "description":"The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-metrics-item-patch-request"
    }
}

Nested Schema : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-relatedMaterials-item-patch-request

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-relatedMaterials-item-patch-request"
    }
}

Nested Schema : User Action Hints

Type: array

Title: User Action Hints

The userActionHints resource provides hints for possible actions on its parent resource.

Show Source

• Array of: object learningEvents-userActionHints-item-patch-request

{
    "title":"User Action Hints",
    "type":"array",
    "description":"The userActionHints resource provides hints for possible actions on its parent resource.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-userActionHints-item-patch-request"
    }
}

Nested Schema : Where Used

Type: array

Title: Where Used

The whereUsed resource provides details about the uses of a learning item in topics and learning communities.

Show Source

• Array of: object learningEvents-whereUsed-item-patch-request

{
    "title":"Where Used",
    "type":"array",
    "description":"The whereUsed resource provides details about the uses of a learning item in topics and learning communities.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-whereUsed-item-patch-request"
    }
}

Nested Schema : learningEvents-activities-item-patch-request

Type: object

Show Source

• activityNumber: string
  Title: Activity Number

  Maximum Length: 2000

  Friendly number identifying the activity.
• activityType: string
  Title: Activity Type

  Maximum Length: 30

  Default Value: ORA_ILT_ACTIVITY

  Activity type, such as Internal or External.
• adhocResources: array Ad Hoc Resources
  Title: Ad Hoc Resources

  The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.
• classroomDetails: array Classrooms
  Title: Classrooms

  The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
• classroomDisplayName: string
  Title: Classroom Title

  Maximum Length: 2000

  Display name of the activity classrooms.
• classrooms: string
  Title: Classrooms

  List of activity classrooms.
• completionRule: string
  Title: Completion Rule

  Maximum Length: 30

  Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required.
• completionType: string
  Maximum Length: 30

  Completion type for the activity, such as Mandatory or Optional.
• description: string
  Title: Activity Description

  Description for the activity.
• endDate: string
  Title: Activity End Date

  End date for the activity.
• expectedEffortInSeconds: number
  Title: Expected Efforts

  Expected effort needed by the learner to complete the learning item.
• externalDetailsURL: string
  Title: External Details URL

  Maximum Length: 2000

  Details URL for the activity.
• instructorDetails: array Instructors
  Title: Instructors

  The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
• instructors: string
  Title: Instructors

  List of activity instructors.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.
• startDate: string
  Title: Activity Start Date

  Start date for the activity.
• status: string
  Title: Status

  Maximum Length: 30

  Status for the activity
• timezone: string
  Title: Time Zone

  Maximum Length: 30

  Time zone for the activity
• title: string
  Title: Title

  Maximum Length: 250

  Title of the activity.
• virtualClassroomURL: string
  Title: Virtual Classroom URL

  Maximum Length: 500

  Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.

{
    "type":"object",
    "properties":{
        "activityNumber":{
            "title":"Activity Number",
            "maxLength":2000,
            "type":"string",
            "description":"Friendly number identifying the activity.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Activity Number"
                },
                "includeInCompactView":true
            }
        },
        "activityType":{
            "title":"Activity Type",
            "maxLength":30,
            "type":"string",
            "description":"Activity type, such as Internal or External.",
            "nullable":true,
            "default":"ORA_ILT_ACTIVITY",
            "x-hints":{
                "help":{
                    "instruction":"Activity Type"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "adhocResources":{
            "title":"Ad Hoc Resources",
            "type":"array",
            "description":"The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-adhocResources-item-patch-request"
            }
        },
        "classroomDetails":{
            "title":"Classrooms",
            "type":"array",
            "description":"The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-classroomDetails-item-patch-request"
            }
        },
        "classroomDisplayName":{
            "title":"Classroom Title",
            "maxLength":2000,
            "type":"string",
            "description":"Display name of the activity classrooms.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Classroom Title"
                }
            }
        },
        "classrooms":{
            "title":"Classrooms",
            "type":"string",
            "description":"List of activity classrooms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Classrooms"
                }
            }
        },
        "completionRule":{
            "title":"Completion Rule",
            "maxLength":30,
            "type":"string",
            "description":"Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Completion Rule"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "completionType":{
            "maxLength":30,
            "type":"string",
            "description":"Completion type for the activity, such as Mandatory or Optional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "description":{
            "title":"Activity Description",
            "type":"string",
            "description":"Description for the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Activity Description"
                }
            }
        },
        "endDate":{
            "title":"Activity End Date",
            "type":"string",
            "description":"End date for the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Activity End Date"
                }
            }
        },
        "expectedEffortInSeconds":{
            "title":"Expected Efforts",
            "type":"number",
            "description":"Expected effort needed by the learner to complete the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Expected Efforts"
                }
            }
        },
        "externalDetailsURL":{
            "title":"External Details URL",
            "maxLength":2000,
            "type":"string",
            "description":"Details URL for the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"External Details URL"
                }
            }
        },
        "instructorDetails":{
            "title":"Instructors",
            "type":"array",
            "description":"The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-instructorDetails-item-patch-request"
            }
        },
        "instructors":{
            "title":"Instructors",
            "type":"string",
            "description":"List of activity instructors.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Instructors"
                }
            }
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-item-patch-request"
            }
        },
        "startDate":{
            "title":"Activity Start Date",
            "type":"string",
            "description":"Start date for the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Activity Start Date"
                }
            }
        },
        "status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status for the activity",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                }
            }
        },
        "timezone":{
            "title":"Time Zone",
            "maxLength":30,
            "type":"string",
            "description":"Time zone for the activity",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Time Zone"
                }
            }
        },
        "title":{
            "title":"Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Title"
                }
            }
        },
        "virtualClassroomURL":{
            "title":"Virtual Classroom URL",
            "maxLength":500,
            "type":"string",
            "description":"Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Virtual Classroom URL"
                }
            }
        }
    }
}

Nested Schema : Ad Hoc Resources

Type: array

Title: Ad Hoc Resources

The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.

Show Source

• Array of: object schema

{
    "title":"Ad Hoc Resources",
    "type":"array",
    "description":"The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-adhocResources-item-patch-request"
    }
}

Nested Schema : Classrooms

Type: array

Title: Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Show Source

• Array of: object learningEvents-activities-classroomDetails-item-patch-request

{
    "title":"Classrooms",
    "type":"array",
    "description":"The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-classroomDetails-item-patch-request"
    }
}

Nested Schema : Instructors

Type: array

Title: Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Show Source

• Array of: object learningEvents-activities-instructorDetails-item-patch-request

{
    "title":"Instructors",
    "type":"array",
    "description":"The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-instructorDetails-item-patch-request"
    }
}

Nested Schema : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-activities-relatedMaterials-item-patch-request

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• resourceDescription: string
  Maximum Length: 4000

  Description for the resource.
• resourceId: integer (int64)
  Unique identifier for the resource.
• resourceName: string
  Maximum Length: 100

  Display name of the resource.
• resourceNumber: string
  Maximum Length: 30

  Friendly number for identifying a resource.
• resourceQuantity: number
  Quantity for the resource.

{
    "type":"object",
    "properties":{
        "resourceDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description for the resource.",
            "nullable":true
        },
        "resourceId":{
            "type":"integer",
            "description":"Unique identifier for the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "resourceName":{
            "maxLength":100,
            "type":"string",
            "description":"Display name of the resource.",
            "nullable":true
        },
        "resourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for identifying a resource.",
            "nullable":true
        },
        "resourceQuantity":{
            "type":"number",
            "description":"Quantity for the resource.",
            "nullable":true
        }
    }
}

Nested Schema : learningEvents-activities-classroomDetails-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : learningEvents-activities-instructorDetails-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : learningEvents-activities-relatedMaterials-item-patch-request

Type: object

Show Source

• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "relatedMaterialsBinaries":{
            "title":"Related Materials Binaries",
            "type":"array",
            "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-patch-request"
            }
        },
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        }
    }
}

Nested Schema : Related Materials Binaries

Type: array

Title: Related Materials Binaries

The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object schema

{
    "title":"Related Materials Binaries",
    "type":"array",
    "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Surrogate identifier for the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  Folder path where the attachment will be created.
• DownloadInfo: string
  Title: DownloadInfo

  Version number for the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date for the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Title: File Url

  Name for the attachment file.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  User name of the person who most recently updated the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"User name of the person who most recently updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : learningEvents-assets-item-patch-request

Type: object

Show Source

• assetBinaries: array Content Binaries
  Title: Content Binaries

  The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• assetId: integer (int64)
  Unique identifier for the learning item asset, such as cover art or a trailer.
• assetNumber: string
  Maximum Length: 30

  User-friendly number identifying the learning item asset, such as cover art or a trailer.
• primary: string
  Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
• relationshipType: string
  Maximum Length: 30

  Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC.
• sourceURL: string
  Maximum Length: 2000

  Web link to the image source location.
• status: string
  Maximum Length: 30

  Status of the learning item asset.
• type: string
  Maximum Length: 30

  Indicates the type of learning asset, such as cover art or a trailer.

{
    "type":"object",
    "properties":{
        "assetBinaries":{
            "title":"Content Binaries",
            "type":"array",
            "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-assets-assetBinaries-item-patch-request"
            }
        },
        "assetId":{
            "type":"integer",
            "description":"Unique identifier for the learning item asset, such as cover art or a trailer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "assetNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly number identifying the learning item asset, such as cover art or a trailer.",
            "nullable":true
        },
        "primary":{
            "type":"string",
            "description":"Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "relationshipType":{
            "maxLength":30,
            "type":"string",
            "description":"Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "sourceURL":{
            "maxLength":2000,
            "type":"string",
            "description":"Web link to the image source location.",
            "nullable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item asset.",
            "nullable":true
        },
        "type":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of learning asset, such as cover art or a trailer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        }
    }
}

Nested Schema : Content Binaries

Type: array

Title: Content Binaries

The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object schema

{
    "title":"Content Binaries",
    "type":"array",
    "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-assets-assetBinaries-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description for the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Surrogate identifier for the document attached.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment will be created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number for the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Expiration date for the attachment. This is a read-only attribute.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name for the attachment file.
• FileUrl: string
  Title: File Url

  File URL for the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL for a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL for a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• feedbackCondition: string
  Maximum Length: 80

  Default Value: ORA_NONE

  Determines when the learner can provide feedback, such as after start or after successful completion.
• feedbackType: string
  Maximum Length: 30

  Type of feedback, such as rating or evaluation.
• questionnaireCode: string
  Maximum Length: 80

  Unique code for the questionnaire.
• requireFeedback: string
  Maximum Length: 80

  Default Value: N

  Indicates whether feedback is required. Valid values are Y or N

{
    "type":"object",
    "properties":{
        "feedbackCondition":{
            "maxLength":80,
            "type":"string",
            "description":"Determines when the learner can provide feedback, such as after start or after successful completion.",
            "nullable":true,
            "default":"ORA_NONE",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "feedbackType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of feedback, such as rating or evaluation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "questionnaireCode":{
            "maxLength":80,
            "type":"string",
            "description":"Unique code for the questionnaire.",
            "nullable":true,
            "x-queryable":false
        },
        "requireFeedback":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether feedback is required. Valid values are Y or N",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EffectiveEndDate: string (date)
• EffectiveStartDate: string (date)

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : learningEvents-messages-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : learningEvents-metrics-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : learningEvents-relatedMaterials-item-patch-request

Type: object

Show Source

• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "relatedMaterialsBinaries":{
            "title":"Related Materials Binaries",
            "type":"array",
            "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-relatedMaterials-relatedMaterialsBinaries-item-patch-request"
            }
        },
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        }
    }
}

Nested Schema : Related Materials Binaries

Type: array

Title: Related Materials Binaries

The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-relatedMaterials-relatedMaterialsBinaries-item-patch-request

{
    "title":"Related Materials Binaries",
    "type":"array",
    "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-relatedMaterials-relatedMaterialsBinaries-item-patch-request"
    }
}

Nested Schema : learningEvents-relatedMaterials-relatedMaterialsBinaries-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Surrogate identifier for the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  Folder path where the attachment will be created.
• DownloadInfo: string
  Title: DownloadInfo

  Version number for the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date for the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Title: File Url

  Name for the attachment file.
• PostProcessingAction: string
  Title: PostProcessingAction

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  User name of the person who most recently updated the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"User name of the person who most recently updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : learningEvents-userActionHints-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : learningEvents-whereUsed-item-patch-request

Type: object

Show Source

• learningItemNumber: string
  Maximum Length: 30

  Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.

{
    "type":"object",
    "properties":{
        "learningItemNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.",
            "nullable":true
        }
    }
}

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 : learningEvents-item-response

Type: object

Show Source

• activities: array Activities
  Title: Activities

  The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.
• assets: array Learning Content Assets
  Title: Learning Content Assets

  The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
• dataSecurityPrivilege: string
  Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.
• eventCancelDate: string (date-time)
  Title: Event Cancel Date

  Date when the event was canceled.
• eventCancelReasonCode: string
  Title: Event Cancel Reason Code

  Maximum Length: 30

  Reason for canceling the event.
• eventCapacityEnabled: string
  Title: Event Capacity Enabled

  Maximum Length: 30

  Indicates whether the event capacity is enabled or not. Valid values are Y or N.
• eventCapacityMaximum: integer (int64)
  Title: Event Maximum Capacity

  Maximum capacity for the event.
• eventCapacityMinimum: integer (int64)
  Title: Event Minimum Capacity

  Minimum capacity for the event.
• eventEndDate: string
  Title: Event End Date

  Maximum Length: 255

  End date for the event.
• eventStartDate: string
  Title: Event Start Date

  Maximum Length: 255

  Start date for the event.
• eventTimezone: string
  Title: Event Time Zone

  Maximum Length: 30

  Time zone for the event.
• eventTrainingSupplierDisplayName: string
  Title: Event Supplier Display Name

  Read Only: true

  Display name for the training supplier.
• eventTrainingSupplierNumber: string
  Title: Event Supplier Number

  Friendly number identifying the training supplier.
• eventWaitlistEnabled: string
  Title: Event Waitlist Enabled

  Maximum Length: 30

  Indicates whether a waitlist is enabled or not. Valid values are Y or N.
• eventWaitlistMaximum: integer (int64)
  Title: Event Waitlist Maximum

  Maximum number of learners allowed on the waitlist.
• eventWaitlistMaximumEnabled: string
  Title: Event Waitlist Maximum Enabled

  Maximum Length: 30

  Indicates whether a maximum capacity is enabled for the waitlist or not. Valid values are Y or N.
• eventWaitlistRule: string
  Title: Event Waitlist Rule

  Maximum Length: 30

  Determines who can add to the event waitlist, such as learners or managers.
• eventWithdrawalPeriod: string
  Maximum Length: 30

  Indicates when a learner can withdraw from an event.
• eventWithdrawalPeriodBefore: string
  Maximum Length: 30

  Relative date before which withdrawal can occur, such as event start date.
• eventWithdrawalPeriodUnits: integer (int64)
  Number of units for the event withdrawal period.
• eventWithdrawalPeriodUOM: string
  Maximum Length: 20

  Unit of measure for the event withdrawal period, such as hours, days, or weeks.
• learnerFeedback: array Learner Feedback
  Title: Learner Feedback

  The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.
• learningItemApprovalRuleESS: string
  Maximum Length: 30

  Determines how approvals are configured for self-service enrollment.
• learningItemApprovalRuleMSS: string
  Maximum Length: 30

  Determines how approvals are configured for manager enrollment.
• learningItemAttributionType: string
  Title: Learning Attribution Type

  Maximum Length: 30

  Default Value: ORA_PERSON

  Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.
• learningItemAuthorDisplayName: string
  Title: Learning Author Display Name

  Maximum Length: 2000

  Display name the learning item author.
• learningItemAuthorPersonId: integer (int64)
  Title: Learning Author Person ID

  Person identifier for the learning item author.
• learningItemAuthorPersonNumber: string
  Title: Learning Author Person Number

  Maximum Length: 30

  Person number of the learning item author.
• learningItemAuthorType: string
  Title: Learning Author Type

  Maximum Length: 32

  Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.
• learningItemBusinessDriver: string
  Title: Learning Business Driver

  Maximum Length: 32

  Business driver, such as Compliance or Self Development.
• learningItemCatalogProfileId: integer
  Title: Learning Catalog Profile ID

  Unique identifier for the learning catalog profile.
• learningItemCatalogProfileName: string
  Title: Learning Catalog Profile Name

  Read Only: true

  Name of the learning catalog profile.
• learningItemCatalogProfileNumber: string
  Title: Learning Catalog Profile Number

  Number for the learning catalog profile.
• learningItemCommunityOverridesVisibility: string
  Title: Learning Community Override

  Maximum Length: 1

  Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N.
• learningItemCompletionCertificateEnabled: string
  Maximum Length: 1

  Indicates if a completion certificate is enabled or not. Valid values are Y or N.
• learningItemCompletionCertificateFileName: string
  Maximum Length: 255

  File name of the completion certificate.
• learningItemCompletionCertificateLink: string
  Maximum Length: 255

  Preview link for the completion certificate.
• learningItemCompletionCertificateTitle: string
  Maximum Length: 255

  Title of the completion certificate.
• learningItemCoordDisplayName: string
  Title: Learning Coordinator Display Name

  Read Only: true

  Display name of the learning item coordinator.
• learningItemCoordEmailAddress: string
  Read Only: true

  Maximum Length: 255

  Email address for the learning item coordinator.
• learningItemCoordPersonId: integer (int64)
  Title: Learning Coordinator Person ID

  Person identifier for the learning item coordinator.
• learningItemCoordPersonNumber: string
  Title: Learning Coordinator Person Number

  Maximum Length: 32

  Person number of the learning item coordinator.
• learningItemCoordPhoneNumber: string
  Read Only: true

  Maximum Length: 255

  Phone number for the learning item coordinator.
• learningItemCoverArtHighRenditionLink: string
  Read Only: true

  Link to the high rendition version of the learning cover art image.
• learningItemCoverArtLowRenditionLink: string
  Read Only: true

  Link to the low rendition version of the learning cover art image.
• learningItemCoverArtMedRenditionLink: string
  Read Only: true

  Link to the medium rendition version of the learning cover art image.
• learningItemCreatedByDisplayName: string
  Title: Learning Creator Display Name

  Read Only: true

  Display name of the person who created the learning item.
• learningItemCreationDate: string (date-time)
  Title: Learning Creation Date

  Read Only: true

  Date when the learning item was created.
• learningItemDeletionReasonCode: string
  Title: Learning Deletion Reason Code

  Maximum Length: 30

  Reason for deleting the learning item.
• learningItemDescription: string
  Title: Learning Description

  Maximum Length: 4000

  Plain text version of the long description of the learning item.
• learningItemDetailsDeepLink: string
  Title: Learning Details Deep Link

  Read Only: true

  URL to open the learning item page directly from the browser.
• learningItemDetailsEmbedLink: string
  Title: Learning Embed Deep Link

  Read Only: true

  URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top.
• learningItemDFF: array learningItemDFF
• learningItemEnrollCondition: string
  Maximum Length: 30

  Indicates when a learner can enroll in this learning item.
• learningItemEnrollmentEndDate: string (date-time)
  Date when the enrollment period ends.
• learningItemEnrollmentStartDate: string (date-time)
  Date when the enrollment period begins.
• learningItemEnrollmentVisibilityMSS: string
  Maximum Length: 30

  Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW.
• learningItemExcludeFromHistory: string
  Title: Learning Exclude from History

  Indicates whether to exclude the learning from the transcript. Valid values are Y or N.
• learningItemExpectedEffortInSeconds: number
  Title: Learning Expected Effort

  Expected effort needed by the learner to complete the learning item.
• learningItemFeatureEndDate: string (date-time)
  Title: Learning Feature Start Date

  Date when the learning item stops being featured.
• learningItemFeatureStartDate: string (date-time)
  Title: Learning Feature End Date

  Date when the learning item starts being featured.
• learningItemId: integer (int64)
  Learning item Id of the course.
• learningItemKeepCompletionsOnDelete: string
  Title: Learning Keep Completions on Delete

  Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.
• learningItemLastModifiedByDisplayName: string
  Title: Learning Last Modified By

  Read Only: true

  Display name of the person who last modified the learning item.
• learningItemLastModifiedDate: string (date-time)
  Title: Learning Last Modified Date

  Read Only: true

  Date when the learning item was last modified.
• learningItemLearnerDataCollectionTypeESS: string
  Maximum Length: 255

  Determines how the learner information is collected, such as questionnaire or form.
• learningItemLearnerDataQuestionnaireCodeESS: string
  Maximum Length: 255

  Unique code for the questionnaire.
• learningItemLearnerDataQuestionnaireNameESS: string
  Read Only: true

  Maximum Length: 255

  Name of the questionnaire.
• learningItemLearningLevel: string
  Title: Learning Level

  Maximum Length: 32

  Learning level, such as Beginner, Moderate, or Advanced.
• learningItemLearningPathOverridesVisibility: string
  Title: Learning Path Override

  Maximum Length: 1

  Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N.
• learningItemLongDescription: string
  Title: Learning Long Description

  Long, rich text description of the learning item.
• learningItemMarkCompleteMSS: string
  Maximum Length: 30

  Indicates if the manager can mark an enrollment as complete. Possible values are Y or N. Default value is Y.
• learningItemNotificationMessage: string
  Maximum Length: 255

  Notification message text sent to the learners.
• learningItemNotificationPattern: string
  Title: Learning Notification Pattern

  Maximum Length: 32

  Notification pattern, such as Default Notification Pattern.
• learningItemNumber: string
  Title: Learning Number

  Maximum Length: 2000

  User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.
• learningItemParentId: integer (int64)
  Learning item identifier for the parent.
• learningItemParentNumber: string
  Maximum Length: 255

  Learning item number for the parent.
• learningItemPreviewURL: string
  Title: Learning Preview URL

  Read Only: true

  URL used by the administrator to preview the learning item.
• learningItemPublishEndDate: string (date-time)
  Title: Learning Publish End Date

  Date when the learning item stops being visible in the learning catalog.
• learningItemPublisher: string
  Title: Learning Publisher

  Maximum Length: 32

  Learning item publisher, such as Learning Department.
• learningItemPublisherName: string
  Maximum Length: 2000

  Name of the publisher of the learning item.
• learningItemPublishStartDate: string (date-time)
  Title: Learning Publish Start Date

  Date when the learning item starts being visible in the learning catalog.
• learningItemRatingAverage: integer
  Title: Learning Rating Average

  Read Only: true

  Rating average for the learning item.
• learningItemRatingCount: integer
  Title: Learning Rating Count

  Read Only: true

  Rating count for the learning item.
• learningItemReactivationReasonCode: string
  Title: Learning Reactivation Reason Code

  Maximum Length: 30

  Reason for moving the inactive learning item to active status.
• learningItemSelfEnrollmentURL: string
  Title: Learning Self Enrollment URL

  Read Only: true

  URL for the learner to self enroll
• learningItemShortDescription: string
  Title: Learning Short Description

  Short description of the learning item.
• learningItemStatus: string
  Title: Learning Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  Status of the learning item.
• learningItemStatusComment: string
  Title: Learning Status Comment

  Maximum Length: 4000

  Status change comment for the learning item.
• learningItemSupportedLanguages: string
  Title: Learning Supported Languages

  List of languages the learning item supports.
• learningItemTitle: string
  Title: Learning Title

  Maximum Length: 250

  Title of the learning item.
• learningItemTrailerLink: string
  Title: Learning Trailer Link

  Read Only: true

  URL to open the learning item trailer directly from the browser.
• learningItemType: string
  Title: Learning Type

  Maximum Length: 30

  Default Value: ORA_EVENT

  Type of learning item, such as video, online course, document, assessment, or observation checklist.
• learningItemTypeMeaning: string
  Title: Learning Type Meaning

  Read Only: true

  Meaning for the learningItemType attribute.
• learningItemVisibility: string
  Title: Learning Visibility

  Maximum Length: 32

  Visibility of the learning item, such as Public or Secret.
• learningItemWithdrawalRuleESS: string
  Maximum Length: 30

  Determines how the learner's assignment withdrawals are processed.
• learningItemWithdrawalRuleMSS: string
  Maximum Length: 30

  Determines how the manager's assignment withdrawals are processed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messages: array Messages
  Title: Messages

  The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
• metrics: array Learning Catalog Item Metrics
  Title: Learning Catalog Item Metrics

  The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.
• userActionHints: array User Action Hints
  Title: User Action Hints

  The userActionHints resource provides hints for possible actions on its parent resource.
• whereUsed: array Where Used
  Title: Where Used

  The whereUsed resource provides details about the uses of a learning item in topics and learning communities.

{
    "type":"object",
    "properties":{
        "activities":{
            "title":"Activities",
            "type":"array",
            "description":"The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-item-response"
            }
        },
        "assets":{
            "title":"Learning Content Assets",
            "type":"array",
            "description":"The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-assets-item-response"
            }
        },
        "dataSecurityPrivilege":{
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "eventCancelDate":{
            "title":"Event Cancel Date",
            "type":"string",
            "description":"Date when the event was canceled.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Cancel Date"
                }
            },
            "x-queryable":true
        },
        "eventCancelReasonCode":{
            "title":"Event Cancel Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for canceling the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Cancel Reason Code"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "eventCapacityEnabled":{
            "title":"Event Capacity Enabled",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the event capacity is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Capacity Enabled"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "eventCapacityMaximum":{
            "title":"Event Maximum Capacity",
            "type":"integer",
            "description":"Maximum capacity for the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Maximum Capacity"
                },
                "precision":18
            }
        },
        "eventCapacityMinimum":{
            "title":"Event Minimum Capacity",
            "type":"integer",
            "description":"Minimum capacity for the event.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Minimum Capacity"
                },
                "precision":18
            }
        },
        "eventEndDate":{
            "title":"Event End Date",
            "maxLength":255,
            "type":"string",
            "description":"End date for the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event End Date"
                }
            },
            "x-queryable":true
        },
        "eventStartDate":{
            "title":"Event Start Date",
            "maxLength":255,
            "type":"string",
            "description":"Start date for the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Start Date"
                }
            },
            "x-queryable":true
        },
        "eventTimezone":{
            "title":"Event Time Zone",
            "maxLength":30,
            "type":"string",
            "description":"Time zone for the event.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Time Zone"
                }
            },
            "x-queryable":true
        },
        "eventTrainingSupplierDisplayName":{
            "title":"Event Supplier Display Name",
            "type":"string",
            "description":"Display name for the training supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Supplier Display Name"
                }
            }
        },
        "eventTrainingSupplierNumber":{
            "title":"Event Supplier Number",
            "type":"string",
            "description":"Friendly number identifying the training supplier.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Supplier Number"
                }
            },
            "x-queryable":true
        },
        "eventWaitlistEnabled":{
            "title":"Event Waitlist Enabled",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a waitlist is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Enabled"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "eventWaitlistMaximum":{
            "title":"Event Waitlist Maximum",
            "type":"integer",
            "description":"Maximum number of learners allowed on the waitlist.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Maximum"
                },
                "precision":18
            }
        },
        "eventWaitlistMaximumEnabled":{
            "title":"Event Waitlist Maximum Enabled",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a maximum capacity is enabled for the waitlist or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Maximum Enabled"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "eventWaitlistRule":{
            "title":"Event Waitlist Rule",
            "maxLength":30,
            "type":"string",
            "description":"Determines who can add to the event waitlist, such as learners or managers.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Event Waitlist Rule"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "eventWithdrawalPeriod":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when a learner can withdraw from an event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "eventWithdrawalPeriodBefore":{
            "maxLength":30,
            "type":"string",
            "description":"Relative date before which withdrawal can occur, such as event start date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "eventWithdrawalPeriodUOM":{
            "maxLength":20,
            "type":"string",
            "description":"Unit of measure for the event withdrawal period, such as hours, days, or weeks.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "eventWithdrawalPeriodUnits":{
            "type":"integer",
            "description":"Number of units for the event withdrawal period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learnerFeedback":{
            "title":"Learner Feedback",
            "type":"array",
            "description":"The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-learnerFeedback-item-response"
            }
        },
        "learningItemApprovalRuleESS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how approvals are configured for self-service enrollment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemApprovalRuleMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how approvals are configured for manager enrollment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemAttributionType":{
            "title":"Learning Attribution Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.",
            "nullable":true,
            "default":"ORA_PERSON",
            "x-hints":{
                "help":{
                    "instruction":"Learning Attribution Type"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemAuthorDisplayName":{
            "title":"Learning Author Display Name",
            "maxLength":2000,
            "type":"string",
            "description":"Display name the learning item author.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Display Name"
                }
            }
        },
        "learningItemAuthorPersonId":{
            "title":"Learning Author Person ID",
            "type":"integer",
            "description":"Person identifier for the learning item author.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Person ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemAuthorPersonNumber":{
            "title":"Learning Author Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the learning item author.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Person Number"
                }
            }
        },
        "learningItemAuthorType":{
            "title":"Learning Author Type",
            "maxLength":32,
            "type":"string",
            "description":"Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Author Type"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemBusinessDriver":{
            "title":"Learning Business Driver",
            "maxLength":32,
            "type":"string",
            "description":"Business driver, such as Compliance or Self Development.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Business Driver"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemCatalogProfileId":{
            "title":"Learning Catalog Profile ID",
            "type":"integer",
            "description":"Unique identifier for the learning catalog profile.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Catalog Profile ID"
                }
            },
            "x-queryable":true
        },
        "learningItemCatalogProfileName":{
            "title":"Learning Catalog Profile Name",
            "type":"string",
            "description":"Name of the learning catalog profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Catalog Profile Name"
                }
            },
            "x-queryable":true
        },
        "learningItemCatalogProfileNumber":{
            "title":"Learning Catalog Profile Number",
            "type":"string",
            "description":"Number for the learning catalog profile.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Catalog Profile Number"
                }
            },
            "x-queryable":true
        },
        "learningItemCommunityOverridesVisibility":{
            "title":"Learning Community Override",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Community Override"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemCompletionCertificateEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a completion certificate is enabled or not. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemCompletionCertificateFileName":{
            "maxLength":255,
            "type":"string",
            "description":"File name of the completion certificate.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCompletionCertificateLink":{
            "maxLength":255,
            "type":"string",
            "description":"Preview link for the completion certificate.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCompletionCertificateTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the completion certificate.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemCoordDisplayName":{
            "title":"Learning Coordinator Display Name",
            "type":"string",
            "description":"Display name of the learning item coordinator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Coordinator Display Name"
                }
            }
        },
        "learningItemCoordEmailAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Email address for the learning item coordinator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemCoordPersonId":{
            "title":"Learning Coordinator Person ID",
            "type":"integer",
            "description":"Person identifier for the learning item coordinator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Coordinator Person ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemCoordPersonNumber":{
            "title":"Learning Coordinator Person Number",
            "maxLength":32,
            "type":"string",
            "description":"Person number of the learning item coordinator.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Coordinator Person Number"
                }
            },
            "x-queryable":true
        },
        "learningItemCoordPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Phone number for the learning item coordinator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemCoverArtHighRenditionLink":{
            "type":"string",
            "description":"Link to the high rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCoverArtLowRenditionLink":{
            "type":"string",
            "description":"Link to the low rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCoverArtMedRenditionLink":{
            "type":"string",
            "description":"Link to the medium rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCreatedByDisplayName":{
            "title":"Learning Creator Display Name",
            "type":"string",
            "description":"Display name of the person who created the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Creator Display Name"
                }
            }
        },
        "learningItemCreationDate":{
            "title":"Learning Creation Date",
            "type":"string",
            "description":"Date when the learning item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Creation Date"
                }
            },
            "x-queryable":true
        },
        "learningItemDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learningEvents-learningItemDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "learningItemDeletionReasonCode":{
            "title":"Learning Deletion Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for deleting the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Deletion Reason Code"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemDescription":{
            "title":"Learning Description",
            "maxLength":4000,
            "type":"string",
            "description":"Plain text version of the long description of the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Description"
                }
            },
            "x-queryable":true
        },
        "learningItemDetailsDeepLink":{
            "title":"Learning Details Deep Link",
            "type":"string",
            "description":"URL to open the learning item page directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Details Deep Link"
                }
            },
            "x-queryable":true
        },
        "learningItemDetailsEmbedLink":{
            "title":"Learning Embed Deep Link",
            "type":"string",
            "description":"URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Embed Deep Link"
                }
            },
            "x-queryable":true
        },
        "learningItemEnrollCondition":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates when a learner can enroll in this learning item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemEnrollmentEndDate":{
            "type":"string",
            "description":"Date when the enrollment period ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemEnrollmentStartDate":{
            "type":"string",
            "description":"Date when the enrollment period begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemEnrollmentVisibilityMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemExcludeFromHistory":{
            "title":"Learning Exclude from History",
            "type":"string",
            "description":"Indicates whether to exclude the learning from the transcript. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Exclude from History"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "learningItemExpectedEffortInSeconds":{
            "title":"Learning Expected Effort",
            "type":"number",
            "description":"Expected effort needed by the learner to complete the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Expected Effort"
                }
            },
            "x-queryable":true
        },
        "learningItemFeatureEndDate":{
            "title":"Learning Feature Start Date",
            "type":"string",
            "description":"Date when the learning item stops being featured.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Feature Start Date"
                }
            },
            "x-queryable":true
        },
        "learningItemFeatureStartDate":{
            "title":"Learning Feature End Date",
            "type":"string",
            "description":"Date when the learning item starts being featured.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Feature End Date"
                }
            },
            "x-queryable":true
        },
        "learningItemId":{
            "type":"integer",
            "description":"Learning item Id of the course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemKeepCompletionsOnDelete":{
            "title":"Learning Keep Completions on Delete",
            "type":"string",
            "description":"Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Keep Completions on Delete"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "learningItemLastModifiedByDisplayName":{
            "title":"Learning Last Modified By",
            "type":"string",
            "description":"Display name of the person who last modified the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Last Modified By"
                }
            }
        },
        "learningItemLastModifiedDate":{
            "title":"Learning Last Modified Date",
            "type":"string",
            "description":"Date when the learning item was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Last Modified Date"
                }
            },
            "x-queryable":true
        },
        "learningItemLearnerDataCollectionTypeESS":{
            "maxLength":255,
            "type":"string",
            "description":"Determines how the learner information is collected, such as questionnaire or form.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemLearnerDataQuestionnaireCodeESS":{
            "maxLength":255,
            "type":"string",
            "description":"Unique code for the questionnaire.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemLearnerDataQuestionnaireNameESS":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemLearningLevel":{
            "title":"Learning Level",
            "maxLength":32,
            "type":"string",
            "description":"Learning level, such as Beginner, Moderate, or Advanced.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Level"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemLearningPathOverridesVisibility":{
            "title":"Learning Path Override",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Path Override"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemLongDescription":{
            "title":"Learning Long Description",
            "type":"string",
            "description":"Long, rich text description of the learning item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Long Description"
                }
            }
        },
        "learningItemMarkCompleteMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the manager can mark an enrollment as complete. Possible values are Y or N. Default value is Y.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemNotificationMessage":{
            "maxLength":255,
            "type":"string",
            "description":"Notification message text sent to the learners.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemNotificationPattern":{
            "title":"Learning Notification Pattern",
            "maxLength":32,
            "type":"string",
            "description":"Notification pattern, such as Default Notification Pattern.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Notification Pattern"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemNumber":{
            "title":"Learning Number",
            "maxLength":2000,
            "type":"string",
            "description":"User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Number"
                },
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "learningItemParentId":{
            "type":"integer",
            "description":"Learning item identifier for the parent.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemParentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Learning item number for the parent.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "learningItemParentId"
                ]
            },
            "x-queryable":true
        },
        "learningItemPreviewURL":{
            "title":"Learning Preview URL",
            "type":"string",
            "description":"URL used by the administrator to preview the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Preview URL"
                }
            },
            "x-queryable":true
        },
        "learningItemPublishEndDate":{
            "title":"Learning Publish End Date",
            "type":"string",
            "description":"Date when the learning item stops being visible in the learning catalog.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Publish End Date"
                }
            },
            "x-queryable":true
        },
        "learningItemPublishStartDate":{
            "title":"Learning Publish Start Date",
            "type":"string",
            "description":"Date when the learning item starts being visible in the learning catalog.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Publish Start Date"
                }
            },
            "x-queryable":true
        },
        "learningItemPublisher":{
            "title":"Learning Publisher",
            "maxLength":32,
            "type":"string",
            "description":"Learning item publisher, such as Learning Department.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Publisher"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemPublisherName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the publisher of the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemRatingAverage":{
            "title":"Learning Rating Average",
            "type":"integer",
            "description":"Rating average for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Rating Average"
                }
            }
        },
        "learningItemRatingCount":{
            "title":"Learning Rating Count",
            "type":"integer",
            "description":"Rating count for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Rating Count"
                }
            }
        },
        "learningItemReactivationReasonCode":{
            "title":"Learning Reactivation Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for moving the inactive learning item to active status.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Reactivation Reason Code"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemSelfEnrollmentURL":{
            "title":"Learning Self Enrollment URL",
            "type":"string",
            "description":"URL for the learner to self enroll",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Self Enrollment URL"
                }
            },
            "x-queryable":true
        },
        "learningItemShortDescription":{
            "title":"Learning Short Description",
            "type":"string",
            "description":"Short description of the learning item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Short Description"
                }
            }
        },
        "learningItemStatus":{
            "title":"Learning Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item.",
            "nullable":false,
            "default":"ORA_DRAFT",
            "x-hints":{
                "help":{
                    "instruction":"Learning Status"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemStatusComment":{
            "title":"Learning Status Comment",
            "maxLength":4000,
            "type":"string",
            "description":"Status change comment for the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Status Comment"
                }
            },
            "x-queryable":true
        },
        "learningItemSupportedLanguages":{
            "title":"Learning Supported Languages",
            "type":"string",
            "description":"List of languages the learning item supports.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Supported Languages"
                }
            }
        },
        "learningItemTitle":{
            "title":"Learning Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Title"
                }
            },
            "x-queryable":true
        },
        "learningItemTrailerLink":{
            "title":"Learning Trailer Link",
            "type":"string",
            "description":"URL to open the learning item trailer directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Learning Trailer Link"
                }
            },
            "x-queryable":true
        },
        "learningItemType":{
            "title":"Learning Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of learning item, such as video, online course, document, assessment, or observation checklist.",
            "nullable":true,
            "default":"ORA_EVENT",
            "x-hints":{
                "help":{
                    "instruction":"Learning Type"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "title":"Learning Type Meaning",
            "type":"string",
            "description":"Meaning for the learningItemType attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Type Meaning"
                }
            }
        },
        "learningItemVisibility":{
            "title":"Learning Visibility",
            "maxLength":32,
            "type":"string",
            "description":"Visibility of the learning item, such as Public or Secret.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Visibility"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemWithdrawalRuleESS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how the learner's assignment withdrawals are processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "learningItemWithdrawalRuleMSS":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how the manager's assignment withdrawals are processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "messages":{
            "title":"Messages",
            "type":"array",
            "description":"The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-messages-item-response"
            }
        },
        "metrics":{
            "title":"Learning Catalog Item Metrics",
            "type":"array",
            "description":"The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-metrics-item-response"
            }
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-relatedMaterials-item-response"
            }
        },
        "userActionHints":{
            "title":"User Action Hints",
            "type":"array",
            "description":"The userActionHints resource provides hints for possible actions on its parent resource.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-userActionHints-item-response"
            }
        },
        "whereUsed":{
            "title":"Where Used",
            "type":"array",
            "description":"The whereUsed resource provides details about the uses of a learning item in topics and learning communities.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-whereUsed-item-response"
            }
        }
    }
}

Nested Schema : Activities

Type: array

Title: Activities

The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.

Show Source

• Array of: object learningEvents-activities-item-response

{
    "title":"Activities",
    "type":"array",
    "description":"The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-item-response"
    }
}

Nested Schema : Learning Content Assets

Type: array

Title: Learning Content Assets

The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.

Show Source

• Array of: object learningEvents-assets-item-response

{
    "title":"Learning Content Assets",
    "type":"array",
    "description":"The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-assets-item-response"
    }
}

Nested Schema : Learner Feedback

Type: array

Title: Learner Feedback

The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.

Show Source

• Array of: object learningEvents-learnerFeedback-item-response

{
    "title":"Learner Feedback",
    "type":"array",
    "description":"The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-learnerFeedback-item-response"
    }
}

Nested Schema : learningItemDFF

Type: array

Show Source

• Array of: object learningEvents-learningItemDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learningEvents-learningItemDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Messages

Type: array

Title: Messages

The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.

Show Source

• Array of: object learningEvents-messages-item-response

{
    "title":"Messages",
    "type":"array",
    "description":"The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-messages-item-response"
    }
}

Nested Schema : Learning Catalog Item Metrics

Type: array

Title: Learning Catalog Item Metrics

The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.

Show Source

• Array of: object learningEvents-metrics-item-response

{
    "title":"Learning Catalog Item Metrics",
    "type":"array",
    "description":"The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-metrics-item-response"
    }
}

Nested Schema : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-relatedMaterials-item-response

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-relatedMaterials-item-response"
    }
}

Nested Schema : User Action Hints

Type: array

Title: User Action Hints

The userActionHints resource provides hints for possible actions on its parent resource.

Show Source

• Array of: object learningEvents-userActionHints-item-response

{
    "title":"User Action Hints",
    "type":"array",
    "description":"The userActionHints resource provides hints for possible actions on its parent resource.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-userActionHints-item-response"
    }
}

Nested Schema : Where Used

Type: array

Title: Where Used

The whereUsed resource provides details about the uses of a learning item in topics and learning communities.

Show Source

• Array of: object learningEvents-whereUsed-item-response

{
    "title":"Where Used",
    "type":"array",
    "description":"The whereUsed resource provides details about the uses of a learning item in topics and learning communities.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-whereUsed-item-response"
    }
}

Nested Schema : learningEvents-activities-item-response

Type: object

Show Source

• activityId: integer (int64)
  Title: Activity ID

  Unique identifier for the activity.
• activityNumber: string
  Title: Activity Number

  Maximum Length: 2000

  Friendly number identifying the activity.
• activityType: string
  Title: Activity Type

  Maximum Length: 30

  Default Value: ORA_ILT_ACTIVITY

  Activity type, such as Internal or External.
• adhocResources: array Ad Hoc Resources
  Title: Ad Hoc Resources

  The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.
• attendanceConfirmationURL: string
  Read Only: true

  Maximum Length: 255

  Link to the page where the learner can confirm attendance for an activity.
• attendanceQRDownloadURL: string
  Read Only: true

  Maximum Length: 255

  Link to the page where the learner can download the QR code to confirm attendance for an activity.
• classroomDetails: array Classrooms
  Title: Classrooms

  The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
• classroomDisplayName: string
  Title: Classroom Title

  Maximum Length: 2000

  Display name of the activity classrooms.
• classrooms: string
  Title: Classrooms

  List of activity classrooms.
• completionRule: string
  Title: Completion Rule

  Maximum Length: 30

  Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required.
• completionType: string
  Maximum Length: 30

  Completion type for the activity, such as Mandatory or Optional.
• description: string
  Title: Activity Description

  Description for the activity.
• endDate: string
  Title: Activity End Date

  End date for the activity.
• expectedEffortInSeconds: number
  Title: Expected Efforts

  Expected effort needed by the learner to complete the learning item.
• externalDetailsURL: string
  Title: External Details URL

  Maximum Length: 2000

  Details URL for the activity.
• instructorDetails: array Instructors
  Title: Instructors

  The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
• instructors: string
  Title: Instructors

  List of activity instructors.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedMaterials: array Related Materials
  Title: Related Materials

  The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.
• startDate: string
  Title: Activity Start Date

  Start date for the activity.
• status: string
  Title: Status

  Maximum Length: 30

  Status for the activity
• timezone: string
  Title: Time Zone

  Maximum Length: 30

  Time zone for the activity
• title: string
  Title: Title

  Maximum Length: 250

  Title of the activity.
• virtualClassroomURL: string
  Title: Virtual Classroom URL

  Maximum Length: 500

  Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.

{
    "type":"object",
    "properties":{
        "activityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier for the activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Activity ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "activityNumber":{
            "title":"Activity Number",
            "maxLength":2000,
            "type":"string",
            "description":"Friendly number identifying the activity.",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Activity Number"
                },
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "activityType":{
            "title":"Activity Type",
            "maxLength":30,
            "type":"string",
            "description":"Activity type, such as Internal or External.",
            "nullable":true,
            "default":"ORA_ILT_ACTIVITY",
            "x-hints":{
                "help":{
                    "instruction":"Activity Type"
                },
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "adhocResources":{
            "title":"Ad Hoc Resources",
            "type":"array",
            "description":"The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-adhocResources-item-response"
            }
        },
        "attendanceConfirmationURL":{
            "maxLength":255,
            "type":"string",
            "description":"Link to the page where the learner can confirm attendance for an activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attendanceQRDownloadURL":{
            "maxLength":255,
            "type":"string",
            "description":"Link to the page where the learner can download the QR code to confirm attendance for an activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "classroomDetails":{
            "title":"Classrooms",
            "type":"array",
            "description":"The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-classroomDetails-item-response"
            }
        },
        "classroomDisplayName":{
            "title":"Classroom Title",
            "maxLength":2000,
            "type":"string",
            "description":"Display name of the activity classrooms.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Classroom Title"
                }
            },
            "x-queryable":true
        },
        "classrooms":{
            "title":"Classrooms",
            "type":"string",
            "description":"List of activity classrooms.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Classrooms"
                }
            }
        },
        "completionRule":{
            "title":"Completion Rule",
            "maxLength":30,
            "type":"string",
            "description":"Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Completion Rule"
                },
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "completionType":{
            "maxLength":30,
            "type":"string",
            "description":"Completion type for the activity, such as Mandatory or Optional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "description":{
            "title":"Activity Description",
            "type":"string",
            "description":"Description for the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Activity Description"
                }
            }
        },
        "endDate":{
            "title":"Activity End Date",
            "type":"string",
            "description":"End date for the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Activity End Date"
                }
            },
            "x-queryable":true
        },
        "expectedEffortInSeconds":{
            "title":"Expected Efforts",
            "type":"number",
            "description":"Expected effort needed by the learner to complete the learning item.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Expected Efforts"
                }
            },
            "x-queryable":true
        },
        "externalDetailsURL":{
            "title":"External Details URL",
            "maxLength":2000,
            "type":"string",
            "description":"Details URL for the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"External Details URL"
                }
            },
            "x-queryable":true
        },
        "instructorDetails":{
            "title":"Instructors",
            "type":"array",
            "description":"The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-instructorDetails-item-response"
            }
        },
        "instructors":{
            "title":"Instructors",
            "type":"string",
            "description":"List of activity instructors.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Instructors"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-item-response"
            }
        },
        "startDate":{
            "title":"Activity Start Date",
            "type":"string",
            "description":"Start date for the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Activity Start Date"
                }
            },
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status for the activity",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                }
            },
            "x-queryable":true
        },
        "timezone":{
            "title":"Time Zone",
            "maxLength":30,
            "type":"string",
            "description":"Time zone for the activity",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Time Zone"
                }
            },
            "x-queryable":true
        },
        "title":{
            "title":"Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Title"
                }
            }
        },
        "virtualClassroomURL":{
            "title":"Virtual Classroom URL",
            "maxLength":500,
            "type":"string",
            "description":"Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"Virtual Classroom URL"
                }
            }
        }
    }
}

Nested Schema : Ad Hoc Resources

Type: array

Title: Ad Hoc Resources

The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.

Show Source

• Array of: object learningEvents-activities-adhocResources-item-response

{
    "title":"Ad Hoc Resources",
    "type":"array",
    "description":"The adhocResources resources captures the details of additional resources required for an instructor-led training, such as printers or whiteboards.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-adhocResources-item-response"
    }
}

Nested Schema : Classrooms

Type: array

Title: Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Show Source

• Array of: object learningEvents-activities-classroomDetails-item-response

{
    "title":"Classrooms",
    "type":"array",
    "description":"The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-classroomDetails-item-response"
    }
}

Nested Schema : Instructors

Type: array

Title: Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Show Source

• Array of: object learningEvents-activities-instructorDetails-item-response

{
    "title":"Instructors",
    "type":"array",
    "description":"The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-instructorDetails-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 : Related Materials

Type: array

Title: Related Materials

The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-activities-relatedMaterials-item-response

{
    "title":"Related Materials",
    "type":"array",
    "description":"The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-item-response"
    }
}

Nested Schema : learningEvents-activities-adhocResources-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• resourceDescription: string
  Maximum Length: 4000

  Description for the resource.
• resourceId: integer (int64)
  Unique identifier for the resource.
• resourceName: string
  Maximum Length: 100

  Display name of the resource.
• resourceNumber: string
  Maximum Length: 30

  Friendly number for identifying a resource.
• resourceQuantity: number
  Quantity for the resource.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "resourceDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description for the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "resourceId":{
            "type":"integer",
            "description":"Unique identifier for the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "resourceName":{
            "maxLength":100,
            "type":"string",
            "description":"Display name of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "resourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for identifying a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "resourceQuantity":{
            "type":"number",
            "description":"Quantity for the resource.",
            "nullable":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 : learningEvents-activities-classroomDetails-item-response

Type: object

Show Source

• classroomDescription: string
  Title: Classroom Description

  Read Only: true

  Maximum Length: 4000

  Description of the classroom.
• classroomId: integer (int64)
  Title: Classroom ID

  Read Only: true

  Application-generated primary key for a classroom.
• classroomNumber: string
  Title: Classroom Number

  Read Only: true

  Maximum Length: 30

  Friendly number for identifying a classroom.
• classroomTitle: string
  Title: Classroom Title

  Read Only: true

  Maximum Length: 250

  Name of the classroom.
• contactPersonDisplayName: string
  Title: Contact Person Display Name

  Read Only: true

  Maximum Length: 240

  Display name for the person who's the classroom contact.
• contactPersonId: integer (int64)
  Title: Contact Person ID

  Read Only: true

  Identifier for the person who's the classroom contact.
• contactPersonImageURL: string
  Title: Contact Person Image URL

  Read Only: true

  Maximum Length: 32

  Image URL for the person who's the classroom contact.
• contactPersonNumber: string
  Title: Contact Person Number

  Read Only: true

  Maximum Length: 30

  Person number for the classroom contact person.
• contactPersonPrimaryEmailAddress: string
  Title: Contact Person Primary Email Address

  Read Only: true

  Maximum Length: 60

  Primary email address of the person who's the classroom contact.
• contactPersonPrimaryPhoneNumber: string
  Title: Contact Person Primary Phone Number

  Read Only: true

  Maximum Length: 240

  Primary phone number for the person who's the classroom contact.
• isPrimaryClassroom: string
  Title: Primary Classroom

  Read Only: true

  Maximum Length: 1

  Indicates whether the classroom is a primary classroom. The default value is N. Valid values are Y and N.
• isPrimaryClassroomMeaning: string
  Title: Primary Classroom Description

  Read Only: true

  Maximum Length: 4000

  Description of the value of the isPrimaryClassroom attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• locationAddressLine1: string
  Title: Location Address Line 1

  Read Only: true

  Maximum Length: 240

  Location address line 1.
• locationAddressLine2: string
  Title: Location Address Line 2

  Read Only: true

  Maximum Length: 240

  Location address line 2.
• locationAddressLine3: string
  Title: Location Address Line 3

  Read Only: true

  Maximum Length: 240

  Location address line 3.
• locationCity: string
  Title: Location City

  Read Only: true

  Maximum Length: 60

  City of the classroom.
• locationCountry: string
  Title: Location Country

  Read Only: true

  Maximum Length: 60

  Country of the classroom.
• locationDisplayString: string
  Title: Location Display String

  Read Only: true

  Maximum Length: 32

  Complete classroom address in the string format.
• locationLatitude: number
  Title: Location Latitude

  Read Only: true

  Latitude of the classroom.
• locationLongitude: number
  Title: Location Longitude

  Read Only: true

  Longitude of the classroom.
• locationName: string
  Title: Location Name

  Read Only: true

  Maximum Length: 240

  Location of the classroom.
• locationSingleLineString: string
  Read Only: true

  Maximum Length: 1732

  Location of the classroom expressed as a single line string.
• locationZipCode: string
  Title: Location ZIP Code

  Read Only: true

  Maximum Length: 30

  Postal code of the location address.

{
    "type":"object",
    "properties":{
        "classroomDescription":{
            "title":"Classroom Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Classroom Description"
                }
            },
            "x-queryable":true
        },
        "classroomId":{
            "title":"Classroom ID",
            "type":"integer",
            "description":"Application-generated primary key for a classroom.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Classroom ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "classroomNumber":{
            "title":"Classroom Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for identifying a classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Classroom Number"
                }
            },
            "x-queryable":true
        },
        "classroomTitle":{
            "title":"Classroom Title",
            "maxLength":250,
            "type":"string",
            "description":"Name of the classroom.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Classroom Title"
                }
            },
            "x-queryable":true
        },
        "contactPersonDisplayName":{
            "title":"Contact Person Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name for the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Contact Person Display Name"
                }
            },
            "x-queryable":true
        },
        "contactPersonId":{
            "title":"Contact Person ID",
            "type":"integer",
            "description":"Identifier for the person who's the classroom contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Contact Person ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "contactPersonImageURL":{
            "title":"Contact Person Image URL",
            "maxLength":32,
            "type":"string",
            "description":"Image URL for the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Contact Person Image URL"
                }
            },
            "x-queryable":true
        },
        "contactPersonNumber":{
            "title":"Contact Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number for the classroom contact person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Contact Person Number"
                }
            },
            "x-queryable":true
        },
        "contactPersonPrimaryEmailAddress":{
            "title":"Contact Person Primary Email Address",
            "maxLength":60,
            "type":"string",
            "description":"Primary email address of the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Contact Person Primary Email Address"
                }
            },
            "x-queryable":true
        },
        "contactPersonPrimaryPhoneNumber":{
            "title":"Contact Person Primary Phone Number",
            "maxLength":240,
            "type":"string",
            "description":"Primary phone number for the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Contact Person Primary Phone Number"
                }
            },
            "x-queryable":true
        },
        "isPrimaryClassroom":{
            "title":"Primary Classroom",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the classroom is a primary classroom. The default value is N. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Primary Classroom"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "isPrimaryClassroomMeaning":{
            "title":"Primary Classroom Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the isPrimaryClassroom attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Primary Classroom Description"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "locationAddressLine1":{
            "title":"Location Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 1.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Address Line 1"
                }
            },
            "x-queryable":true
        },
        "locationAddressLine2":{
            "title":"Location Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 2.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Address Line 2"
                }
            },
            "x-queryable":true
        },
        "locationAddressLine3":{
            "title":"Location Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 3.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Address Line 3"
                }
            },
            "x-queryable":true
        },
        "locationCity":{
            "title":"Location City",
            "maxLength":60,
            "type":"string",
            "description":"City of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location City"
                }
            },
            "x-queryable":true
        },
        "locationCountry":{
            "title":"Location Country",
            "maxLength":60,
            "type":"string",
            "description":"Country of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Country"
                }
            },
            "x-queryable":true
        },
        "locationDisplayString":{
            "title":"Location Display String",
            "maxLength":32,
            "type":"string",
            "description":"Complete classroom address in the string format.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Display String"
                }
            },
            "x-queryable":true
        },
        "locationLatitude":{
            "title":"Location Latitude",
            "type":"number",
            "description":"Latitude of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Latitude"
                }
            },
            "x-queryable":true
        },
        "locationLongitude":{
            "title":"Location Longitude",
            "type":"number",
            "description":"Longitude of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Longitude"
                }
            },
            "x-queryable":true
        },
        "locationName":{
            "title":"Location Name",
            "maxLength":240,
            "type":"string",
            "description":"Location of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location Name"
                }
            },
            "x-queryable":true
        },
        "locationSingleLineString":{
            "maxLength":1732,
            "type":"string",
            "description":"Location of the classroom expressed as a single line string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationZipCode":{
            "title":"Location ZIP Code",
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the location address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Location ZIP Code"
                }
            },
            "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 : learningEvents-activities-instructorDetails-item-response

Type: object

Show Source

• instructorId: integer (int64)
  Title: Instructor ID

  Read Only: true

  Unique identifier for the instructor.
• instructorNumber: string
  Title: Instructor Number

  Read Only: true

  Maximum Length: 19

  Friendly number for identifying the instructor.
• isPrimaryInstructor: string
  Title: Primary Instructor

  Read Only: true

  Maximum Length: 1

  Indicates whether the person is the primary instructor. The default value is N. Valid values are Y and N.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 240

  Display name for the instructor.
• personId: integer (int64)
  Title: Instructor Person ID

  Read Only: true

  Identifier for the person who's the instructor.
• personImageURL: string
  Title: Instructor Image URL

  Read Only: true

  Maximum Length: 32

  Image URL for the instructor for the learning item.
• personNumber: string
  Title: Instructor Person Number

  Read Only: true

  Maximum Length: 30

  Person number for the instructor.
• personPrimaryEmailAddress: string
  Title: Instructor Primary Email Address

  Read Only: true

  Maximum Length: 60

  Primary Email address of the instructor for the learning item.
• personPrimaryPhoneNumber: string
  Title: Instructor Primary Phone Number

  Read Only: true

  Maximum Length: 240

  Phone number of the instructor of the learning item.
• status: string
  Read Only: true

  Maximum Length: 30

  Status for the instructor.

{
    "type":"object",
    "properties":{
        "instructorId":{
            "title":"Instructor ID",
            "type":"integer",
            "description":"Unique identifier for the instructor.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "instructorNumber":{
            "title":"Instructor Number",
            "maxLength":19,
            "type":"string",
            "description":"Friendly number for identifying the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor Number"
                }
            },
            "x-queryable":true
        },
        "isPrimaryInstructor":{
            "title":"Primary Instructor",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the person is the primary instructor. The default value is N. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Primary Instructor"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "personDisplayName":{
            "title":"Instructor",
            "maxLength":240,
            "type":"string",
            "description":"Display name for the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor"
                }
            },
            "x-queryable":true
        },
        "personId":{
            "title":"Instructor Person ID",
            "type":"integer",
            "description":"Identifier for the person who's the instructor.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor Person ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "personImageURL":{
            "title":"Instructor Image URL",
            "maxLength":32,
            "type":"string",
            "description":"Image URL for the instructor for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor Image URL"
                },
                "dependencies":[
                    "personId"
                ]
            },
            "x-queryable":true
        },
        "personNumber":{
            "title":"Instructor Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number for the instructor.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor Person Number"
                }
            },
            "x-queryable":true
        },
        "personPrimaryEmailAddress":{
            "title":"Instructor Primary Email Address",
            "maxLength":60,
            "type":"string",
            "description":"Primary Email address of the instructor for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor Primary Email Address"
                }
            },
            "x-queryable":true
        },
        "personPrimaryPhoneNumber":{
            "title":"Instructor Primary Phone Number",
            "maxLength":240,
            "type":"string",
            "description":"Phone number of the instructor of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Instructor Primary Phone Number"
                }
            },
            "x-queryable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the instructor.",
            "nullable":true,
            "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 : learningEvents-activities-relatedMaterials-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedMaterialsBinaries":{
            "title":"Related Materials Binaries",
            "type":"array",
            "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-response"
            }
        },
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "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 : Related Materials Binaries

Type: array

Title: Related Materials Binaries

The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-response

{
    "title":"Related Materials Binaries",
    "type":"array",
    "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-response"
    }
}

Nested Schema : learningEvents-activities-relatedMaterials-relatedMaterialsBinaries-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided by the Attachment UI components to support the upload of files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Attachment creator.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the attachment creator.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Surrogate identifier for the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  Folder path where the attachment will be created.
• DownloadInfo: string
  Title: DownloadInfo

  Version number for the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date for the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Title: File Url

  Name for the attachment file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  File URL for the attachment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Date when attachment record was most recently updated.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the person who most recently updated the attachment record.
• links: array Links
  Title: Links

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

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  User name of the person who most recently updated the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  URL for a web page type attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Attachment creator.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the attachment creator.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"File URL for the attachment.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Date when attachment record was most recently updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the person who most recently updated the attachment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"User name of the person who most recently updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"URL for a web page type attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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 : learningEvents-assets-item-response

Type: object

Show Source

• addedOnDate: string (date-time)
  Read Only: true

  Date when the learning item was added to the learning catalog.
• assetBinaries: array Content Binaries
  Title: Content Binaries

  The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• assetId: integer (int64)
  Unique identifier for the learning item asset, such as cover art or a trailer.
• assetNumber: string
  Maximum Length: 30

  User-friendly number identifying the learning item asset, such as cover art or a trailer.
• highRenditionLink: string
  Read Only: true

  Maximum Length: 255

  Link to the high rendition version of the learning cover art image.
• learningItemId: integer (int64)
  Title: Learning Item ID

  The learning item identifier of the asset.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• lowRenditionLink: string
  Read Only: true

  Maximum Length: 255

  Link to the low rendition version of the learning cover art image.
• medRenditionLink: string
  Read Only: true

  Maximum Length: 255

  Link to the medium rendition version of the learning cover art image.
• primary: string
  Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
• relationshipType: string
  Maximum Length: 30

  Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC.
• sourceURL: string
  Maximum Length: 2000

  Web link to the image source location.
• status: string
  Maximum Length: 30

  Status of the learning item asset.
• type: string
  Maximum Length: 30

  Indicates the type of learning asset, such as cover art or a trailer.

{
    "type":"object",
    "properties":{
        "addedOnDate":{
            "type":"string",
            "description":"Date when the learning item was added to the learning catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "assetBinaries":{
            "title":"Content Binaries",
            "type":"array",
            "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-assets-assetBinaries-item-response"
            }
        },
        "assetId":{
            "type":"integer",
            "description":"Unique identifier for the learning item asset, such as cover art or a trailer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "assetNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-friendly number identifying the learning item asset, such as cover art or a trailer.",
            "nullable":true,
            "x-queryable":true
        },
        "highRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"Link to the high rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "title":"Learning Item ID",
            "type":"integer",
            "description":"The learning item identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "help":{
                    "instruction":"Learning Item ID"
                },
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "lowRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"Link to the low rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "medRenditionLink":{
            "maxLength":255,
            "type":"string",
            "description":"Link to the medium rendition version of the learning cover art image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "primary":{
            "type":"string",
            "description":"Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            }
        },
        "relationshipType":{
            "maxLength":30,
            "type":"string",
            "description":"Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "sourceURL":{
            "maxLength":2000,
            "type":"string",
            "description":"Web link to the image source location.",
            "nullable":true,
            "x-queryable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the learning item asset.",
            "nullable":true,
            "x-queryable":true
        },
        "type":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of learning asset, such as cover art or a trailer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Content Binaries

Type: array

Title: Content Binaries

The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-assets-assetBinaries-item-response

{
    "title":"Content Binaries",
    "type":"array",
    "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-assets-assetBinaries-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 : learningEvents-assets-assetBinaries-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided by the Attachment UI components to support the upload of files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Attachment creator.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the attachment creator.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description for the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Surrogate identifier for the document attached.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment will be created.
• DmVersionNumber: string
  Maximum Length: 255

  Version number for the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  Read Only: true

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Expiration date for the attachment. This is a read-only attribute.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Actual content of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name for the attachment file.
• FileUrl: string
  Title: File Url

  File URL for the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when attachment record was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Name of the person who most recently updated the attachment record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name of the person who most recently updated the attachment.
• links: array Links
  Title: Links

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

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL for a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Attachment creator.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the attachment creator.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when attachment record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who most recently updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name of the person who most recently updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL for a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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 : learningEvents-learnerFeedback-item-response

Type: object

Show Source

• feedbackCondition: string
  Maximum Length: 80

  Default Value: ORA_NONE

  Determines when the learner can provide feedback, such as after start or after successful completion.
• feedbackId: integer (int64)
  Unique identifier for the feedback.
• feedbackType: string
  Maximum Length: 30

  Type of feedback, such as rating or evaluation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• questionnaireCode: string
  Maximum Length: 80

  Unique code for the questionnaire.
• questionnaireName: string
  Read Only: true

  Maximum Length: 80

  Name of the questionnaire.
• requireFeedback: string
  Maximum Length: 80

  Default Value: N

  Indicates whether feedback is required. Valid values are Y or N

{
    "type":"object",
    "properties":{
        "feedbackCondition":{
            "maxLength":80,
            "type":"string",
            "description":"Determines when the learner can provide feedback, such as after start or after successful completion.",
            "nullable":true,
            "default":"ORA_NONE",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        },
        "feedbackId":{
            "type":"integer",
            "description":"Unique identifier for the feedback.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "feedbackType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of feedback, such as rating or evaluation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questionnaireCode":{
            "maxLength":80,
            "type":"string",
            "description":"Unique code for the questionnaire.",
            "nullable":true,
            "x-queryable":false
        },
        "questionnaireName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "requireFeedback":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether feedback is required. Valid values are Y or N",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            }
        }
    }
}

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 : learningEvents-learningItemDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EffectiveEndDate: string (date)
• EffectiveStartDate: string (date)
• LearningItemId: integer (int64)
• LearningItemType: string
  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LearningItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LearningItemType":{
            "maxLength":32,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : learningEvents-messages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• message: string
  Read Only: true

  User-friendly string describing the message.
• messageCode: string
  Read Only: true

  Code to indicate the type of message.
• messageSecondaryText: string
  Read Only: true

  Secondary text for the message.
• messageSeverity: string
  Read Only: true

  Indicates the severity of the message like: INFO, WARN, or FATAL.
• visibility: string
  Read Only: true

  Maximum Length: 8

  Determines the message visibility. Valid values are Show or Hide.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "message":{
            "type":"string",
            "description":"User-friendly string describing the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "messageCode":{
            "type":"string",
            "description":"Code to indicate the type of message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "messageSecondaryText":{
            "type":"string",
            "description":"Secondary text for the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "messageSeverity":{
            "type":"string",
            "description":"Indicates the severity of the message like: INFO, WARN, or FATAL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "visibility":{
            "maxLength":8,
            "type":"string",
            "description":"Determines the message visibility. Valid values are Show or Hide.",
            "nullable":true,
            "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 : learningEvents-metrics-item-response

Type: object

Show Source

• activeCountLearners: number
  Read Only: true

  Count of active learners.
• availableCapacity: number
  Read Only: true

  Available capacity for this learning.
• averageActualEffortPERAttempt: number
  Read Only: true

  Average of the actual effort per attempt.
• averageAttemptsPERCompletion: number
  Read Only: true

  Average of the actual effort per completion.
• averageRating: number
  Read Only: true

  Rating average for the learning catalog item.
• completedCount: number
  Read Only: true

  Count of completed enrollments.
• conversationCount: number
  Read Only: true

  Count of conversations on the learning item.
• currentCountEnrollments: number
  Read Only: true

  Count of enrollments that are either in active or preactive status.
• currentCountLearners: number
  Read Only: true

  Count of unique learners whose enrollments are in either in active or preactive status.
• failCountEnrollments: number
  Read Only: true

  Count of enrollments with failed status.
• failCountLearners: number
  Read Only: true

  Count of learners who failed the learning item.
• futureCountEnrollments: number
  Read Only: true

  Count of future-dated enrollments.
• futureCountLearners: number
  Read Only: true

  Count of learners with future-dated enrollments.
• inProgressCount: number
  Read Only: true

  Count of in-progress enrollments.
• learningItemId: integer
  Read Only: true

  Unique identifier for the learning item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• notInterestedCount: number
  Read Only: true

  Count of learners who aren't interested in the learning item.
• passCountEnrollments: number
  Read Only: true

  Count of enrollments with passed status.
• passCountLearners: number
  Read Only: true

  Count of learners who passed the learning item.
• preactiveCountLearners: number
  Read Only: true

  Count of preactive learners.
• totalRatings: number
  Read Only: true

  Rating count for the learning catalog item.
• totalViewCount: number
  Read Only: true

  Count of views on the learning item.
• viewCountInLastThirtyDays: number
  Read Only: true

  Count of views on the learning item in the past 30 days.
• waitlistCapacity: number
  Read Only: true

  Waitlist capacity for this learning.
• whereUsedCount: number
  Read Only: true

  Count of learning items, such as communities, journeys, user groups, and specializations that use the learning item.
• withdrawCountEnrollments: number
  Read Only: true

  Count of withdrawn enrollments.

{
    "type":"object",
    "properties":{
        "activeCountLearners":{
            "type":"number",
            "description":"Count of active learners.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "availableCapacity":{
            "type":"number",
            "description":"Available capacity for this learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageActualEffortPERAttempt":{
            "type":"number",
            "description":"Average of the actual effort per attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageAttemptsPERCompletion":{
            "type":"number",
            "description":"Average of the actual effort per completion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "averageRating":{
            "type":"number",
            "description":"Rating average for the learning catalog item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completedCount":{
            "type":"number",
            "description":"Count of completed enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "conversationCount":{
            "type":"number",
            "description":"Count of conversations on the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments that are either in active or preactive status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currentCountLearners":{
            "type":"number",
            "description":"Count of unique learners whose enrollments are in either in active or preactive status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "failCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments with failed status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "failCountLearners":{
            "type":"number",
            "description":"Count of learners who failed the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "futureCountEnrollments":{
            "type":"number",
            "description":"Count of future-dated enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "futureCountLearners":{
            "type":"number",
            "description":"Count of learners with future-dated enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "inProgressCount":{
            "type":"number",
            "description":"Count of in-progress enrollments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "notInterestedCount":{
            "type":"number",
            "description":"Count of learners who aren't interested in the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passCountEnrollments":{
            "type":"number",
            "description":"Count of enrollments with passed status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passCountLearners":{
            "type":"number",
            "description":"Count of learners who passed the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "preactiveCountLearners":{
            "type":"number",
            "description":"Count of preactive learners.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalRatings":{
            "type":"number",
            "description":"Rating count for the learning catalog item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalViewCount":{
            "type":"number",
            "description":"Count of views on the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "viewCountInLastThirtyDays":{
            "type":"number",
            "description":"Count of views on the learning item in the past 30 days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "waitlistCapacity":{
            "type":"number",
            "description":"Waitlist capacity for this learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "whereUsedCount":{
            "type":"number",
            "description":"Count of learning items, such as communities, journeys, user groups, and specializations that use the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "withdrawCountEnrollments":{
            "type":"number",
            "description":"Count of withdrawn enrollments.",
            "nullable":true,
            "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 : learningEvents-relatedMaterials-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedMaterialsBinaries: array Related Materials Binaries
  Title: Related Materials Binaries

  The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
• visibility: string
  Maximum Length: 80

  Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "relatedMaterialsBinaries":{
            "title":"Related Materials Binaries",
            "type":"array",
            "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
            "items":{
                "$ref":"#/components/schemas/learningEvents-relatedMaterials-relatedMaterialsBinaries-item-response"
            }
        },
        "visibility":{
            "maxLength":80,
            "type":"string",
            "description":"Determines who can view or edit the attachments, such as Administrators, Administrators and Enrollees, or Administrators and Self Service.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "CATEGORY":"General"
            },
            "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 : Related Materials Binaries

Type: array

Title: Related Materials Binaries

The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.

Show Source

• Array of: object learningEvents-relatedMaterials-relatedMaterialsBinaries-item-response

{
    "title":"Related Materials Binaries",
    "type":"array",
    "description":"The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.",
    "items":{
        "$ref":"#/components/schemas/learningEvents-relatedMaterials-relatedMaterialsBinaries-item-response"
    }
}

Nested Schema : learningEvents-relatedMaterials-relatedMaterialsBinaries-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided by the Attachment UI components to support the upload of files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Attachment creator.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the attachment creator.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment Type such as FILE or TEXT, or WEB_PAGE.
• Description: string
  Title: Description

  Maximum Length: 255

  User name of the person who uploaded the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Description for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Surrogate identifier for the document attached.
• DmVersionNumber: string
  Maximum Length: 255

  Folder path where the attachment will be created.
• DownloadInfo: string
  Title: DownloadInfo

  Version number for the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status code, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date for the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  Expiration date of the attachment. This is a read-only attribute.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Actual content of the attachment.
• FileUrl: string
  Title: File Url

  Name for the attachment file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  File URL for the attachment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Base64 encoded image file displayed in .png format when the source is a convertible image.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Date when attachment record was most recently updated.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the person who most recently updated the attachment record.
• links: array Links
  Title: Links

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

  Name of the action that can be done after an attachment is uploaded.
• Title: string
  Title: Title

  User name of the person who most recently updated the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Size of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Name of the uploaded file. This is a read-only attribute.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Text uploaded in the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URI for the attachment. This is a read-only attribute.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  URL for a web page type attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Attachment creator.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the attachment creator.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Surrogate identifier for the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Folder path where the attachment will be created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Version number for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date for the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Actual content of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Name for the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"File URL for the attachment.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Date when attachment record was most recently updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the person who most recently updated the attachment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"User name of the person who most recently updated the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"URL for a web page type attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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 : learningEvents-userActionHints-item-response

Type: object

Show Source

• canManageLearningItem: string
  Read Only: true

  Maximum Length: 255

  Hint to identify whether a user can manage the learning item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "canManageLearningItem":{
            "maxLength":255,
            "type":"string",
            "description":"Hint to identify whether a user can manage the learning item.",
            "nullable":true,
            "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 : learningEvents-whereUsed-item-response

Type: object

Show Source

• learningItemCoverArtLink: string
  Read Only: true

  Maximum Length: 255

  URL to the cover art.
• learningItemCreatorEmailAddress: string
  Read Only: true

  Email address for the learning item creator.
• learningItemDescription: string
  Read Only: true

  Maximum Length: 4000

  Description of the learning item.
• learningItemId: integer (int64)
  Read Only: true

  Unique identifier for the learning item, it's the internal primary key.
• learningItemNumber: string
  Maximum Length: 30

  Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
• learningItemStatus: string
  Read Only: true

  Maximum Length: 30

  Status for the learning item.
• learningItemSubType: string
  Read Only: true

  Maximum Length: 30

  Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
• learningItemSubTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the learning item subtype.
• learningItemTitle: string
  Read Only: true

  Maximum Length: 250

  Title of the learning item.
• learningItemType: string
  Read Only: true

  Maximum Length: 32

  Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.
• learningItemTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the learning item type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "learningItemCoverArtLink":{
            "maxLength":255,
            "type":"string",
            "description":"URL to the cover art.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemCreatorEmailAddress":{
            "type":"string",
            "description":"Email address for the learning item creator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item, it's the internal primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.",
            "nullable":true,
            "x-queryable":true
        },
        "learningItemStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the learning item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemSubTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the learning item subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemTitle":{
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "learningItemType":{
            "maxLength":32,
            "type":"string",
            "description":"Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the learning item type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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"
    }
}

Links

DataSecurityPrivilegeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LC_ATTRIBUTION_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: dataSecurityPrivilege; Target Attribute: LookupCode
• Display Attribute: Meaning

DeleteReasonCodeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DL_DELETE_REASON

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemDeletionReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

EventCancelReasonCodeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_EVENT_CANCEL_REASON

The following properties are defined on the LOV link relation:

• Source Attribute: eventCancelReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

EventWithdrawalPeriodBeforeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LE_WITHDRAW_BEFORE

The following properties are defined on the LOV link relation:

• Source Attribute: eventWithdrawalPeriodBefore; Target Attribute: LookupCode
• Display Attribute: Meaning

EventWithdrawalPeriodLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LE_WITHDRAW_PERIOD

The following properties are defined on the LOV link relation:

• Source Attribute: eventWithdrawalPeriod; Target Attribute: LookupCode
• Display Attribute: Meaning

EventWithdrawalPeriodUOMLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LE_WITHDRAW_PERIOD_UOM

The following properties are defined on the LOV link relation:

• Source Attribute: eventWithdrawalPeriodUOM; Target Attribute: LookupCode
• Display Attribute: Meaning

FollowCommunityLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemCommunityOverridesVisibility; Target Attribute: LookupCode
• Display Attribute: Meaning

FollowSpecLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemLearningPathOverridesVisibility; Target Attribute: LookupCode
• Display Attribute: Meaning

KeepCompletionsLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DL_KEEP_COMPLETIONS

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemKeepCompletionsOnDelete; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemApprovalRuleESSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_DL_ASSN_STATE_ESS

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemApprovalRuleESS; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemApprovalRuleMSSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_DL_ASSN_STATE_MGR

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemApprovalRuleMSS; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemAttributionTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ATTRIBUTION_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemAttributionType; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemAuthorTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_AUTHOR_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemAuthorType; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemBusinessDriverLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_BUSINESS_DRIVER

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemBusinessDriver; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemCertificateEnabledLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemCompletionCertificateEnabled; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemEnrollConditionLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DL_ENROLL_CONDITION

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemEnrollCondition; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemEnrollmentVisibilityMSSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DL_ENRL_VISIBILITY_MSS

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemEnrollmentVisibilityMSS; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemLearningLevelLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LEARNING_LEVEL

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemLearningLevel; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemMarkCompleteMSSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemMarkCompleteMSS; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemNotificationPatternLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_NOTIF_PATTERN

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemNotificationPattern; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemPublisherLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_PUBLISHER

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemPublisher; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemStatusLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ELEARNING_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ELEARNING_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemType; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemVisibilityLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_SS_LI_VISIBILITY

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemVisibility; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemWithdrawalRuleESSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DL_WITHDRAW_RULE_ESS

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemWithdrawalRuleESS; Target Attribute: LookupCode
• Display Attribute: Meaning

LearningItemWithdrawalRuleMSSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LE_WITHDRAW_RULE_MSS

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemWithdrawalRuleMSS; Target Attribute: LookupCode
• Display Attribute: Meaning

ReactivateReasonCodeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DL_REACTIVE_REASON

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemReactivationReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

WaitlistRuleLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_EVENT_WAITLIST_RULE

The following properties are defined on the LOV link relation:

• Source Attribute: eventWaitlistRule; Target Attribute: LookupCode
• Display Attribute: Meaning

activities

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/activities

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The activities resources enumerate all the activities that make up the event. It can be used to add, edit, and delete multiple activities. An event needs to have at least one activity.

assets

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/assets

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.

learnerFeedback

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/learnerFeedback

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The learner feedback resource provides details of the learner feedback configuration, such as feedback type, questionnaire code, and questionnaire name.

learningItemDFF

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/learningItemDFF

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

learningItemLearnerDataCollectionTypeESSLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_LRNR_DATA_COLL_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: learningItemLearnerDataCollectionTypeESS; Target Attribute: LookupCode
• Display Attribute: Meaning

messages

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/messages

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.

metrics

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/metrics

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.

relatedMaterials

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/relatedMaterials

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The relatedMaterials resource is used to add attachments to the learning parent resource, as well as to edit, view, and delete the attachments. Details include attached document ID, file name, file URL, file title, and description.

userActionHints

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/userActionHints

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The userActionHints resource provides hints for possible actions on its parent resource.

whereUsed

Operation: /hcmRestApi/resources/11.13.18.05/learningEvents/{learningEventsUniqID}/child/whereUsed

Parameters:

• learningEventsUniqID: $request.path.learningEventsUniqID

The whereUsed resource provides details about the uses of a learning item in topics and learning communities.

Back to Top