1. Oracle Global Human Resources Cloud REST APIREST API for Oracle Fusion Cloud HCM
  2. Use Cases
  3. Learning Cloud
  4. Retrieve Learning Records

Retrieve Learning Records

You can use the learnerLearningRecords API to retrieve information about the learning assignment records and the progress made for a learner, and view this information in a portal outside Oracle Learning Cloud. This resource supports viewing of learning records for the learner and learner manager functional roles governed by the applicable data security policy. The assignment records pertain to learning item types course, specialization, video, and tutorial, and include assignments that are voluntary, required, and not recommended. The assignment record status for the learning item indicates the progress made by the learner.

This use case discusses these scenarios:

  • Retrieve Enrolled Learning Assignments
  • Retrieve Completed Learning Assignments
  • Retrieve Learning Assignments by Item Type
  • Retrieve Deep Link for Self Paced Activity
  • Retrieve Details for Instructor Led Activity

For security setup information, see the section Authorize.

Retrieve Enrolled Learning Assignments

In this example, let's retrieve all the learning assignments that a learner has enrolled for, along with the completion details of each item. Let's consider a learner who enrolled for six learning assignments with person number 101. To retrieve the learning records:

  1. Query the person by performing a GET operation on the learnerLearningRecords resource. Use the completionDetails expand parameter and the assignedToNumber query parameter.
  2. Verify the assignment records returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords?expand=completionDetails&q=assignedToNumber=101

Example Response

Here's an example of the response body in JSON format. The learner has six assignment records. In this example, we've shown the first two records for simplicity.

