Update a self-paced learning item
patch
/hcmRestApi/resources/11.13.18.05/learningSelfPacedItems/{learningSelfPacedItemsUniqID}
Request
Path Parameters
-
learningSelfPacedItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Learning Self-Paced Items resource and used to uniquely identify an instance of Learning Self-Paced Items. The client should not generate the hash key value. Instead, the client should query on the Learning Self-Paced Items collection resource in order to navigate to a specific instance of Learning Self-Paced Items to get the hash key.
Header Parameters
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
assets: array
Learning Content Assets
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. -
changeRequests: array
Change Requests
Title:
Change Requests
The changeRequests resource contains the change details, such as identifier, comment, processing status, and status. -
content: array
Learning Content
Title:
Learning Content
The content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV. -
learningItemActiveDate: string
(date-time)
Date when the learning item was activated
-
learningItemApprovalRuleESS: string
Maximum Length:
30
Determines how approvals are configured for self-service enrollment. -
learningItemApprovalRuleMSS: string
Maximum Length:
30
Determines how approvals are configured for manager enrollment. -
learningItemAuthorDisplayName: string
Title:
Author
Maximum Length:2000
Display name the learning item author. -
learningItemAuthoredOnDate: string
(date-time)
Date when the learning item was authored.
-
learningItemAuthorPersonId: integer
(int64)
Person identifier for the learning item author.
-
learningItemAuthorPersonNumber: string
Maximum Length:
30
Person number of the learning item author. -
learningItemAuthorType: string
Maximum Length:
32
Learning author type. Valid values are ORA_PERSON or ORA_ADHOC. -
learningItemBusinessDriver: string
Title:
Business Driver
Maximum Length:32
Business driver, such as Compliance or Self Development. -
learningItemCatalogProfileId: integer
Unique identifier for the learning catalog profile.
-
learningItemCatalogProfileNumber: string
Number for the learning catalog profile.
-
learningItemCommunityOverridesVisibility: string
Maximum Length:
1
Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N. -
learningItemContentDeleteDate: string
(date-time)
Date when the learning item content was deleted
-
learningItemContentDeleteReasonCode: string
Maximum Length:
30
Reason for deleting the learning item content. -
learningItemCoordPersonId: integer
(int64)
Person identifier for the learning item coordinator.
-
learningItemCoordPersonNumber: string
Maximum Length:
32
Person number of the learning item coordinator. -
learningItemDeletionReasonCode: string
Maximum Length:
30
Reason for deleting the learning item. -
learningItemDescription: string
Title:
Description
Maximum Length:4000
Plain text version of the long description of the learning item. -
learningItemDetailsDeepLink: string
Title:
Learning Item Deep Link
Maximum Length:255
URL to open the learning item page directly from the browser. -
learningItemDFF: array
learningItemDFF
-
learningItemEnrollmentVisibilityMSS: string
Maximum Length:
30
Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW. -
learningItemExpectedEffortInSeconds: number
Title:
Expected Effort
Expected effort needed by the learner to complete the learning item. -
learningItemFeatureEndDate: string
(date-time)
Title:
Featured End Date
Date when the learning item stops being featured. -
learningItemFeatureStartDate: string
(date-time)
Title:
Featured Start Date
Date when the learning item starts being featured. -
learningItemInactiveDate: string
(date-time)
Date when the learning item will be set to inactive.
-
learningItemInactiveReasonCode: string
Maximum Length:
30
Reason for moving the learning item to inactive status. -
learningItemInstructorDisplayName: string
Title:
Instructor
Maximum Length:2000
Display name for the learning item instructor. -
learningItemInstructorPersonId: integer
(int64)
Person identifier for the learning item instructor.
-
learningItemInstructorPersonNumber: string
Maximum Length:
30
Person number of the learning item instructor. -
learningItemInstructorType: string
Maximum Length:
32
Type of instructor. Valid values are ORA_PERSON or ORA_ADHOC -
learningItemKeepCompletionsOnDelete: string
Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.
-
learningItemLearningLevel: string
Title:
Learning Level
Maximum Length:32
Learning level, such as Beginner, Moderate, or Advanced. -
learningItemLearningPathOverridesVisibility: string
Maximum Length:
1
Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N. -
learningItemLongDescription: string
Title:
Long Description
Long, rich text description of the learning item. -
learningItemNotificationPattern: string
Title:
Notification Pattern
Maximum Length:32
Notification pattern, such as Default Notification Pattern. -
learningItemNumber: string
Title:
Learning Item Number
Maximum Length:2000
User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI. -
learningItemProvider: string
Maximum Length:
32
Name of the provider used to create the learning item, such as Skillsoft or LinkedIn. -
learningItemProviderType: string
Maximum Length:
32
Type of the provider used. Valid values are File,URL,Connector or Questionnaire. -
learningItemPublishEndDate: string
(date-time)
Title:
Publish End Date
Date when the learning item stops being visible in the learning catalog. -
learningItemPublisher: string
Title:
Publisher
Maximum Length:32
Learning item publisher, such as Learning Department. -
learningItemPublisherName: string
Maximum Length:
2000
Name of the publisher of the learning item. -
learningItemPublishStartDate: string
(date-time)
Title:
Publish Start Date
Date when the learning item starts being visible in the learning catalog. -
learningItemReactivationReasonCode: string
Maximum Length:
30
Reason for moving the inactive learning item to active status. -
learningItemShortDescription: string
Title:
Learning Item Short Description
Maximum Length:255
Short description of the learning item. -
learningItemStatus: string
Title:
Learning Item Status
Maximum Length:30
Default Value:ORA_DRAFT
Status of the learning item. -
learningItemStatusComment: string
Maximum Length:
4000
Status change comment for the learning item. -
learningItemSupportedLanguages: string
Title:
Instruction Languages
Maximum Length:255
List of languages the learning item supports. -
learningItemTalentProfileSummary: array
Learning Item Talent Profile Summary
Title:
Learning Item Talent Profile Summary
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes. -
learningItemTitle: string
Title:
Title
Maximum Length:255
Title of the learning item. -
learningItemType: string
Title:
Assigned Learning Item Subtype
Maximum Length:30
Type of learning item, such as video, online course, document, assessment, or observation checklist. -
learningItemVisibility: string
Maximum Length:
32
Visibility of the learning item, such as Public or Secret. -
messages: array
Messages
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description. -
metrics: array
Learning Catalog Item Metrics
Title:
Learning Catalog Item Metrics
The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count. - relatedMaterials: array Related Materials
-
userActionHints: array
User Action Hints
Title:
User Action Hints
The userActionHints resource provides hints for possible actions on its parent resource. -
whereUsed: array
Where Used
Title:
Where Used
The whereUsed resource provides details about the uses of a learning item in topics and learning communities.
Nested Schema : Learning Content Assets
Type:
array
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
Show Source
Nested Schema : Change Requests
Type:
array
Title:
Change Requests
The changeRequests resource contains the change details, such as identifier, comment, processing status, and status.
Show Source
Nested Schema : Learning Content
Type:
array
Title:
Learning Content
The content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.
Show Source
Nested Schema : Learning Item Talent Profile Summary
Type:
array
Title:
Learning Item Talent Profile Summary
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
Show Source
Nested Schema : Learning Catalog Item Metrics
Type:
array
Title:
Learning Catalog Item Metrics
The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.
Show Source
Nested Schema : User Action Hints
Type:
array
Title:
User Action Hints
The userActionHints resource provides hints for possible actions on its parent resource.
Show Source
Nested Schema : Where Used
Type:
array
Title:
Where Used
The whereUsed resource provides details about the uses of a learning item in topics and learning communities.
Show Source
Nested Schema : learningSelfPacedItems-assets-item-patch-request
Type:
Show Source
object
-
assetBinaries: array
Content Binaries
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
Unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30
User-friendly number identifying the learning item asset, such as cover art or a trailer. -
primary: string
Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
-
relationshipType: string
Maximum Length:
30
Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000
Web link to the image source location. -
status: string
Maximum Length:
30
Status of the learning item asset. -
type: string
Maximum Length:
30
Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description for the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Expiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name for the attachment file. -
FileUrl: string
Title:
File Url
File URL for the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI for the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL for a web page type attachment.
Nested Schema : schema
Type:
Show Source
object
-
comment: string
Maximum Length:
4000
Optional comment that explains the need for this change. -
createdById: integer
(int64)
Identifier for the change requester.
-
deleteExistingContent: string
Maximum Length:
30
Indicates whether the change request should delete existing content. Possible values are Yes, No, or Not Applicable. -
notificationMessage: string
Maximum Length:
4000
Notification message text sent to the learners. -
notifyLearners: string
Maximum Length:
30
Indicates whether to notify learners about this change request. Possible values are Yes, No, or Not Applicable. -
processingStatus: string
Maximum Length:
30
Processing status for the change request. -
reasonCode: string
Maximum Length:
30
Reason for reconciliation. -
reconcileById: integer
(int64)
Identifier for the person reconciling the change request.
-
reconcileEndDate: string
(date-time)
Date and time when the change request reconciliation should end.
-
reconcileLastRunProcessDate: string
(date-time)
Date and time when the change request was most recently reconciled.
-
reconcileLastRunProcessId: integer
(int64)
Unique identifier associated with the most recent reconciliation run for the change request.
-
reconcileStartDate: string
(date-time)
Date and time to start the change request reconciliation.
-
restartInProgressAttempts: string
Maximum Length:
30
Indicates whether in-progress attempts need to be restarted. Possible values are Yes, No, or Not Applicable. -
status: string
Maximum Length:
30
Status for the change request.
Nested Schema : learningSelfPacedItems-content-item-patch-request
Type:
Show Source
object
-
allowBrowseCondition: string
Title:
Learner Content Browsing
Maximum Length:30
When a learner is allowed to browse the content. -
allowFwdScrub: string
Title:
Allow learners to fast forward
Maximum Length:32
Indicates if forward scrubbing is enabled.Valid values are Y or N. -
assets: array
Learning Content Assets
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. -
autoCommit: string
Title:
Auto Commit
Maximum Length:1
Indicates if automatic commit is enabled.Valid values are Y or N. -
autoLaunchOnPageOpen: string
Maximum Length:
1
Indicates whether the content needs to be automatically launched when the enrollment page opens. -
completeBeforeExitAU: string
Maximum Length:
30
Indicates how completions are recorded by the AICC player. ORA_YES means completions are recorded without waiting for the ExitAU AICC call. ORA_NO means the player waits for the ExitAU call. -
completionRule: string
Title:
Completion Rule
Maximum Length:32
Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required. -
completionThreshold: number
Title:
Percentage Watched for Completion
What percentage of the content a learner needs to complete to be marked successful. -
contentBinaries: array
Content Binaries
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
contentId: integer
(int64)
Title:
Content ID
The unique identifier for the content. -
displayMode: string
Maximum Length:
32
How the content is displayed to the learner, such as embedded. -
durationInSeconds: integer
Content duration in seconds.
-
enableScoring: string
Title:
Enable Scoring
Maximum Length:1
Indicates if scoring is enabled or not. Valid values are Y or N. -
learnerAttemptReview: string
Maximum Length:
120
What attempts a learner can review. -
learnerAttemptReviewCondition: string
Title:
When Learner Can Review Attempts
Maximum Length:32
When a learner can review attempts. -
learnerAttemptRule: string
Title:
Recorded Attempts
Maximum Length:120
The rule used to configure attempts. -
learnerMaximumAttempts: integer
(int64)
Title:
Number of Recorded Attempts
The maximum attempts allowed on for the learning content. -
obsAllowBrowseCondition: string
Maximum Length:
32
Indicates when learners can browse the content of an observation checklist. -
obsAllowReassignment: string
Maximum Length:
1
Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N. -
obsAttemptReviewByLearner: string
Title:
Learner Review of Observer Recorded Attempts
Maximum Length:120
Determines what observer attempts a learner can review. Valid values are ORA_WLF_ARAR_DONT_ENABLE, ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_ANY_PAST_ATTEMPT or ORA_WLF_ARAR_LAST_PASS_ATEMPT. If the content is an observation checklist and null for other content types, the default value is ORA_WLF_ARAR_LAST_ATTEMPT. -
obsAttemptReviewConditionByLearner: string
Title:
When Learner Can Review Observer Attempts
Maximum Length:32
Indicates when learners can review the observer's recorded attempts. -
obsAttemptRule: string
Title:
Observer Recorded Attempts
Maximum Length:120
Determines how many attempts can be recorded. Valid values are ORA_WLF_ARA_LTD_NUM,ORA_WLF_ARA_SNGL,ORA_WLF_ARA_SNGL_RESUME or ORA_WLF_ARA_UNLTD. The default value is ORA_WLF_ARA_SNGL. -
obsLearnerSelfAssessEnable: string
Maximum Length:
1
Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N. -
obsManagerLevel: string
Maximum Length:
30
Manager level, such as first level manager, second level manger, or third level manager. -
obsManagerType: string
Maximum Length:
255
Manager type, such as Line Manager, Project Manager, or Regional Manager. -
obsMaximumAttempts: integer
(int64)
Title:
Number of Observer Recorded Attempts
Maximum number of attempts allowed for an observer. -
obsPersonDetails: array
Observer Person Details
Title:
Observer Person Details
The obsPersonDetails resource lists the named observers and provides their details, such as person display name and person number. -
obsRepType: string
Maximum Length:
255
Type of representative, such as Benefits representative, Learning representative, or Payroll representative. -
obsShowFeedbackToLearner: string
Maximum Length:
1
Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N. -
obsType: string
Maximum Length:
30
Type of observer, such as Individuals, Management Hierarchy, or Representative. -
passingScore: number
Title:
Mastery Score
Score required to successfully complete the provided learning content. -
questionnaireCode: string
Maximum Length:
255
Unique code for the questionnaire. -
questionnaireVersion: integer
(int64)
Version of the questionnaire.
-
retryAttemptsBeforeDelay: integer
(int64)
Number of times a learner can attempt the learning item without a delay.
-
retryDelayInHours: number
Time of delay, in hours, after which the learner can try the content again.
-
scoredContentCompletionRule: string
Maximum Length:
30
Indicates how to set completions when the learner closes the player window. -
scoreViewRule: string
Title:
Score Visibility
Maximum Length:32
Determines who can view the score, such as learners, learning administrators, or both. -
showFeedbackToLearner: string
Title:
Let learners view response feedback
Maximum Length:1
Indicates if feedback should be visible to the learner. Valid values are Y or N -
sourceId: string
Maximum Length:
2000
Unique identifier for the course in the external application, if available. -
sourceLaunchURL: string
Maximum Length:
2000
Source URL for the learning item -
sourceMaximumScore: number
Maximum score that learners can achieve for the provided learning content.
-
sourceMinimumScore: number
Minimum score that learners can achieve for the provided learning content.
-
sourcePassingScore: number
Score required to successfully complete the provided learning content. This is a read only attribute.
-
status: string
Title:
Status
Maximum Length:30
Status of the learning content, such as active or processing. -
timeLimitInSeconds: integer
Title:
Time Limit
Time limit in seconds that the learner is provided to complete the content. -
type: string
Maximum Length:
30
Type of learning content, such as Video or SCORM
Nested Schema : Learning Content Assets
Type:
array
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
Show Source
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Observer Person Details
Type:
array
Title:
Observer Person Details
The obsPersonDetails resource lists the named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : learningSelfPacedItems-content-assets-item-patch-request
Type:
Show Source
object
-
assetBinaries: array
Content Binaries
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
Unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30
User-friendly number identifying the learning item asset, such as cover art or a trailer. -
primary: string
Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
-
relationshipType: string
Maximum Length:
30
Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000
Web link to the image source location. -
status: string
Maximum Length:
30
Status of the learning item asset. -
type: string
Maximum Length:
30
Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : learningSelfPacedItems-content-assets-assetBinaries-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description for the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Expiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name for the attachment file. -
FileUrl: string
Title:
File Url
File URL for the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI for the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL for a web page type attachment.
Nested Schema : learningSelfPacedItems-content-contentBinaries-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description for the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Expiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name for the attachment file. -
FileUrl: string
Title:
File Url
File URL for the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI for the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL for a web page type attachment.
Nested Schema : learningSelfPacedItems-content-obsPersonDetails-item-patch-request
Type:
Show Source
object
-
personNumber: string
Maximum Length:
255
The numeric identifier for the person.
Nested Schema : learningSelfPacedItems-learningItemDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
Nested Schema : learningSelfPacedItems-learningItemTalentProfileSummary-item-patch-request
Type:
Show Source
object
Nested Schema : learningSelfPacedItems-whereUsed-item-patch-request
Type:
Show Source
object
-
learningItemNumber: string
Maximum Length:
30
Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface.
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 : learningSelfPacedItems-item-response
Type:
Show Source
object
-
assets: array
Learning Content Assets
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. -
changeRequests: array
Change Requests
Title:
Change Requests
The changeRequests resource contains the change details, such as identifier, comment, processing status, and status. -
content: array
Learning Content
Title:
Learning Content
The content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV. -
learningItemActiveDate: string
(date-time)
Date when the learning item was activated
-
learningItemApprovalRuleESS: string
Maximum Length:
30
Determines how approvals are configured for self-service enrollment. -
learningItemApprovalRuleMSS: string
Maximum Length:
30
Determines how approvals are configured for manager enrollment. -
learningItemAttributionType: string
Maximum Length:
30
Default Value:ORA_PERSON
Indicates who this learning item is attributed to. Valid values are ORA_PERSON or ORA_SPECIALIST. -
learningItemAuthorDisplayName: string
Title:
Author
Maximum Length:2000
Display name the learning item author. -
learningItemAuthoredOnDate: string
(date-time)
Date when the learning item was authored.
-
learningItemAuthorEmailAddress: string
Read Only:
true
Maximum Length:255
Primary email address of the person. -
learningItemAuthorPersonId: integer
(int64)
Person identifier for the learning item author.
-
learningItemAuthorPersonNumber: string
Maximum Length:
30
Person number of the learning item author. -
learningItemAuthorPhoneNumber: string
Read Only:
true
Maximum Length:255
Phone number for the learning item author. -
learningItemAuthorType: string
Maximum Length:
32
Learning author type. Valid values are ORA_PERSON or ORA_ADHOC. -
learningItemBusinessDriver: string
Title:
Business Driver
Maximum Length:32
Business driver, such as Compliance or Self Development. -
learningItemCatalogProfileId: integer
Unique identifier for the learning catalog profile.
-
learningItemCatalogProfileName: string
Read Only:
true
Maximum Length:255
Name of the learning catalog profile. -
learningItemCatalogProfileNumber: string
Number for the learning catalog profile.
-
learningItemCommunityOverridesVisibility: string
Maximum Length:
1
Indicates whether the learning item visibility can be overridden by a community. Valid values are Y or N. -
learningItemContentDeleteDate: string
(date-time)
Date when the learning item content was deleted
-
learningItemContentDeleteReasonCode: string
Maximum Length:
30
Reason for deleting the learning item content. -
learningItemCoordDisplayName: string
Title:
learningItemCoordDisplayName
Read Only:true
Maximum Length:255
Display name of the learning item coordinator. -
learningItemCoordEmailAddress: string
Read Only:
true
Maximum Length:255
Email address for the learning item coordinator. -
learningItemCoordPersonId: integer
(int64)
Person identifier for the learning item coordinator.
-
learningItemCoordPersonNumber: string
Maximum Length:
32
Person number of the learning item coordinator. -
learningItemCoordPhoneNumber: string
Read Only:
true
Maximum Length:255
Phone number for the learning item coordinator. -
learningItemCoverArtHighRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the high rendition version of the learning cover art image. -
learningItemCoverArtLowRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the low rendition version of the learning cover art image. -
learningItemCoverArtMedRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the medium rendition version of the learning cover art image. -
learningItemCreatedByDisplayName: string
Read Only:
true
Maximum Length:255
Display name of the person who created the learning item. -
learningItemCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the learning item was created. -
learningItemDeletionReasonCode: string
Maximum Length:
30
Reason for deleting the learning item. -
learningItemDeliveryURL: string
Read Only:
true
Maximum Length:255
URL used to deliver the learning item to the learner. -
learningItemDescription: string
Title:
Description
Maximum Length:4000
Plain text version of the long description of the learning item. -
learningItemDetailsDeepLink: string
Title:
Learning Item Deep Link
Maximum Length:255
URL to open the learning item page directly from the browser. -
learningItemDetailsEmbedLink: string
Title:
Learning Item Embed Link
Read Only:true
Maximum Length:255
URL that can be used to embed the learning item page in other pages. It opens the isolated learning item page without the global tool bar on the top. -
learningItemDFF: array
learningItemDFF
-
learningItemDraftExists: string
Read Only:
true
Maximum Length:255
Indicates if a draft version of this learning item exists. Valid values are Y or N. -
learningItemEnrollmentVisibilityMSS: string
Maximum Length:
30
Indicates whether the enrollment details are visible to the line manager. Valid values are ORA_SHOW and ORA_HIDE. The default value is ORA_SHOW. -
learningItemExpectedEffortInSeconds: number
Title:
Expected Effort
Expected effort needed by the learner to complete the learning item. -
learningItemFeatureEndDate: string
(date-time)
Title:
Featured End Date
Date when the learning item stops being featured. -
learningItemFeatureStartDate: string
(date-time)
Title:
Featured Start Date
Date when the learning item starts being featured. -
learningItemId: integer
(int64)
Title:
Learning Item ID
Learning item Id of the course. -
learningItemInactiveDate: string
(date-time)
Date when the learning item will be set to inactive.
-
learningItemInactiveReasonCode: string
Maximum Length:
30
Reason for moving the learning item to inactive status. -
learningItemInstructorDisplayName: string
Title:
Instructor
Maximum Length:2000
Display name for the learning item instructor. -
learningItemInstructorEmailAddress: string
Read Only:
true
Maximum Length:255
Primary Email address of the instructor for the learning item. -
learningItemInstructorPersonId: integer
(int64)
Person identifier for the learning item instructor.
-
learningItemInstructorPersonNumber: string
Maximum Length:
30
Person number of the learning item instructor. -
learningItemInstructorPhoneNumber: string
Read Only:
true
Maximum Length:255
Phone number of the instructor. -
learningItemInstructorType: string
Maximum Length:
32
Type of instructor. Valid values are ORA_PERSON or ORA_ADHOC -
learningItemKeepCompletionsOnDelete: string
Indicates whether learning completions should persist when the learning item is deleted. Valid values are Y and N.
-
learningItemLastModifiedByDisplayName: string
Read Only:
true
Maximum Length:255
Display name of the person who last modified the learning item. -
learningItemLastModifiedDate: string
(date-time)
Title:
Last Modified
Read Only:true
Date when the learning item was last modified. -
learningItemLearningLevel: string
Title:
Learning Level
Maximum Length:32
Learning level, such as Beginner, Moderate, or Advanced. -
learningItemLearningPathOverridesVisibility: string
Maximum Length:
1
Indicates whether the learning item visibility can be overridden by a learning path. Valid values are Y or N. -
learningItemLongDescription: string
Title:
Long Description
Long, rich text description of the learning item. -
learningItemNotificationPattern: string
Title:
Notification Pattern
Maximum Length:32
Notification pattern, such as Default Notification Pattern. -
learningItemNumber: string
Title:
Learning Item Number
Maximum Length:2000
User-friendly number identifying the learning item. It's a surrogate key which is shown in the UI. -
learningItemPreviewURL: string
Read Only:
true
Maximum Length:255
URL used by the administrator to preview the learning item. -
learningItemProvider: string
Maximum Length:
32
Name of the provider used to create the learning item, such as Skillsoft or LinkedIn. -
learningItemProviderMeaning: string
Read Only:
true
Maximum Length:255
Description for the learningItemProvider attribute value. -
learningItemProviderType: string
Maximum Length:
32
Type of the provider used. Valid values are File,URL,Connector or Questionnaire. -
learningItemProviderTypeMeaning: string
Read Only:
true
Maximum Length:255
Description for the learningItemProviderType attribute value. -
learningItemPublishedExists: string
Read Only:
true
Maximum Length:255
Indicate if a published version of this learning item exists. Valid values are Y or N. -
learningItemPublishEndDate: string
(date-time)
Title:
Publish End Date
Date when the learning item stops being visible in the learning catalog. -
learningItemPublisher: string
Title:
Publisher
Maximum Length:32
Learning item publisher, such as Learning Department. -
learningItemPublisherName: string
Maximum Length:
2000
Name of the publisher of the learning item. -
learningItemPublishStartDate: string
(date-time)
Title:
Publish Start Date
Date when the learning item starts being visible in the learning catalog. -
learningItemRatingAverage: integer
Read Only:
true
Rating average for the learning item. -
learningItemRatingCount: integer
Read Only:
true
Rating count for the learning item. -
learningItemReactivationReasonCode: string
Maximum Length:
30
Reason for moving the inactive learning item to active status. -
learningItemSelfEnrollmentURL: string
Read Only:
true
URL for the learner to self enroll -
learningItemShortDescription: string
Title:
Learning Item Short Description
Maximum Length:255
Short description of the learning item. -
learningItemStatus: string
Title:
Learning Item Status
Maximum Length:30
Default Value:ORA_DRAFT
Status of the learning item. -
learningItemStatusComment: string
Maximum Length:
4000
Status change comment for the learning item. -
learningItemSupportedLanguages: string
Title:
Instruction Languages
Maximum Length:255
List of languages the learning item supports. -
learningItemTalentProfileSummary: array
Learning Item Talent Profile Summary
Title:
Learning Item Talent Profile Summary
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes. -
learningItemTitle: string
Title:
Title
Maximum Length:255
Title of the learning item. -
learningItemTrailerLink: string
Read Only:
true
Maximum Length:255
URL to open the learning item trailer directly from the browser. -
learningItemType: string
Title:
Assigned Learning Item Subtype
Maximum Length:30
Type of learning item, such as video, online course, document, assessment, or observation checklist. -
learningItemTypeMeaning: string
Title:
Learning Item Type Description
Read Only:true
Maximum Length:255
Meaning for the learningItemType attribute. -
learningItemVisibility: string
Maximum Length:
32
Visibility of the learning item, such as Public or Secret. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messages: array
Messages
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description. -
metrics: array
Learning Catalog Item Metrics
Title:
Learning Catalog Item Metrics
The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count. - relatedMaterials: array Related Materials
-
userActionHints: array
User Action Hints
Title:
User Action Hints
The userActionHints resource provides hints for possible actions on its parent resource. -
whereUsed: array
Where Used
Title:
Where Used
The whereUsed resource provides details about the uses of a learning item in topics and learning communities.
Nested Schema : Learning Content Assets
Type:
array
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
Show Source
Nested Schema : Change Requests
Type:
array
Title:
Change Requests
The changeRequests resource contains the change details, such as identifier, comment, processing status, and status.
Show Source
Nested Schema : Learning Content
Type:
array
Title:
Learning Content
The content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages.
Show Source
Nested Schema : Learning Item Talent Profile Summary
Type:
array
Title:
Learning Item Talent Profile Summary
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
Show Source
Nested Schema : Learning Catalog Item Metrics
Type:
array
Title:
Learning Catalog Item Metrics
The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count.
Show Source
Nested Schema : User Action Hints
Type:
array
Title:
User Action Hints
The userActionHints resource provides hints for possible actions on its parent resource.
Show Source
Nested Schema : Where Used
Type:
array
Title:
Where Used
The whereUsed resource provides details about the uses of a learning item in topics and learning communities.
Show Source
Nested Schema : learningSelfPacedItems-assets-item-response
Type:
Show Source
object
-
addedOnDate: string
(date-time)
Read Only:
true
Date when the learning item was added to the learning catalog. -
assetBinaries: array
Content Binaries
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
Unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30
User-friendly number identifying the learning item asset, such as cover art or a trailer. -
highRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the high rendition version of the learning cover art image. -
learningItemId: integer
(int64)
Title:
Learning Item ID
The learning item identifier of the asset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the low rendition version of the learning cover art image. -
medRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the medium rendition version of the learning cover art image. -
primary: string
Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
-
relationshipType: string
Maximum Length:
30
Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000
Web link to the image source location. -
status: string
Maximum Length:
30
Status of the learning item asset. -
type: string
Maximum Length:
30
Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-assets-assetBinaries-item-response
Type:
Show Source
object
-
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
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Attachment creator. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the attachment creator. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description for the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attachment. -
DownloadInfo: string
Title:
DownloadInfo
Read Only:true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Expiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name for the attachment file. -
FileUrl: string
Title:
File Url
File URL for the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the person who most recently updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who most recently updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI for the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL for a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : learningSelfPacedItems-changeRequests-item-response
Type:
Show Source
object
-
changeRequestId: integer
(int64)
Unique identifier for the change request.
-
comment: string
Maximum Length:
4000
Optional comment that explains the need for this change. -
createdByDisplayName: string
Read Only:
true
Display name of the change requester. -
createdById: integer
(int64)
Identifier for the change requester.
-
creationDate: string
(date-time)
Read Only:
true
Date when the change request was created. -
deleteExistingContent: string
Maximum Length:
30
Indicates whether the change request should delete existing content. Possible values are Yes, No, or Not Applicable. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
notificationMessage: string
Maximum Length:
4000
Notification message text sent to the learners. -
notifyLearners: string
Maximum Length:
30
Indicates whether to notify learners about this change request. Possible values are Yes, No, or Not Applicable. -
processingStatus: string
Maximum Length:
30
Processing status for the change request. -
processingStatusMeaning: string
Read Only:
true
Maximum Length:255
Description for the change request processing status. -
reasonCode: string
Maximum Length:
30
Reason for reconciliation. -
reasonCodeMeaning: string
Read Only:
true
Maximum Length:255
Description for the reasonCode attribute value. -
reconcileByDisplayName: string
Read Only:
true
Maximum Length:255
Display name of the person reconciling the change request. -
reconcileById: integer
(int64)
Identifier for the person reconciling the change request.
-
reconcileEndDate: string
(date-time)
Date and time when the change request reconciliation should end.
-
reconcileLastRunProcessDate: string
(date-time)
Date and time when the change request was most recently reconciled.
-
reconcileLastRunProcessId: integer
(int64)
Unique identifier associated with the most recent reconciliation run for the change request.
-
reconcileStartDate: string
(date-time)
Date and time to start the change request reconciliation.
-
restartInProgressAttempts: string
Maximum Length:
30
Indicates whether in-progress attempts need to be restarted. Possible values are Yes, No, or Not Applicable. -
status: string
Maximum Length:
30
Status for the change request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-item-response
Type:
Show Source
object
-
addedOnDate: string
(date-time)
Read Only:
true
Date when the learning item was added to the learning catalog. -
allowBrowseCondition: string
Title:
Learner Content Browsing
Maximum Length:30
When a learner is allowed to browse the content. -
allowFwdScrub: string
Title:
Allow learners to fast forward
Maximum Length:32
Indicates if forward scrubbing is enabled.Valid values are Y or N. -
assets: array
Learning Content Assets
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. -
autoCommit: string
Title:
Auto Commit
Maximum Length:1
Indicates if automatic commit is enabled.Valid values are Y or N. -
autoLaunchOnPageOpen: string
Maximum Length:
1
Indicates whether the content needs to be automatically launched when the enrollment page opens. -
chapterLevel: integer
Title:
Chapter Level
Read Only:true
Chapter level of the learning content.Currently this is always set to 1. -
chapterPosition: string
Title:
Chapter Position
Read Only:true
Maximum Length:255
Chapter position of the learning content.Currently this is always set to 1. -
completeBeforeExitAU: string
Maximum Length:
30
Indicates how completions are recorded by the AICC player. ORA_YES means completions are recorded without waiting for the ExitAU AICC call. ORA_NO means the player waits for the ExitAU call. -
completionRule: string
Title:
Completion Rule
Maximum Length:32
Completion rule that determines how the content handles completions. It also determines if manager or learner confirmation is required. -
completionThreshold: number
Title:
Percentage Watched for Completion
What percentage of the content a learner needs to complete to be marked successful. -
contentBinaries: array
Content Binaries
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
contentId: integer
(int64)
Title:
Content ID
The unique identifier for the content. -
coverArtHighRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the high rendition version of the learning cover art image. -
coverArtLowRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the low rendition version of the learning cover art image. -
coverArtMedRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the medium rendition version of the learning cover art image. -
deliveryProviderNumber: string
Maximum Length:
255
User-friendly number identifying the learning content delivery provider. -
deliveryURL: string
Read Only:
true
Maximum Length:255
URL used to deliver the learning item to the learner. -
displayMode: string
Maximum Length:
32
How the content is displayed to the learner, such as embedded. -
durationInSeconds: integer
Content duration in seconds.
-
enableScoring: string
Title:
Enable Scoring
Maximum Length:1
Indicates if scoring is enabled or not. Valid values are Y or N. -
learnerAttemptReview: string
Maximum Length:
120
What attempts a learner can review. -
learnerAttemptReviewCondition: string
Title:
When Learner Can Review Attempts
Maximum Length:32
When a learner can review attempts. -
learnerAttemptRule: string
Title:
Recorded Attempts
Maximum Length:120
The rule used to configure attempts. -
learnerMaximumAttempts: integer
(int64)
Title:
Number of Recorded Attempts
The maximum attempts allowed on for the learning content. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
obsAllowBrowseCondition: string
Maximum Length:
32
Indicates when learners can browse the content of an observation checklist. -
obsAllowReassignment: string
Maximum Length:
1
Indicates whether the observer can reassign the observation checklist task. Valid values are Y or N. Default value is N. -
obsAttemptReviewByLearner: string
Title:
Learner Review of Observer Recorded Attempts
Maximum Length:120
Determines what observer attempts a learner can review. Valid values are ORA_WLF_ARAR_DONT_ENABLE, ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_ANY_PAST_ATTEMPT or ORA_WLF_ARAR_LAST_PASS_ATEMPT. If the content is an observation checklist and null for other content types, the default value is ORA_WLF_ARAR_LAST_ATTEMPT. -
obsAttemptReviewByLearnerMeaning: string
Read Only:
true
Maximum Length:255
Description for the obsAttemptReviewByLearner attribute value. -
obsAttemptReviewConditionByLearner: string
Title:
When Learner Can Review Observer Attempts
Maximum Length:32
Indicates when learners can review the observer's recorded attempts. -
obsAttemptRule: string
Title:
Observer Recorded Attempts
Maximum Length:120
Determines how many attempts can be recorded. Valid values are ORA_WLF_ARA_LTD_NUM,ORA_WLF_ARA_SNGL,ORA_WLF_ARA_SNGL_RESUME or ORA_WLF_ARA_UNLTD. The default value is ORA_WLF_ARA_SNGL. -
obsLearnerSelfAssessEnable: string
Maximum Length:
1
Indicates whether the observation checklist supports self-assessment. Valid values are Y or N. Default value is N. -
obsManagerLevel: string
Maximum Length:
30
Manager level, such as first level manager, second level manger, or third level manager. -
obsManagerType: string
Maximum Length:
255
Manager type, such as Line Manager, Project Manager, or Regional Manager. -
obsManagerTypeMeaning: string
Read Only:
true
Maximum Length:255
Description for the obsManagerType attribute value. -
obsMaximumAttempts: integer
(int64)
Title:
Number of Observer Recorded Attempts
Maximum number of attempts allowed for an observer. -
obsPersonDetails: array
Observer Person Details
Title:
Observer Person Details
The obsPersonDetails resource lists the named observers and provides their details, such as person display name and person number. -
obsRepType: string
Maximum Length:
255
Type of representative, such as Benefits representative, Learning representative, or Payroll representative. -
obsRepTypeMeaning: string
Read Only:
true
Maximum Length:255
Description for the obsRepType attribute value. -
obsShowFeedbackToLearner: string
Maximum Length:
1
Indicates whether observer's feedback should be visible to the learner. Valid values are Y or N. -
obsType: string
Maximum Length:
30
Type of observer, such as Individuals, Management Hierarchy, or Representative. -
passingScore: number
Title:
Mastery Score
Score required to successfully complete the provided learning content. -
questionnaireCode: string
Maximum Length:
255
Unique code for the questionnaire. -
questionnaireName: string
Read Only:
true
Maximum Length:255
Name of the questionnaire. -
questionnaireVersion: integer
(int64)
Version of the questionnaire.
-
retryAttemptsBeforeDelay: integer
(int64)
Number of times a learner can attempt the learning item without a delay.
-
retryDelayInHours: number
Time of delay, in hours, after which the learner can try the content again.
-
scoredContentCompletionRule: string
Maximum Length:
30
Indicates how to set completions when the learner closes the player window. -
scoreViewRule: string
Title:
Score Visibility
Maximum Length:32
Determines who can view the score, such as learners, learning administrators, or both. -
showFeedbackToLearner: string
Title:
Let learners view response feedback
Maximum Length:1
Indicates if feedback should be visible to the learner. Valid values are Y or N -
sourceId: string
Maximum Length:
2000
Unique identifier for the course in the external application, if available. -
sourceLaunchURL: string
Maximum Length:
2000
Source URL for the learning item -
sourceMaximumScore: number
Maximum score that learners can achieve for the provided learning content.
-
sourceMinimumScore: number
Minimum score that learners can achieve for the provided learning content.
-
sourcePassingScore: number
Score required to successfully complete the provided learning content. This is a read only attribute.
-
sourceSupportedLanguages: string
Read Only:
true
Maximum Length:255
List of languages the learning content supports. -
status: string
Title:
Status
Maximum Length:30
Status of the learning content, such as active or processing. -
storageProviderNumber: string
Maximum Length:
255
User-friendly number identifying the learning content storage provider. -
timeLimitInSeconds: integer
Title:
Time Limit
Time limit in seconds that the learner is provided to complete the content. -
title: string
Title:
Title
Read Only:true
Maximum Length:4000
Title of the learning content. -
type: string
Maximum Length:
30
Type of learning content, such as Video or SCORM
Nested Schema : Learning Content Assets
Type:
array
Title:
Learning Content Assets
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status.
Show Source
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Observer Person Details
Type:
array
Title:
Observer Person Details
The obsPersonDetails resource lists the named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : learningSelfPacedItems-content-assets-item-response
Type:
Show Source
object
-
addedOnDate: string
(date-time)
Read Only:
true
Date when the learning item was added to the learning catalog. -
assetBinaries: array
Content Binaries
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
Unique identifier for the learning item asset, such as cover art or a trailer.
-
assetNumber: string
Maximum Length:
30
User-friendly number identifying the learning item asset, such as cover art or a trailer. -
highRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the high rendition version of the learning cover art image. -
learningItemId: integer
(int64)
Title:
Learning Item ID
The learning item identifier of the asset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the low rendition version of the learning cover art image. -
medRenditionLink: string
Read Only:
true
Maximum Length:255
Link to the medium rendition version of the learning cover art image. -
primary: string
Indicates whether the asset is currently being used as the cover art or the trailer. Valid values are Y and N. The default value is Y.
-
relationshipType: string
Maximum Length:
30
Describes the relationship between the learning item asset and the learning item. Valid options are ORA_GENERATED and ORA_ADHOC. -
sourceURL: string
Maximum Length:
2000
Web link to the image source location. -
status: string
Maximum Length:
30
Status of the learning item asset. -
type: string
Maximum Length:
30
Indicates the type of learning asset, such as cover art or a trailer.
Nested Schema : Content Binaries
Type:
array
Title:
Content Binaries
The assetAttachments resource adds, edits, views, and deletes attachments for the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-assets-assetBinaries-item-response
Type:
Show Source
object
-
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
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Attachment creator. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the attachment creator. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description for the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attachment. -
DownloadInfo: string
Title:
DownloadInfo
Read Only:true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Expiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name for the attachment file. -
FileUrl: string
Title:
File Url
File URL for the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the person who most recently updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who most recently updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI for the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL for a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-contentBinaries-item-response
Type:
Show Source
object
-
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
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Attachment creator. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the attachment creator. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description for the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier for the document attached. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attachment will be created. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attachment. -
DownloadInfo: string
Title:
DownloadInfo
Read Only:true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Expiration date for the attachment. This is a read-only attribute. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name for the attachment file. -
FileUrl: string
Title:
File Url
File URL for the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the person who most recently updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
User name of the person who most recently updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI for the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL for a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-content-obsPersonDetails-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
personDisplayName: string
Read Only:
true
Maximum Length:255
Display name for the person. -
personNumber: string
Maximum Length:
255
The numeric identifier for the person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-learningItemDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LearningItemId: integer
(int64)
-
LearningItemType: string
Maximum Length:
32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-learningItemTalentProfileSummary-item-response
Type:
Show Source
object
-
hasOutcomes: string
Title:
Has Outcomes
Read Only:true
Maximum Length:1
Indicates whether the course has outcomes. Valid values are Y or N -
hasPrerequisites: string
Title:
Has Prerequisites
Read Only:true
Maximum Length:1
Indicates whether the course has prerequisites. Valid values are Y or N -
hasSkillsAndQualifications: string
Read Only:
true
Maximum Length:1
Indicates whether the course has skills or qualifications. Valid values are Y or N -
learningItemId: string
Read Only:
true
Maximum Length:32
Learning item Id of the course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-messages-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
message: string
Read Only:
true
User-friendly string describing the message. -
messageCode: string
Read Only:
true
Code to indicate the type of message. -
messageSecondaryText: string
Read Only:
true
Secondary text for the message. -
messageSeverity: string
Read Only:
true
Indicates the severity of the message like: INFO, WARN, or FATAL. -
visibility: string
Read Only:
true
Maximum Length:8
Determines the message visibility. Valid values are Show or Hide.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-metrics-item-response
Type:
Show Source
object
-
averageActualEffortPERAttempt: number
Read Only:
true
Average of the actual effort per attempt. -
averageAttemptsPERCompletion: number
Read Only:
true
Average of the actual effort per completion. -
averageRating: number
Read Only:
true
Rating average for the learning catalog item. -
completedCount: number
Read Only:
true
Count of completed enrollments. -
conversationCount: number
Read Only:
true
Count of conversations on the learning item. -
currentCountEnrollments: number
Read Only:
true
Count of enrollments that are either in active or preactive status. -
currentCountLearners: number
Read Only:
true
Count of unique learners whose enrollments are in either in active or preactive status. -
failCountEnrollments: number
Read Only:
true
Count of enrollments with failed status. -
failCountLearners: number
Read Only:
true
Count of learners who failed the learning item. -
futureCountEnrollments: number
Read Only:
true
Count of future-dated enrollments. -
futureCountLearners: number
Read Only:
true
Count of learners with future-dated enrollments. -
inProgressCount: number
Read Only:
true
Count of in-progress enrollments. -
learningItemId: integer
Read Only:
true
Unique identifier for the learning item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
notInterestedCount: number
Read Only:
true
Count of learners who aren't interested in the learning item. -
passCountEnrollments: number
Read Only:
true
Count of enrollments with passed status. -
passCountLearners: number
Read Only:
true
Count of learners who passed the learning item. -
totalRatings: number
Read Only:
true
Rating count for the learning catalog item. -
totalViewCount: number
Read Only:
true
Count of views on the learning item. -
viewCountInLastThirtyDays: number
Read Only:
true
Count of views on the learning item in the past 30 days. -
whereUsedCount: number
Read Only:
true
Count of learning items, such as communities, journeys, user groups, and specializations that use the learning item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-userActionHints-item-response
Type:
Show Source
object
-
canManageLearningItem: string
Read Only:
true
Maximum Length:255
Hint to identify whether a user can manage the learning item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learningSelfPacedItems-whereUsed-item-response
Type:
Show Source
object
-
learningItemCoverArtLink: string
Read Only:
true
Maximum Length:255
URL to the cover art. -
learningItemCreatorEmailAddress: string
Read Only:
true
Email address for the learning item creator. -
learningItemDescription: string
Read Only:
true
Maximum Length:4000
Description of the learning item. -
learningItemId: integer
(int64)
Read Only:
true
Unique identifier for the learning item, it's the internal primary key. -
learningItemNumber: string
Maximum Length:
30
Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface. -
learningItemStatus: string
Read Only:
true
Maximum Length:30
Status for the learning item. -
learningItemSubType: string
Read Only:
true
Maximum Length:30
Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list. -
learningItemSubTypeMeaning: string
Read Only:
true
Maximum Length:255
Description of the learning item subtype. -
learningItemTitle: string
Read Only:
true
Maximum Length:250
Title of the learning item. -
learningItemType: string
Read Only:
true
Maximum Length:32
Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the AssignedLearningItemTypeLOV list. -
learningItemTypeMeaning: string
Read Only:
true
Maximum Length:255
Description of the learning item type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ContentDeleteReasonCodeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_DL_CONT_DEL_REASON
The following properties are defined on the LOV link relation:- Source Attribute: learningItemContentDeleteReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DataSecurityPrivilegeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LC_ATTRIBUTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: dataSecurityPrivilege; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DeleteReasonCodeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_DL_DELETE_REASON
The following properties are defined on the LOV link relation:- Source Attribute: learningItemDeletionReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FollowCommunityLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: learningItemCommunityOverridesVisibility; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FollowSpecLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: learningItemLearningPathOverridesVisibility; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- InactivateReasonCodeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_DL_INACTIVE_REASON
The following properties are defined on the LOV link relation:- Source Attribute: learningItemInactiveReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemApprovalRuleESSLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_DL_ASSN_STATE_ESS
The following properties are defined on the LOV link relation:- Source Attribute: learningItemApprovalRuleESS; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemApprovalRuleMSSLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_DL_ASSN_STATE_MGR
The following properties are defined on the LOV link relation:- Source Attribute: learningItemApprovalRuleMSS; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemAttributionTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ATTRIBUTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemAttributionType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemAuthorTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_AUTHOR_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemAuthorType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemBusinessDriverLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_BUSINESS_DRIVER
The following properties are defined on the LOV link relation:- Source Attribute: learningItemBusinessDriver; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemDraftExistsLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: learningItemDraftExists; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemEnrollmentVisibilityMSSLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_DL_ENRL_VISIBILITY_MSS
The following properties are defined on the LOV link relation:- Source Attribute: learningItemEnrollmentVisibilityMSS; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemInstructorTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_INSTRUCTOR_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemInstructorType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemLearningLevelLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARNING_LEVEL
The following properties are defined on the LOV link relation:- Source Attribute: learningItemLearningLevel; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemNotificationPatternLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_NOTIF_PATTERN
The following properties are defined on the LOV link relation:- Source Attribute: learningItemNotificationPattern; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemProviderLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_EXTERNAL_PROVIDER_CODE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemProvider; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemProviderTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_PROVIDER_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemProviderType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemPublishedExistsLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: learningItemPublishedExists; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemPublisherLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_PUBLISHER
The following properties are defined on the LOV link relation:- Source Attribute: learningItemPublisher; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemStatusLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ELEARNING_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: learningItemStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemTypeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ELEARNING_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearningItemVisibilityLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_SS_LI_VISIBILITY
The following properties are defined on the LOV link relation:- Source Attribute: learningItemVisibility; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ReactivateReasonCodeLOVVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_DL_REACTIVE_REASON
The following properties are defined on the LOV link relation:- Source Attribute: learningItemReactivationReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- assets
-
Operation: /hcmRestApi/resources/11.13.18.05/learningSelfPacedItems/{learningSelfPacedItemsUniqID}/child/assetsParameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The assets resource enumerates media items used to visually enhance the learning parent resource. Assets can be cover art images or trailers. Asset details include asset identifier, asset number, date the asset was added, asset type, and asset status. - learningSelfPacedItemsUniqID:
- changeRequests
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The changeRequests resource contains the change details, such as identifier, comment, processing status, and status. - learningSelfPacedItemsUniqID:
- content
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The content resource captures the details of content associated with the course, such as storage provider number, delivery provider number, display mode, delivery URL, and supported languages. - learningSelfPacedItemsUniqID:
- learningItemDFF
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
- learningSelfPacedItemsUniqID:
- learningItemTalentProfileSummary
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes. - learningSelfPacedItemsUniqID:
- messages
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description. - learningSelfPacedItemsUniqID:
- metrics
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The metrics resource returns the metrics on the learning item, such as the number of current and future-dated enrollments, completion count, passed and failed counts, and recommendations count. - learningSelfPacedItemsUniqID:
- relatedMaterials
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
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. - learningSelfPacedItemsUniqID:
- userActionHints
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The userActionHints resource provides hints for possible actions on its parent resource. - learningSelfPacedItemsUniqID:
- whereUsed
-
Parameters:
- learningSelfPacedItemsUniqID:
$request.path.learningSelfPacedItemsUniqID
The whereUsed resource provides details about the uses of a learning item in topics and learning communities. - learningSelfPacedItemsUniqID: