Get a digital learning item
get
/hcmRestApi/resources/11.13.18.05/digitalLearningProviders/{digitalLearningProvidersUniqID}
Request
Path Parameters
-
digitalLearningProvidersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the (digitalLearningProviders) resource and used to uniquely identify an instance of (digitalLearningProviders). The client should not generate the hash key value. Instead, the client should query on the (digitalLearningProviders) collection resource in order to navigate to a specific instance of (digitalLearningProviders) to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : digitalLearningProviders-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. -
classification: string
JSON object represented as a string that contains the levels of classification or folder structure of a provider-managed content item in a predefined format.
-
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. -
learningItemAuthorDisplayName: string
Title:
Author
Maximum Length:2000
Display name the learning item author. -
learningItemBusinessDriver: string
Title:
Business Driver
Maximum Length:32
The business driver, such as Compliance or Self Development. -
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. -
learningItemExpectedEffortInSeconds: number
Title:
Expected Effort
Expected effort needed by the learner to complete the learning item. -
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. -
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. -
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. -
learningItemPublisherName: string
Maximum Length:
2000
Name of the publisher of the learning item. -
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. -
learningItemTypeMeaning: string
Title:
Learning Item Type Description
Read Only:true
Maximum Length:255
Meaning for the learningItemType attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
skillsQualifications: string
JSON object represented as a string that contains information about skills and qualifications associated with a provider-managed content item.
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 : digitalLearningProviders-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. -
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 : 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 : digitalLearningProviders-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. -
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. -
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. -
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- 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:
- 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:
- 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:
- assets
-
Parameters:
- digitalLearningProvidersUniqID:
$request.path.digitalLearningProvidersUniqID
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. - digitalLearningProvidersUniqID:
- content
-
Parameters:
- digitalLearningProvidersUniqID:
$request.path.digitalLearningProvidersUniqID
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. - digitalLearningProvidersUniqID: