Update a digital learning item
patch
/hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}
Request
Path Parameters
-
digitalLearningUniqID(required): string
This is the hash key of the attributes which make up the composite key for the (digitalLearning) resource and used to uniquely identify an instance of (digitalLearning). The client should not generate the hash key value. Instead, the client should query on the (digitalLearning) collection resource in order to navigate to a specific instance of (digitalLearning) to get the hash key.
Header Parameters
-
Effective-Of:
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:
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.
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. -
content: array
Learning Content
Title:
Learning Content
A child of the learning courses resource, this 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. -
learningItemAuthorDisplayName: string
Title:
Author
Maximum Length:2000
Display name the learning item author. -
learningItemAuthoredOnDate: string
(date-time)
Date when the learning item was authored.
-
learningItemAuthorPersonNumber: string
Maximum Length:
30
Person number of the learning item author. -
learningItemAuthorType: string
Maximum Length:
32
The learning author type. Valid values are ORA_PERSON or ORA_ADHOC . -
learningItemBusinessDriver: string
Title:
Business Driver
Maximum Length:32
The business driver, such as Compliance or Self Development. -
learningItemCoordPersonNumber: string
Maximum Length:
32
Person number of the learning item coordinator. -
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
-
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.
-
learningItemInstructorDisplayName: string
Title:
Instructor
Maximum Length:2000
Display name for the learning item instructor. -
learningItemInstructorPersonNumber: string
Maximum Length:
30
Person number of the learning item instructor. -
learningItemInstructorType: string
Maximum Length:
32
The instructor type. Valid values are ORA_PERSON or ORA_ADHOC . -
learningItemLearningLevel: string
Title:
Learning Level
Maximum Length:32
The learning level, such as Beginner, Moderate, or Advanced. -
learningItemLongDescription: string
Title:
Long Description
Long, rich text description of the learning item. -
learningItemNotificationPattern: string
Title:
Notification Pattern
Maximum Length:32
The 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
The name of the provider used to create the learning item, such as Skillsoft or LinkedIn. -
learningItemProviderType: string
Maximum Length:
32
The 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
The 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. -
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. -
learningItemSupportedLanguages: string
Title:
Instruction Languages
Maximum Length:255
List of languages the learning item supports. -
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
The visibility of the learning item, such as Public or Secret. -
metrics: array
Digital Learning Metrics
Title:
Digital Learning Metrics
The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count. - relatedMaterials: array Related Materials
-
whereUsed: array
Where Used
Title:
Where Used
The whereUsed resource provides details about the usages of a digital 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 : Learning Content
Type:
array
Title:
Learning Content
A child of the learning courses resource, this 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 : Digital Learning Metrics
Type:
array
Title:
Digital Learning Metrics
The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count.
Show Source
Nested Schema : Where Used
Type:
array
Title:
Where Used
The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities.
Show Source
Nested Schema : digitalLearning-assets-item-patch-request
Type:
Show Source
object
-
assetBinaries: array
Content Binaries
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
The 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
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : digitalLearning-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 of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
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 of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
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
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : digitalLearning-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. -
completionRule: string
Title:
Completion Rule
Maximum Length:32
The completion rule that determines how completions are handled by the content. 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
Add, edit, view and delete attachments of 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:
When Learner Can Review Observer 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
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 is a child of the digitalLearning resource. This resource enumerates the list of 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.
-
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 digital 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
Add, edit, view and delete attachments of 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 is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : digitalLearning-content-assets-item-patch-request
Type:
Show Source
object
-
assetBinaries: array
Content Binaries
Title:
Content Binaries
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
The 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
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description.
Show Source
Nested Schema : digitalLearning-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 of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
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 of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
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
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
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 of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
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 of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
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
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : digitalLearning-content-obsPersonDetails-item-patch-request
Type:
Show Source
object
-
personNumber: string
Maximum Length:
255
The numeric identifier for the person.
Nested Schema : digitalLearning-learningItemDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
Nested Schema : digitalLearning-whereUsed-item-patch-request
Type:
Show Source
object
-
learningItemId: integer
(int64)
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.
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 : digitalLearning-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. -
content: array
Learning Content
Title:
Learning Content
A child of the learning courses resource, this 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. -
contentBinaryTrackerId: string
Read Only:
true
Maximum Length:255
Tracker ID for the content binary. -
coverArtAssetBinaryTrackerId: string
Read Only:
true
Maximum Length:255
Tracker ID for the cover art asset binary. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Data security privilege, such as Learner or Learner Manager. Valid values are defined in the DataSecurityPrivilegeLOV. -
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.
-
learningItemAuthorPersonNumber: string
Maximum Length:
30
Person number of the learning item author. -
learningItemAuthorType: string
Maximum Length:
32
The learning author type. Valid values are ORA_PERSON or ORA_ADHOC . -
learningItemBusinessDriver: string
Title:
Business Driver
Maximum Length:32
The business driver, such as Compliance or Self Development. -
learningItemCoordDisplayName: string
Title:
learningItemCoordDisplayName
Read Only:true
Maximum Length:255
Display name of the learning item coordinator. -
learningItemCoordPersonNumber: string
Maximum Length:
32
Person number of the learning item coordinator. -
learningItemCoverArtHighRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the high rendition version of the learning cover art image. -
learningItemCoverArtLowRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the low rendition version of learning the cover art image. -
learningItemCoverArtMedRenditionLink: string
Read Only:
true
Maximum Length:255
A 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. -
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. -
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.
-
learningItemInstructorDisplayName: string
Title:
Instructor
Maximum Length:2000
Display name for the learning item instructor. -
learningItemInstructorPersonNumber: string
Maximum Length:
30
Person number of the learning item instructor. -
learningItemInstructorType: string
Maximum Length:
32
The instructor type. Valid values are ORA_PERSON or ORA_ADHOC . -
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
The learning level, such as Beginner, Moderate, or Advanced. -
learningItemLongDescription: string
Title:
Long Description
Long, rich text description of the learning item. -
learningItemNotificationPattern: string
Title:
Notification Pattern
Maximum Length:32
The 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
The 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
The 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
The 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. -
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. -
learningItemSupportedLanguages: string
Title:
Instruction Languages
Maximum Length:255
List of languages the learning item supports. -
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
The visibility of the learning item, such as Public or Secret. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
metrics: array
Digital Learning Metrics
Title:
Digital Learning Metrics
The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count. - relatedMaterials: array Related Materials
-
trailerAssetBinaryTrackerId: string
Read Only:
true
Maximum Length:255
Tracker ID for the trailer asset binary. -
whereUsed: array
Where Used
Title:
Where Used
The whereUsed resource provides details about the usages of a digital 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 : Learning Content
Type:
array
Title:
Learning Content
A child of the learning courses resource, this 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Digital Learning Metrics
Type:
array
Title:
Digital Learning Metrics
The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count.
Show Source
Nested Schema : Where Used
Type:
array
Title:
Where Used
The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities.
Show Source
Nested Schema : digitalLearning-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
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
The 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
A 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
A link to the low rendition version of learning the cover art image. -
medRenditionLink: string
Read Only:
true
Maximum Length:255
A 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
Add, edit, view and delete attachments of 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 : digitalLearning-assets-assetBinaries-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
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
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
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 of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
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 of the attachment file. -
FileUrl: string
File URL of 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 last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
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
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
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 : digitalLearning-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. -
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. -
completionRule: string
Title:
Completion Rule
Maximum Length:32
The completion rule that determines how completions are handled by the content. 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
Add, edit, view and delete attachments of 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
A link to the high rendition version of the learning cover art image. -
coverArtLowRenditionLink: string
Read Only:
true
Maximum Length:255
A link to the low rendition version of learning the cover art image. -
coverArtMedRenditionLink: string
Read Only:
true
Maximum Length:255
A 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:
When Learner Can Review Observer 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
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 is a child of the digitalLearning resource. This resource enumerates the list of 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. -
questionnaireName: string
Read Only:
true
Maximum Length:255
Name of the questionnaire. -
questionnaireVersion: integer
(int64)
Version of the questionnaire.
-
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 digital 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
Add, edit, view and delete attachments of 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 is a child of the digitalLearning resource. This resource enumerates the list of named observers and provides their details, such as person display name and person number.
Show Source
Nested Schema : digitalLearning-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
Add, edit, view and delete attachments of the parent resource. Details include attached document identifier, file name, file URL, file title, and description. -
assetId: integer
(int64)
The 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
A 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
A link to the low rendition version of learning the cover art image. -
medRenditionLink: string
Read Only:
true
Maximum Length:255
A 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
Add, edit, view and delete attachments of 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 : digitalLearning-content-assets-assetBinaries-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
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
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
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 of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
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 of the attachment file. -
FileUrl: string
File URL of 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 last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
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
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
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 : digitalLearning-content-contentBinaries-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
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
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
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 of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
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 of the attachment file. -
FileUrl: string
File URL of 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 last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
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
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
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 : digitalLearning-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 : digitalLearning-learningItemDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
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 : digitalLearning-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 digital learning. -
completedCount: number
Read Only:
true
Count of completed enrollments. -
conversationCount: number
Read Only:
true
Count of conversations on the digital learning. -
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 digital learning. -
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
Learning Item ID for the digital 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 digital learning. -
passCountEnrollments: number
Read Only:
true
Count of enrollments with passed status. -
passCountLearners: number
Read Only:
true
Count of learners who passed the digital learning. -
totalRatings: number
Read Only:
true
Rating count for the digital learning. -
totalViewCount: number
Read Only:
true
Count of views on the digital learning. -
viewCountInLastThirtyDays: number
Read Only:
true
Count of views on the digital learning in the past 30 days. -
whereUsedCount: number
Read Only:
true
Count of learning items, such as communities, journeys, organizations, and specializations that use the digital learning.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : digitalLearning-whereUsed-item-response
Type:
Show Source
object
-
learningItemCoverArtLink: string
Read Only:
true
Maximum Length:255
URL to the cover art. -
learningItemDescription: string
Read Only:
true
Maximum Length:4000
Description of the learning item. -
learningItemId: integer
(int64)
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
- 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:
- 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:
- 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:
- assets
-
Parameters:
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
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. - digitalLearningUniqID:
- content
-
Parameters:
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
A child of the learning courses resource, this 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. - digitalLearningUniqID:
- learningItemDFF
-
Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/learningItemDFFParameters:
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
- digitalLearningUniqID:
- metrics
-
Parameters:
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
The metrics resource returns the metrics on the digital learning, such as the number of current and future dated enrollments, completion count, passed and failed counts, and recommendations count. - digitalLearningUniqID:
- relatedMaterials
-
Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/relatedMaterialsParameters:
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
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. - digitalLearningUniqID:
- whereUsed
-
Operation: /hcmRestApi/resources/11.13.18.05/digitalLearning/{digitalLearningUniqID}/child/whereUsedParameters:
- digitalLearningUniqID:
$request.path.digitalLearningUniqID
The whereUsed resource provides details about the usages of a digital learning item in topics and learning communities. - digitalLearningUniqID: