Get a learning content item
/hcmRestApi/resources/11.13.18.05/learningContentItems/{ContentId}
Request
-
ContentId(required): integer
Unique identifier for the content object.
-
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).
-
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
- application/json
Default Response
-
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.
object
-
AssessmentAttempts: integer
Indicates the number of attempts allowed for the assessment.
-
AssessmentCode: string
Unique identifier for the assessment.
-
AssessmentMasteryScore: number
Indicates the minimum score needed to pass the assessment.
-
AssessmentScoreVisibleToAdministrator: string
Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.
-
AssessmentScoreVisibleToLearner: string
Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
-
AssessmentTimeLimit: number
Indicates the time limit for the assessment.
-
AssessmentTimeLimitUOM: string
Indicates the unit of measure for the assessment time limit.
-
CompletedAssessmentVisibleToLearner: string
Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
-
ContentId: integer
Unique identifier for the content object.
-
Description: string
Description of the content item.
-
EndDate: string
(date)
End date of the content item.
-
FileName: string
File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.
-
IngestionStatus: string
Ingestion status of the content item. For Video and SCORM/AICC/HACP content, valid value is ORA_MED_TRANSCODING.
-
ItemNumber: string
Unique user key for the content item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MarkCompleteOnOpen: string
Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.
-
ReplaceStatus: string
Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.
-
StartDate: string
(date)
Start date of the content item.
-
Status: string
Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.
-
Title: string
Tiitle of the content item.
-
TrackingType: string
Tracking type for the content item. Valid values are ORA_SCORM_12, ORA_SCORM_2004, ORA_HACP, ORA_PDF, ORA_AUTO, and ORA_VIDEO.
-
UploadAuthToken: string
Upload authentication token generated for the learning content item.
-
UploadLocation: string
Upload location of the learning content item.
-
URL: string
Starting URL of the content item.
-
UUID: string
Internal value, no input required.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following examples show how to retrieve these learning content items by submitting a GET request on the REST resource using cURL.
- SCORM learning content
- Video learning content
- PDF learning content
- Web Link learning content
SCORM Learning Content
The following is an example of the cURL command.
curl -vs -u '<username>:<password>' -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems/<CONTENT_ID> &> GetWebContentDetails.out
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ContentId" : 300100101142985, "Title" : "REST: SS 201710081350 Jefferson", "FileName" : null, "ItemNumber" : "REST-201710081350-SCORM", "TrackingType" : "ORA_SCORM_12", "Description" : "REST: SS 201710081350 Jefferson Desc", "StartDate" : "2017-06-15", "EndDate" : "2018-06-14", "UUID" : "92cfc80e-953b-449c-90a6-18afa401628f", "Status" : "ORA_CONT_INACTIVE", "URL" : null, "AuthToken" : null, "Location" : "scorm/FA.HCM.PER.HcmEngmtVideoShare-92cfc80e-953b-449c-90a6-18afa401628f_private/92cfc80e-953b-449c-90a6-18afa401628f.zip", "IngestionStatus" : "ORA_MED_COMPLETE", "Operation" :"", "links":[8] 0: {... ...} }
Video Learning Content
The following is an example of the cURL command.
curl -vs -u '<username>:<password>' -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems/<CONTENT_ID> &> GetVideoContentDetails.out
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ContentId" : 300100101257750, "Title" : "REST: SS 201710091906 video_4_secs", "FileName" : "video_4_secs.mov", "ItemNumber" : "REST-201710091906", "TrackingType" : "ORA_CONTENT_VIDEO", "Description" : "REST: SS 201710091906 video_4_secs Desc", "StartDate" : "2017-06-15", "EndDate" : "2018-06-14", "UUID" : "e778388a-15f8-4261-9338-d3b702aa8323", "Status" : "ORA_CONT_ACTIVE", "URL" : null, "AuthToken" : null, "Location" : "delivery/49/04/490493d8-f3b5-4485-a9f5-9ab398d2c1a1/e778388a-15f8-4261-9338-d3b702aa8323_,10,25,45,00k.mp4", "IngestionStatus" : "ORA_MED_COMPLETE", "Operation" : "", "links":[8] 0: {... ...} }
PDF Learning Content
The following is an example of the cURL command.
curl -vs -u '<username>:<password>' -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems/<CONTENT_ID> &> GetPDFContentDetails.out
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ContentId" : 300100101257756, "Title" : "REST: SS 201710091949 TLearn", "FileName" : "TLearn.pdf", "ItemNumber" : "REST-201710091949-PDF", "TrackingType" : "ORA_PDF", "Description" : "REST: SS 201710091949 TLearn Desc", "StartDate" : "2017-06-15", "EndDate" : "2018-06-14", "UUID" : "60c5e47d-bc50-44c0-b6ed-736508eb73e8", "Status" : "ORA_CONT_ACTIVE", "URL" : "scorm/FA.HCM.PER.HcmEngmtVideoShare-60c5e47d-bc50-44c0-b6ed-736508eb73e8_private/60c5e47d-bc50-44c0-b6ed-736508eb73e8.pdf"", "AuthToken" : null, "Location" : "scorm/FA.HCM.PER.HcmEngmtVideoShare-60c5e47d-bc50-44c0-b6ed-736508eb73e8_private/60c5e47d-bc50-44c0-b6ed-736508eb73e8.pdf", "IngestionStatus" : null, "Operation" : "", "links":[8] 0: {... ...} }
Web Links Content
The following is an example of the cURL command.
curl -vs -u '<username>:<password>' -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems/<CONTENT_ID> &> GetWebLinkContentDetails.out
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ContentId" : 300100101257996, "Title" : "REST: SS 201710092052 WebLink leadership-skills", "FileName" : null, "ItemNumber" : "REST-201710092052-WebLink", "TrackingType" : "ORA_AUTO", "Description" : "REST: SS 201710092052 WebLink leadership-skills Desc", "StartDate" : "2017-06-15", "EndDate" : "2018-06-14", "UUID" : "5fec638b-7a52-43af-a322-49f21cc5f81c", "Status" : "ORA_CONT_ACTIVE", "URL" : "https://www.coursera.org/learn/leadership-skills", "AuthToken" : null, "Location" : null, "IngestionStatus" : null, "Operation" : "", "links":[8] 0: {... ...} }