{
 "items": [
        {
          "assignmentRecordId": 300000146170357,
          "assignmentRecordNumber": "OLC101954",
          "assignmentCreatedDate": "2017-05-26T11:41:26.568+00:00",
          "assignmentLastModifiedDate": "2017-05-26T11:41:26.835+00:00",
          "assignmentType": "ORA_REQUIRE_ASSIGNMENT",
          "assignmentJustification": null,
          "assignmentDueDate": "2018-10-28T00:00:00+00:00",
          "assignmentStatus": "ORA_ASSN_REC_ACTIVE",
          "assignmentSubStatus": "ORA_ASSN_REC_NOTSTARTED",
          "assignmentDetailsDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_VIDEO&action=NONE&objKey=itemId%3D300000123964332",
          "assignmentDetailsEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000123964332&LearningItemType=ORA_VIDEO&DisplayMode=details",
          "assignedToId": 300000047888610,
          "assignedToNumber": "101",
          "assignedToPersonEmail": "curtis.feitty_zetm@oracledemos.com",
          "assignedToPersonPhone": "675-5073",
          "assignedToPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000047888610",
          "assignedToDisplayName": "Curtis Feitty",
          "assignerId": 300000049043637,
          "assignerNumber": "541",
          "assignerAttributionType": "ORA_PERSON",
          "assignerDisplayName": "Robert Jackman",
          "assignerPersonPrimaryEmail": null,
          "assignerPersonPrimaryPhone": null,
          "assignerCommentsToLearner": "Required Learning on Business Ethics.",
          "assignerPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000049043637",
          "learningItemId": 300000123964332,
          "learningItemNumber": "OLC100222",
          "learningItemType": "ORA_VIDEO",
          "learningItemTitle": "Ethics",
          "liShortDescription": null,
          "learningItemEffectiveAsOf": "2018-12-05",
          "learningItemDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_VIDEO&action=NONE&objKey=itemId%3D300000123964332",
          "learningItemEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000123964332&LearningItemType=ORA_VIDEO&DisplayMode=details",
          "expectedEffortInHours": null,
          "requestedStartDate": null,
          "requestCompleteByDate": null,
          "enteredWaitlistDate": null,
          "currentWaitlistPosition": null,
          "exitedWaitlistDate": null,
          "purchasedDate": null,
          "assignedDate": "2017-05-26T00:00:00+00:00",
          "withdrawnDate": null,
          "completedDate": null,
          "expirationDate": null,
          "expirationInDaysSysdate": null,
          "validityPeriodRule": null,
          "hasFutureRenewal": null,
          "nextRenewalAssignmentId": null,
          "nextRenewalAssignmentNumber": null,
          "assignmentDueInFromSysdate": -38,
          "completionDetails": [],
            "links": [
                {
                 ...}
        },
        {
            "assignmentRecordId": 300000162698970,
            "assignmentRecordNumber": "OLC102702",
            "assignmentCreatedDate": "2017-12-29T04:42:46.574+00:00",
            "assignmentLastModifiedDate": "2017-12-29T04:42:46.603+00:00",
            "assignmentType": "ORA_REQUIRE_ASSIGNMENT",
            "assignmentJustification": null,
            "assignmentDueDate": "2018-10-25T00:00:00+00:00",
            "assignmentStatus": "ORA_ASSN_REC_ACTIVE",
            "assignmentSubStatus": "ORA_ASSN_REC_NOTSTARTED",
            "assignmentDetailsDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_SPEC&action=NONE&objKey=itemId%3D300000142478293",
            "assignmentDetailsEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000142478293&LearningItemType=ORA_SPECIALIZATION&DisplayMode=details",
            "assignedToId": 300000047888610,
            "assignedToNumber": "101",
            "assignedToPersonEmail": "curtis.feitty_zetm@oracledemos.com",
            "assignedToPersonPhone": "675-5073",
            "assignedToPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000047888610",
            "assignedToDisplayName": "Curtis Feitty",
            "assignerId": null,
            "assignerNumber": null,
            "assignerAttributionType": "ORA_SPECIALIST",
            "assignerDisplayName": "Legal Department",
            "assignerPersonPrimaryEmail": null,
            "assignerPersonPrimaryPhone": null,
            "assignerCommentsToLearner": "Please review and complete the required corporate compliance learning.",
            "assignerPersonImageURL": null,
            "learningItemId": 300000142478293,
            "learningItemNumber": "OLC103003",
            "learningItemType": "ORA_SPECIALIZATION",
            "learningItemTitle": "Corporate Compliance Learning",
            "liShortDescription": "Corporate Compliance Training",
            "learningItemEffectiveAsOf": "2018-12-05",
            "learningItemDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_SPEC&action=NONE&objKey=itemId%3D300000142478293",
            "learningItemEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000142478293&LearningItemType=ORA_SPECIALIZATION&DisplayMode=details",
            "expectedEffortInHours": null,
            "requestedStartDate": null,
            "requestCompleteByDate": null,
            "enteredWaitlistDate": null,
            "currentWaitlistPosition": null,
            "exitedWaitlistDate": null,
            "purchasedDate": null,
            "assignedDate": "2017-11-08T00:00:00+00:00",
            "withdrawnDate": null,
            "completedDate": null,
            "expirationDate": null,
            "expirationInDaysSysdate": null,
            "validityPeriodRule": "ORA_AFT_COMP",
            "hasFutureRenewal": "true",
            "nextRenewalAssignmentId": null,
            "nextRenewalAssignmentNumber": null,
            "assignmentDueInFromSysdate": -41,
            "completionDetails": [],
            "links": [
                {...
                   }
    ],
    "count": 6,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learnerLearningRecords",
            "name": "learnerLearningRecords",
            "kind": "collection"
        }
    ]
}

Retrieve Completed Learning Assignments

In this example, let's retrieve all the learning assignments that a learner has completed. Let's consider a learner with person number 101 who has completed two assignments. To retrieve the learning records:

  1. Query the person by performing a GET operation on the learnerLearningRecords resource. Provide the assignedToNumber query parameter value 101 and the assignmentStatus parameter value ORA_ASSN_REC_COMPLETE.
  2. Verify the completed assignment records returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords?q=assignedToNumber='101';assignmentStatus='ORA_ASSN_REC_COMPLETE'

Example Response

Here's an example of the response body in JSON format.

{
 "items": [
        {
          "assignmentRecordId": 100000288584281,
          "assignmentRecordNumber": "OLC104535",
          "assignmentCreatedDate": "2017-05-26T11:51:12.492+00:00",
          "assignmentLastModifiedDate": "2017-10-25T00:00:00+00:00",
          "assignmentType": "ORA_REQUIRE_ASSIGNMENT",
          "assignmentJustification": null,
          "assignmentDueDate": "2018-10-18T00:00:00+00:00",
          "assignmentStatus": "ORA_ASSN_REC_COMPLETE",
          "assignmentSubStatus": "ORA_ASSN_REC_COMPLETE",
          "assignmentDetailsDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_COURSE&action=NONE&objKey=itemId%3D300000134180868",
          "assignmentDetailsEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000134180868&LearningItemType=ORA_COURSE&DisplayMode=details",
          "assignedToId": 300000047888610,
          "assignedToNumber": "101",
          "assignedToPersonEmail": "curtis.feitty_zetm@oracledemos.com",
          "assignedToPersonPhone": "675-5073",
          "assignedToPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000047888610",
          "assignedToDisplayName": "Curtis Feitty",
          "assignerId": null,
          "assignerNumber": null,
          "assignerAttributionType": "ORA_SPECIALIST",
          "assignerDisplayName": "Workplace Safety Department",
          "assignerPersonPrimaryEmail": null,
          "assignerPersonPrimaryPhone": null,
          "assignerCommentsToLearner": "Please complete this mandatory learning.",
          "assignerPersonImageURL": null,
          "learningItemId": 300000134180868,
          "learningItemNumber": "OLC123002",
          "learningItemType": "ORA_COURSE",
          "learningItemTitle": "Dealing With a Workplace Emergency During a Fire",
          "liShortDescription": null,
          "learningItemEffectiveAsOf": "2017-05-26",
          "learningItemDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_COURSE&action=NONE&objKey=itemId%3D300000134180868",
          "learningItemEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000134180868&LearningItemType=ORA_COURSE&DisplayMode=details",
          "expectedEffortInHours": null,
          "requestedStartDate": null,
          "requestCompleteByDate": null,
          "enteredWaitlistDate": null,
          "currentWaitlistPosition": null,
          "exitedWaitlistDate": null,
          "purchasedDate": null,
          "assignedDate": "2017-05-26T00:00:00+00:00",
          "withdrawnDate": null,
          "completedDate": "2017-05-26T11:59:41.495+00:00",
          "expirationDate": null,
          "expirationInDaysSysdate": null,
          "validityPeriodRule": "ORA_AFT_COMP",
          "hasFutureRenewal": null,
          "nextRenewalAssignmentId": null,
          "nextRenewalAssignmentNumber": null,
          "assignmentDueInFromSysdate": -48,
            "links": [
                {...
           },
           {
            "assignmentRecordId": 300000176108425,
            "assignmentRecordNumber": "OLC127153",
            "assignmentCreatedDate": "2018-12-05T07:59:04.850+00:00",
            "assignmentLastModifiedDate": "2018-12-05T08:03:28.796+00:00",
            "assignmentType": "ORA_JOIN_ASSIGNMENT",
            "assignmentJustification": null,
            "assignmentDueDate": null,
            "assignmentStatus": "ORA_ASSN_REC_COMPLETE",
            "assignmentSubStatus": "ORA_ASSN_REC_COMPLETE",
            "assignmentDetailsDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_COURSE&action=NONE&objKey=itemId%3D300000157015342",
            "assignmentDetailsEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000157015342&LearningItemType=ORA_COURSE&DisplayMode=details",
            "assignedToId": 300000047888610,
            "assignedToNumber": "101",
            "assignedToPersonEmail": "curtis.feitty_zetm@oracledemos.com",
            "assignedToPersonPhone": "675-5073",
            "assignedToPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000047888610",
            "assignedToDisplayName": "Curtis Feitty",
            "assignerId": 300000047888610,
            "assignerNumber": "101",
            "assignerAttributionType": "ORA_PERSON",
            "assignerDisplayName": "Curtis Feitty",
            "assignerPersonPrimaryEmail": "curtis.feitty_zetm@oracledemos.com",
            "assignerPersonPrimaryPhone": "675-5073",
            "assignerCommentsToLearner": null,
            "assignerPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000047888610",
            "learningItemId": 300000157015342,
            "learningItemNumber": "OLC101140",
            "learningItemType": "ORA_COURSE",
            "learningItemTitle": "Management 101 : New Manager Boot Camp",
            "liShortDescription": "Are you a recent first level manager or aspire to be one ? This training is designed to reinforce the knowledge and skill necessary to succeed is this very important role",
            "learningItemEffectiveAsOf": "2018-12-05",
            "learningItemDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_COURSE&action=NONE&objKey=itemId%3D300000157015342",
            "learningItemEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000157015342&LearningItemType=ORA_COURSE&DisplayMode=details",
            "expectedEffortInHours": "20 - 20",
            "requestedStartDate": null,
            "requestCompleteByDate": null,
            "enteredWaitlistDate": null,
            "currentWaitlistPosition": null,
            "exitedWaitlistDate": null,
            "purchasedDate": null,
            "assignedDate": "2018-12-05T00:00:00+00:00",
            "withdrawnDate": null,
            "completedDate": "2018-12-05T08:03:03.533+00:00",
            "expirationDate": null,
            "expirationInDaysSysdate": null,
            "validityPeriodRule": null,
            "hasFutureRenewal": null,
            "nextRenewalAssignmentId": null,
            "nextRenewalAssignmentNumber": null,
            "assignmentDueInFromSysdate": 0,
            "links": [
                {...
                   }
          ]
      }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
      {
         "rel": "self",
         "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learnerLearningRecords",
         "name": "learnerLearningRecords",
         "kind": "collection"
      }
    ]
 }

Retrieve Learning Assignments by Item Type

In this example, let's retrieve a learning assignment of a learner based on the learning item type. Let's consider a learner with person number 101 and filter the learning assignments by item type Specialization. To retrieve the learning record:

  1. Query the person by performing a GET operation on the learnerLearningRecords resource, providing these query parameter values:
    • learningItemType = ORA_SPECIALIZATION
    • learningItemNumber = OLC103003
    • assignedToNumber = 101
  2. Verify the Specialization assignment record returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords?q=learningItemType='ORA_SPECIALIZATION';learningItemNumber='OLC103003';assignedToNumber='101'

Example Response

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "assignmentRecordId": 300000162698970,
            "assignmentRecordNumber": "OLC102702",
            "assignmentCreatedDate": "2017-12-29T04:42:46.574+00:00",
            "assignmentLastModifiedDate": "2017-12-29T04:42:46.603+00:00",
            "assignmentType": "ORA_REQUIRE_ASSIGNMENT",
            "assignmentJustification": null,
            "assignmentDueDate": "2018-10-25T00:00:00+00:00",
            "assignmentStatus": "ORA_ASSN_REC_ACTIVE",
            "assignmentSubStatus": "ORA_ASSN_REC_NOTSTARTED",
            "assignmentDetailsDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_SPEC&action=NONE&objKey=itemId%3D300000142478293",
            "assignmentDetailsEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000142478293&LearningItemType=ORA_SPECIALIZATION&DisplayMode=details",
            "assignedToId": 300000047888610,
            "assignedToNumber": "101",
            "assignedToPersonEmail": "curtis.feitty_zetm@oracledemos.com",
            "assignedToPersonPhone": "675-5073",
            "assignedToPersonImageURL": "https://<host>:<port>/hcmUI/personImage?personId=300000047888610",
            "assignedToDisplayName": "Curtis Feitty",
            "assignerId": null,
            "assignerNumber": null,
            "assignerAttributionType": "ORA_SPECIALIST",
            "assignerDisplayName": "Legal Department",
            "assignerPersonPrimaryEmail": null,
            "assignerPersonPrimaryPhone": null,
            "assignerCommentsToLearner": "Please review and complete the required corporate compliance learning.",
            "assignerPersonImageURL": null,
            "learningItemId": 300000142478293,
            "learningItemNumber": "OLC103003",
            "learningItemType": "ORA_SPECIALIZATION",
            "learningItemTitle": "Corporate Compliance Learning",
            "liShortDescription": "Corporate Compliance Training",
            "learningItemEffectiveAsOf": "2018-12-05",
            "learningItemDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_SPEC&action=NONE&objKey=itemId%3D300000142478293",
            "learningItemEmbedLink": "https://<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000142478293&LearningItemType=ORA_SPECIALIZATION&DisplayMode=details",
            "expectedEffortInHours": null,
            "requestedStartDate": null,
            "requestCompleteByDate": null,
            "enteredWaitlistDate": null,
            "currentWaitlistPosition": null,
            "exitedWaitlistDate": null,
            "purchasedDate": null,
            "assignedDate": "2017-11-08T00:00:00+00:00",
            "withdrawnDate": null,
            "completedDate": null,
            "expirationDate": null,
            "expirationInDaysSysdate": null,
            "validityPeriodRule": "ORA_AFT_COMP",
            "hasFutureRenewal": "true",
            "nextRenewalAssignmentId": null,
            "nextRenewalAssignmentNumber": null,
            "assignmentDueInFromSysdate": -41,
            "links": [
                {
                 ...}
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learnerLearningRecords",
            "name": "learnerLearningRecords",
            "kind": "collection"
        }
    ]
}

Retrieve Deep Link for Self Paced Activity

In this example, let's retrieve the deep link for a self-paced activity that the learner has enrolled in. Let's first retrieve the completion details of the assignment, which include the self-paced activity details and the deep link for the activity. To retrieve the completion details:

  1. Query the person by performing a GET operation on the learnerLearningRecords resource. Use the learningItemNumber query parameter and the completionDetails expand parameter.
  2. Verify the value of the activityAttemptDeepLink parameter returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords?q=learningItemNumber=OLC123457&expand=completionDetails&fields=completionDetails:activityAttemptDeepLink

Example Response

Here's an example of the response body in JSON format.

{
 "items": [
     {
         "completionDetails": [
             {
                 "activityAttemptDeepLink": "https://<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_OFFERING&action=NONE&objKey=itemId%3D300000174975657%3BactivityLearningItemId%3D300000174975740%3BshowActivity%3Dactivity",
                 "links": [
                     {
                       ...}
             ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learnerLearningRecords",
            "name": "learnerLearningRecords",
            "kind": "collection"
        }
    ]
}

Retrieve Details for Instructor Led Activity

In this example, let's retrieve the completion details of an instructor-led offering completed by the learner. This is a 3-day instructor-led offering where day 1 is offered online and day 2 and day 3 are onsite activities. The learner has completed all the three activities. You can view completion details such as activity date, start time, end time, and the link for the virtual classroom for day 1. To retrieve the completion details:

  1. Query the person by performing a GET operation on the learnerLearningRecords resource. Use the learningItemNumber query parameter and the completionDetails expand parameter.
  2. Verify the completion details of the instructor-led offering returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords?q=learningItemNumber='OLC101140'&expand=completionDetails&fields=completionDetails:activityDate,activityStartTime,activityEndTime,virtualClassroomJoinLink

Example Response

Here's an example of the response body in JSON format.

{
 "items": [
     {
          "completionDetails": [
             {
                 "activityDate": "2018-10-09",
                 "activityStartTime": "12:00 PM",
                 "activityEndTime": "3:45 PM",
                 "virtualClassroomJoinLink": "https://oracle.webex.com/wbxmjs/joinservice/",
                 "links": [
                        {
                         ...}                        
              },
              {
                  "activityDate": "2018-10-10",
                  "activityStartTime": "8:00 AM",
                  "activityEndTime": "3:45 PM",
                  "virtualClassroomJoinLink": null,
                  "links": [
                        {
                         ...}                        
              },
              {
                  "activityDate": "2018-10-11",
                  "activityStartTime": "8:00 AM",
                  "activityEndTime": "3:55 PM",
                  "virtualClassroomJoinLink": null,
                  "links":[
                      {
                       ...}
          ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learnerLearningRecords",
            "name": "learnerLearningRecords",
            "kind": "collection"
        }
    ]
}