REST API for Oracle Fusion Cloud HCM

Create an activity

post

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

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.
Upsert-Mode: string

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

activityId: integer (int64)

Title: Activity ID

Unique identifier for the activity.
activityNumber(required): 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(required): 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.

{
    "required":[
        "activityNumber",
        "status"
    ],
    "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
            }
        },
        "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-post-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-post-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-post-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-post-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-post-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-post-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-post-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-post-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-post-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 schema

{
    "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-post-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-post-request

Type: object

Show Source

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

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

Type: object

Show Source

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

Nested Schema : schema

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

Nested Schema : schema

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.
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":{
        "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"
            }
        },
        "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"
            }
        }
    }
}

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.

Root 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

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

Links

ActivityCompletionRuleLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DORA_WLF_EVENT_ACT_COMPL_RULE

The following properties are defined on the LOV link relation:

Source Attribute: completionRule; Target Attribute: LookupCode
Display Attribute: Meaning

ActivityTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DORA_WLF_EVENT_ACTIVITY_TYPE

The following properties are defined on the LOV link relation:

Source Attribute: activityType; Target Attribute: LookupCode
Display Attribute: Meaning

CompletionTypeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DORA_WLF_ACTIVITY_COMPLETION

The following properties are defined on the LOV link relation:

Source Attribute: completionType; Target Attribute: LookupCode
Display Attribute: Meaning

adhocResources

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

Parameters:

activitiesUniqID: $request.path.activitiesUniqID
learningEventsUniqID: $request.path.learningEventsUniqID

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

classroomDetails

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

Parameters:

activitiesUniqID: $request.path.activitiesUniqID
learningEventsUniqID: $request.path.learningEventsUniqID

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.

instructorDetails

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

Parameters:

activitiesUniqID: $request.path.activitiesUniqID
learningEventsUniqID: $request.path.learningEventsUniqID

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

relatedMaterials

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

Parameters:

activitiesUniqID: $request.path.activitiesUniqID
learningEventsUniqID: $request.path.learningEventsUniqID