Introduction
Using the Learn365 API, you can get a list of the target skill rules that are available on the tenant. This article describes how to get a list of target skill rules on the tenant via the API, as well as information about a single rule, and a list of rules defined for specific learners.
For more information about target skill rules, and how to manage them via the Learn365 Admin Center, see this article.
Get a list of target skill rules on the tenant
1. Go to https://api.365.systems/ and make sure you're authorized with an API key.
2. In the TargetSkills section, find the GET /services/skills/TargetSkills endpoint and select Try it out in the top right-hand corner.
3. Use query options parameters to control the data in the response.
If you don't use query option parameters to filter the results, the response will contain information about all target skills on the tenant.
You can filter the results by:
- Id – the target skill rule ID. Using the ID, you can get information about a single target skill rule by sending the GET /services/skills/TargetSkills/{id} API request.
- Name – the target skill rule title.
- isGlobal – "isGlobal": true means that the target skill rule is defined for everyone in the organization. In the $filter field, you can enter, for example, isGlobal eq true or isGlobal eq false.
4. Select Execute to run the request.
5. Go to the Response block to check the results:
- 200 code with a list of target skill rules in the response body indicates a successful response.
- In the Response body field, you'll see a list of all the target skill rules on the tenant, together with their Id, Name, and isGlobal parameters.
- In case of errors, the response body contains the error object with the code and message keys explaining the issue.
Get a list of target skill rules defined for specific users
1. Go to https://api.365.systems/ and make sure you're authorized with an API key.
2. In the TargetSkills section, find the POST /services/skills/TargetSkills/ByUsers endpoint and select Try it out in the top right-hand corner.
3. In the request body, enter the user IDs. To find the user IDs via the API, see this article.
The request body should look similar to this:
EXAMPLE
{
"userIds": [ "fa716ed4-d19f-474b-b9b7-05fcd50532fb", "bbee9b29-5109-49e1-1a2e-08dd138685f0"]
}
4. Select Execute to run the request.
5. Go to the Response block to check the results:
- 200 code with a list of user IDs and target skill rules in the response body indicates a successful response.
- In the Response body field, you'll see a list of user IDs and target skill rules that have been defined for the users, together a list of target skills, skill levels, and other parameters.
- In case of errors, the response body contains the error object with the code and message keys explaining the issue.
Comments
Article is closed for comments.