Steps to Extract Learner Transcript Reports Using ALM v2 API

Step 1: Create Authentication

To execute the Job API from an external application/program/script, you need to authenticate your external system by creating an application in ALM.

1. Register Application:
   • Navigate to Integration Admin > Applications > Register.
   • Register a new application to obtain the App ID and App Secret.
2. Generate Refresh Token:
   • Use the App ID and App Secret to generate a refresh token on ALM’s token generator page.
   • Navigate to Integration Admin > Developer Resources > Access Tokens for Testing and Development.
3. Generate Access Token:
   • Use the following POST request to generate an access (bearer) token:
     POST https://learningmanager.adobe.com/oauth/token/refresh?client_id=YOUR_APP_ID&client_secret=YOUR_APP_SECRET&refresh_token=YOUR_REFRESH_TOKEN
   • Replace YOUR_APP_ID, YOUR_APP_SECRET, and YOUR_REFRESH_TOKEN with the respective values obtained in the previous steps.

Step 2: Execute the Job API

To generate the learner transcript report, you need to execute the Job API with the appropriate payload.

Try it in ALM swagger – https://learningmanager.adobe.com/docs/primeapi/v2/#!/job/post_jobs

1. Define the Payload:
   • Here’s a sample payload to generate the learner transcript report:

     json

     {
"data": {
"type": "job",
"attributes": {
"description": "description of your choice",
"jobType": "generateLearnerTranscript",
"payload": {
"fromDate": "2024-04-20T18:30:00.000Z",
"toDate": "2024-05-12T18:30:00.000Z",
"userGroups": 6339298,
"includeModuleLevelDetails": "true",
"includeDeletedLearners": "true",
"enrollmentStatus": "selectAll"
}
}
}
}

2. Execute POST Request:
   • Use the following endpoint to create the job:

     POST /jobs

      

   • Example request:
     POST https://learningmanager.adobe.com/primeapi/v2/jobs


Step 3: Get User Group ID

To include all learners in your account, you need the user group ID.

1. Retrieve User Group ID:
   • Use this endpoint to get the user group ID:
     GET https://learningmanager.adobe.com/primeapi/v2/userGroups/search?nameStartsWith=All Learners


Step 4: Retrieve the Job ID and Download the CSV

Once the job is successfully executed, ALM will provide a Job ID. Use this Job ID to fetch the download link.

1. Fetch Job ID:
   • On successful execution, you will receive a Job ID in the response.
2. Download the CSV File:
   • Use the following GET request with the Job ID to get the S3 URL for the CSV file:
     GET /jobs/{Job_ID}
 (note that it may take 2 to 10 mins for the system to generate the link due to data size)
3. Example Request:
   • Replace {Job_ID} with the actual Job ID received:
     GET https://learningmanager.adobe.com/primeapi/v2/jobs/{Job_ID}


Additional Resources

For more detailed information and additional capabilities of the ALM v2 API, refer to the ALM Developer Manual.

Conclusion

By following these steps, you can efficiently extract learner transcript reports from Adobe Learning Manager using the Job API. This method ensures that you can automate and streamline the process of obtaining critical learning data, making it easier to manage and analyze your learners’ progress and performance.

For further assistance or any queries, feel free to refer to the detailed documentation provided by Adobe Learning Manager or contact their support team.