API v2.0 - Skills Documentation - Example Dozuki Site

GET /skills/teams/:teamid/courses

Returns a list of all courses directly assigned to the team, along with the team's average skill rating for each course.

Query Parameters

query — Optional — string

A search query string used to find specific courses. Matches any course whose name contains the query.

order — Optional — enum

Return the courses in ascending or descending order by average_skill_rating. Defaults to DESC.

Possible Values:

ASC
DESC

offset — Optional — integer

The number of courses to skip from the beginning. Defaults to 0.

limit — Optional — integer

The maximum number of courses to include in the response. Range: [1, 20]. Defaults to 20.

Response

Status: 200 Ok

{
    "courses": [
        {
            "wikiid": 1,
            "title": "Lathe Machines",
            "average_skill_rating": 0.75,
            "constituents": {
                "training": {
                    "value": 0.5
                },
                "supervisor": {
                    "value": 0.5
                }
            }
        },
        {
            "wikiid": 2,
            "title": "Drilling Machines",
            "average_skill_rating": 0.5,
            "constituents": {
                "training": {
                    "value": 0.5
                },
                "supervisor": {
                    "value": 0.5
                }
            }
        },
        {
            "wikiid": 3,
            "title": "Milling Machines",
            "average_skill_rating": 0.16,
            "constituents": {
                "training": {
                    "value": 0.5
                },
                "supervisor": {
                    "value": 0.5
                }
            }
        }
    ],
    "hasMore": true
}

GET /skills/weights

Get all skill rating weight types and values. Authenticated user must be an admin or team lead.

PUT /skills/weights

Update skill rating values. All values within a group must add to 1. If a group is omitted from the request body then it will not be changed. Currently limited to admin users.

POST /skills/matrix

Retrieve skills matrix data for a list of users and docs. Only guides are supported at this time, and wiki support will be added in the future. Authenticated user must be an admin or team lead.

Request Body

userids — Required — array: An array containing userids
docs — Required — array: An array containing objects with a docid and doctype
teamid — Optional — number: Identifier for the team. This parameter becomes required if userids are not provided.
courseid — Optional — number: Identifier for the course. This parameter becomes required if guideids are not provided.

Response

Status: 200 Ok

{
    "supervisorRatingsEditableByCurrentUser": false,
    "users": [
        {
            "userid": 1,
            "name": "Kristen",
            "image": "",
            "average_score": 0.917
        },
        {
            "userid": 3,
            "name": "Joe",
            "image": "",
            "average_score": 0.875
        },
        {
            "userid": 2,
            "name": "Eli",
            "image": "",
            "average_score": 0.5
        }
    ],
    "docs": [
        {
            "docid": 1,
            "doctype": "guide",
            "title": "Drilling Machines",
            "users": [
                {
                    "userid": 1,
                    "skill_rating": 0.75
                },
                {
                    "userid": 3,
                    "skill_rating": 1
                },
                {
                    "userid": 2,
                    "skill_rating": 0
                }
            ]
        },
        {
            "docid": 2,
            "doctype": "guide",
            "title": "Milling Machines",
            "users": [
                {
                    "userid": 1,
                    "skill_rating": 1
                },
                {
                    "userid": 3,
                    "skill_rating": 0.75
                },
                {
                    "userid": 2,
                    "skill_rating": 0.5
                }
            ]
        },
        {
            "docid": 3,
            "doctype": "guide",
            "title": "Lathe Machines",
            "users": [
                {
                    "userid": 1,
                    "skill_rating": 1
                },
                {
                    "userid": 3,
                    "skill_rating": 1
                },
                {
                    "userid": 2,
                    "skill_rating": 0
                }
            ]
        },
        {
            "docid": 4,
            "doctype": "guide",
            "title": "Pressing Machines",
            "users": [
                {
                    "userid": 1,
                    "skill_rating": 0
                },
                {
                    "userid": 3,
                    "skill_rating": 0.75
                },
                {
                    "userid": 2,
                    "skill_rating": 0.5
                }
            ]
        }
    ]
}

GET /skills/ratings/{doctype}/{docid}/{userid}

Get a detailed breakdown of the training and skill rating for a user and corresponding doc. The data includes the current weighting, value assigned to the user, and calculated total. Authenticated user must be an admin or team lead.

