Get the learning item associated with the specified learning assignment
get
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}
Request
Path Parameters
-
learnerLearningRecordsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
-
learningItemDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Noncatalog Learning Item resource and used to uniquely identify an instance of Noncatalog Learning Item. The client should not generate the hash key value. Instead, the client should query on the Noncatalog Learning Item collection resource in order to navigate to a specific instance of Noncatalog Learning Item 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 : learnerLearningRecords-learningItemDetails-item-response
Type:
Show Source
object
-
actualCpeUnits: number
Title:
Actual CPE Units
Continuing professional education units that the learner achieved for this assignment. -
learningItemCpeType: string
Title:
Learning Item CPE Type
Maximum Length:30
Continuing professional education type for the learning item. Valid values are defined in the CpeTypeLOV list. -
learningItemCpeTypeMeaning: string
Read Only:
true
Maximum Length:255
Description of the continuing professional education type for the learning item. -
learningItemDescription: string
Maximum Length:
4000
Description of the learning item. -
learningItemDFF: array
learningItemDFF
-
learningItemExpectedEffort: number
Expected effort to complete the learning item
-
learningItemExpectedEffortInSeconds: number
Expected effort, in seconds, to complete the assigned learning item.
-
learningItemExpectedEffortUnits: string
Maximum Length:
30
Default Value:ORA_DUR_HOUR
Unit of measurement for the expected and actual effort to complete the learning item, such as day, hour, minute. Valid values are defined in the list EffortUnitsLOV. -
learningItemExpectedEffortUnitsMeaning: string
Read Only:
true
Maximum Length:255
Description of expected effort units of measure. -
learningItemId: integer
(int64)
Unique identifier of the assigned learning item.
-
learningItemNumber: string
Maximum Length:
2000
Number given to the assigned learning item. -
learningItemPrice: number
Cost
-
learningItemPriceCurrency: string
Maximum Length:
30
Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA. -
learningItemSubType: string
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
Maximum Length:
250
Title of the learning item. -
learningItemType: string
Maximum Length:
32
Learning item type, such as Course, Specialization, Tutorial, Video, or eLearning. Valid values are defined in the list AssignedLearningItemTypeLOV. -
learningItemTypeMeaning: string
Read Only:
true
Maximum Length:255
Meaning associated with the learning item type. -
learningItemURL: string
Maximum Length:
4000
URL that can be used to embed the learning item page in other pages. -
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 : learnerLearningRecords-learningItemDetails-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 : 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.
Links
- CpeTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_CPE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemCpeType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- learningItemDFF
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- learningItemDetailsUniqID:
$request.path.learningItemDetailsUniqID
- learnerLearningRecordsUniqID: