May 26, 2024
How to GET the details of Courses/Learning Paths/Certifications using ALM API
Anupam Gogoi Follow
Comments
(0)
Share
May 26, 2024
How to GET the details of Courses/Learning Paths/Certifications using ALM API
Anupam Gogoi
https://www.linkedin.com/in/anupam-gogoi-97a14888/
Wizard
Followers: 22 people
Follow
Anupam Gogoi Follow
(0)
0
Summary

This API endpoint is used to extract the details of a learning object such as course, learning paths and certificates and gets the details of the learning object’s ID, Type, Author Names, Date Created, Date Published, Date Updated, Duration, Effective Modified Date, Effectiveness Index, Enrollment Type, Has Optional Learning Object Resources, Has Preview, Is External, Is Multi attempt Enabled, Is Prerequisite Enforced, Is Sub-LO Order Enforced, LO Format, LO Resource Completion Count, LO module Type, Module Reset Enabled, State, Tags, Unenrollment Allowed, Localized Metadata, Rating (Average Rating, Ratings Count), Relationships (Author name, Instances, Skills) data from ALM.

GET /learningObjects

  • Retrieves the details of learning objects

Implementation Notes

Get the details of all the learning objects that Learner is enrolled, completed or enabled by the Admin.

Response Class (Status 200)

Operation successful

  • Example Value
{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "authorNames": [
          "string"
        ],
        "bannerUrl": "string",
        "completionDateSameAsApprovalDate": true,
        "dateCreated": "string",
        "datePublished": "string",
        "dateUpdated": "string",
        "effectiveModifiedDate": "string",
        "effectivenessIndex": 0,
        "enrollmentType": "string",
        "externalSkillNames": [
          "string"
        ],
        "hasOptionalLoResources": true,
        "hasPreview": true,
        "imageUrl": "string",
        "instanceSwitchEnabled": true,
        "isBookmarked": true,
        "isEnhancedLP": true,
        "isExternal": true,
        "isMqaEnabled": true,
        "isPrerequisiteEnforced": true,
        "isSubLoOrderEnforced": true,
        "loFormat": "string",
        "loResourceCompletionCount": 0,
        "loType": "string",
        "moduleResetEnabled": true,
        "multienrollmentEnabled": true,
        "price": 0,
        "rootCertificationId": "string",
        "state": "string",
        "tags": [
          "string"
        ],
        "unenrollmentAllowed": true,
        "uniqueId": "string",
        "catalogLabels": [
          {
            "description": "string",
            "id": "string",
            "mandatory": true,
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "extensionOverrides": [
          {
            "id": "string",
            "defaultScope": "string",
            "enabled": "string",
            "height": 0,
            "invocationType": "string",
            "launchType": "string",
            "url": "string",
            "width": 0
          }
        ],
        "localizedMetadata": [
          {
            "description": "string",
            "id": "string",
            "label": "string",
            "locale": "string",
            "name": "string",
            "overview": "string",
            "richTextOverview": "string",
            "type": "string"
          }
        ],
        "prequisiteConstraints": [
          {
            "mandatory": true,
            "prerequisiteLOId": "string"
          }
        ],
        "products": [
          {
            "id": "string",
            "levels": [
              "string"
            ],
            "name": "string"
          }
        ],
        "rating": {
          "averageRating": 0,
          "ratingsCount": 0
        },
        "roles": [
          {
            "id": "string",
            "levels": [
              "string"
            ],
            "name": "string"
          }
        ],
        "sections": [
          {
            "loIds": [
              "string"
            ],
            "mandatory": true,
            "mandatoryLOCount": 0,
            "sectionId": "string"
          }
        ]
      },
      "relationships": {
        "authors": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        },
        "instances": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        },
        "prerequisiteLOs": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        },
        "skills": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        },
        "subLOs": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        },
        "supplementaryLOs": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        },
        "supplementaryResources": {
          "data": [
            {
              "type": "string",
              "id": "string"
            }
          ]
        }
      }
    }
  ]
}
    application/vnd.api+json;charset=UTF-8

Parameters

Parameter Value Description Parameter Type Data Type
refer –

https://elearning.adobe.com/?p=171607

 Mention any additional model to be tagged along with this model query string
Mention the last cursor till the records are fetched query string
Mention the maximum number of records to be displayed per page. Max allowed is 10 query integer
                  course  (default)            learningProgram            jobAid            certification Choose the filter based on the type of learning object. query Array[]
Mention the catalog ids to filter the result from query Array[]
                  true            false Choose whether you want to filter based on bookmarks. No other filter or field will be applicable if you choose this except page_limit, page_offset and includes. query boolean
                  name  (default)            date            -name            -date            dueDate            effectiveness            rating            -rating Choose the type of sorting to be applied to the results. Sorting based on recommendation score will only be applicable for PRL enabled LOs query string
Mention learningObjects Ids for which data is being requested. page[offset] & page[limit] are not honored if this field is mentioned.Max allowed number of ids that can be included is 10 query Array[]
                  true  (default)            false Set filter.ignoreEnhancedLP=false to list enhanced learning programs, default value is true. query boolean

Response Messages

HTTP Status Code Reason Response Model Headers
400 A generic http bad request error 
{
  "meta": {
    "error": "string",
    "detail": "string"
  }
}
401 A generic http unauthorized access error. Access is denied due to invalid credentials 
{
  "meta": {
    "error": "string",
    "detail": "string"
  }
}

Curl 