POST /skills/ratings/supervisor

Sets the supervisor rating for multiple users and documents. Rating is on a scale from 0 to 1. If a rating already exists for the user and document, it will be updated. Authenticated user must be an admin or team lead.

POST /skills/ratings/supervisor/:doctype/:docid/:userid

Sets supervisor rating for a user on a document. Rating is on a scale from 0 to 1. If a rating already exists it will be updated. Authenticated user must be an admin or team lead.

GET /skills/courses/:wikiid/assignees

Returns a list of both assignee types, teams and users, along with the average skill rating for each.

Query Parameters

query — Optional — string

A search query string used to find specific assignees. Matches any team or user in the result set whose name contains the query.

order — Optional — enum

Return the assignees in ascending or descending order by average_skill_rating. Defaults to DESC.

Possible Values:

ASC
DESC

offset — Optional — integer

The number of assignees to skip from the beginning. Defaults to 0.

limit — Optional — integer

The maximum number of assignees to include in the response. Range: [1, 20]. Defaults to 20.

Response

Status: 200 Ok

{
    "assignees": [
        {
            "assigneetype": "TEAM",
            "assigneeid": 4,
            "name": "Team One",
            "average_skill_rating": 2.8,
            "constituents": {
                "training": {
                    "value": 2.5
                },
                "supervisor": {
                    "value": 2.5
                }
            }
        },
        {
            "assigneetype": "USER",
            "assigneeid": 66,
            "name": "Burt Reynolds",
            "average_skill_rating": 2.7,
            "constituents": {
                "training": {
                    "value": 2.5
                },
                "supervisor": {
                    "value": 2.5
                }
            }
        },
        {
            "assigneetype": "TEAM",
            "assigneeid": 54,
            "name": "Team Two",
            "average_skill_rating": 2.6,
            "constituents": {
                "training": {
                    "value": 2.5
                },
                "supervisor": {
                    "value": 2.5
                }
            }
        },
        {
            "assigneetype": "USER",
            "assigneeid": 4,
            "name": "Samuel L. Jackson",
            "average_skill_rating": 2.5,
            "constituents": {
                "training": {
                    "value": 2.5
                },
                "supervisor": {
                    "value": 2.5
                }
            }
        }
    ],
    "hasMore": true
}

GET /skills/guides/:guideid/assignees

Returns a list of all assignees for a specific guide, and contains the skill rating data for each individual or team. This includes the average skill rating for each assignee of the specified guide.

Query Parameters

query — Optional — string

A search query string used to find a specific user or team. Matches any team or username with the name provided from the query.

order — Optional — enum

Return the assignees in ascending or descending order by average_skill_rating. Defaults to DESC.

Possible Values:

ASC
DESC

offset — Optional — integer

The number of assignees to skip from the beginning. Defaults to 0.

limit — Optional — integer

The maximum number of assignees to include in the response. Range: [1, 20]. Defaults to 20.

Response

Status: 200 Ok

{
    "assignees": [
        {
            "assigneetype": "team",
            "assigneeid": 1,
            "name": "Team One",
            "average_skill_rating": 0.63,
            "constituents": {
                "training": {
                    "value": 0.5
                },
                "supervisor": {
                    "value": 0.13
                }
            }
        },
        {
            "assigneetype": "user",
            "assigneeid": 1,
            "name": "User One",
            "average_skill_rating": 0.63,
            "constituents": {
                "training": {
                    "value": 0.5
                },
                "supervisor": {
                    "value": 0.13
                }
            }
        }
    ],
    "hasMore": false
}

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Skills

GET /skills/teams/:teamid/courses

Query Parameters

Response

GET /skills/weights

Response

PUT /skills/weights

Request Body

Response

POST /skills/matrix

Request Body

Response

GET /skills/ratings/{doctype}/{docid}/{userid}

Route Parameters

Query Parameters

Response

POST /skills/ratings/supervisor

Request Body

Response

POST /skills/ratings/supervisor/:doctype/:docid/:userid

Route Parameters

Request Body

Response

GET /skills/courses/:wikiid/assignees

Query Parameters

Response

GET /skills/guides/:guideid/assignees

Query Parameters

Response