curl -X GET --header 'Accept: application/vnd.api+json' --header 'Authorization: oauth 2fd8778caecd258732b8601ad4fe8e203' 'https://learningmanager.adobe.com/primeapi/v2/learningObjects?page[limit]=2&filter.loTypes=course&sort=name'

Request URL 

https://learningmanager.adobe.com/primeapi/v2/learningObjects?page[limit]=2&filter.loTypes=course&sort=name

Response Body 

{
  "links": {
    "self": "https://learningmanager.adobe.com/primeapi/v2/learningObjects?page[limit]=2&filter.loTypes=course&sort=name",
    "next": "https://learningmanager.adobe.com/primeapi/v2/learningObjects?page[limit]=2&filter.loTypes=course&sort=name&page[cursor]=eyJjb3Vyc2UiOjJ9"
  },
  "data": [
    {
      "id": "course:9612385",
      "type": "learningObject",
      "attributes": {
        "authorNames": [
          "er"
        ],
        "dateCreated": "2024-04-17T11:11:21.000Z",
        "datePublished": "2024-04-17T11:11:36.000Z",
        "dateUpdated": "2024-04-17T11:11:36.000Z",
        "duration": 1380,
        "effectiveModifiedDate": "2024-04-17T11:20:30.000Z",
        "effectivenessIndex": 0,
        "enrollmentType": "Self Enroll",
        "hasOptionalLoResources": false,
        "hasPreview": false,
        "isExternal": false,
        "isMqaEnabled": false,
        "isPrerequisiteEnforced": false,
        "isSubLoOrderEnforced": false,
        "loFormat": "Self Paced",
        "loResourceCompletionCount": 1,
        "loType": "course",
        "moduleResetEnabled": false,
        "state": "Published",
        "unenrollmentAllowed": false,
        "localizedMetadata": [
          {
            "description": "",
            "locale": "en-US",
            "name": " CRM4"
          }
        ],
        "rating": {
          "averageRating": 0,
          "ratingsCount": 0
        }
      },
      "relationships": {
        "instances": {
          "data": [
            {
              "id": "course:9612385_10288934",
              "type": "learningObjectInstance"
            }
          ]
        },
        "skills": {
          "data": [
            {
              "id": "course:9612385_414812",
              "type": "learningObjectSkill"
            }
          ]
        }
      }
    },
    {
      "id": "course:3956397",
      "type": "learningObject",
      "attributes": {
        "authorNames": [
          "Anupam Gogoi"
        ],
        "dateCreated": "2022-02-18T19:17:28.000Z",
        "datePublished": "2022-02-18T19:18:34.000Z",
        "dateUpdated": "2022-02-18T19:18:34.000Z",
        "duration": 1800,
        "effectiveModifiedDate": "2023-06-30T07:05:40.000Z",
        "effectivenessIndex": 0,
        "enrollmentType": "Self Enroll",
        "hasOptionalLoResources": false,
        "hasPreview": false,
        "isExternal": false,
        "isMqaEnabled": true,
        "isPrerequisiteEnforced": false,
        "isSubLoOrderEnforced": false,
        "loFormat": "Self Paced",
        "loResourceCompletionCount": 1,
        "loType": "course",
        "moduleResetEnabled": false,
        "state": "Published",
        "tags": [
          "anupam"
        ],
        "unenrollmentAllowed": true,
        "localizedMetadata": [
          {
            "description": "",
            "locale": "en-US",
            "name": " Course Quiz Responses Account ID 69951 "
          }
        ],
        "rating": {
          "averageRating": 0,
          "ratingsCount": 0
        }
      },
      "relationships": {
        "authors": {
          "data": [
            {
              "id": "15263446",
              "type": "user"
            }
          ]
        },
        "instances": {
          "data": [
            {
              "id": "course:3956397_4396934",
              "type": "learningObjectInstance"
            }
          ]
        },
        "skills": {
          "data": [
            {
              "id": "course:3956397_279445",
              "type": "learningObjectSkill"
            }
          ]
        }
      }
    }
  ]
}

Response Code

200

Response Headers

{
  "access-control-allow-credentials": "true",
  "access-control-allow-headers": "X-acap-all-roles, X-acap-account,X-acap-user,X-acap-caller-role,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type, x-experience-api-version, Authorization, X-CSRF-TOKEN, X-HTTP-Method-Override, X-acap-ug-manager-scope, X-acap-extension-token",
  "access-control-allow-methods": "GET, POST, OPTIONS, PUT, HEAD, DELETE, PATCH",
  "access-control-expose-headers": "Requested-Accept-Language, x-rate-limit, x-burst, x-excess-requests-per-second, Retry-After",
  "content-encoding": "gzip",
  "content-type": "application/vnd.api+json;charset=UTF-8",
  "date": "Sun, 26 May 2024 15:37:57 GMT",
  "requested-accept-language": "en-US,en;q=0.9",
  "server": "openresty",
  "server-timing": "server_resp;dur=804",
  "strict-transport-security": "max-age=31536000; includeSubDomains",
  "x-content-type-options": "nosniff",
  "x-frame-options": "SAMEORIGIN",
  "x-request-id": "gw64f5ada179cc4597453yed6dc746e6b8113",
  "x-xss-protection": "1"
}
Comments
(0)
Share
Anupam Gogoi
https://www.linkedin.com/in/anupam-gogoi-97a14888/
Wizard
Followers: 22 people
Follow
Anupam Gogoi Follow
https://www.linkedin.com/in/anupam-gogoi-97a14888/
(0)
Similar Blogs
0 Comments
Add Comment