Skills management

Opigno Enterprise provides a Skills feature for tracking learners’ knowledge levels, identifying skill gaps, and recommending personalized training.

Get all available skills

To get the list of all skills available for the current API user, getAllSkills should be used.

Parameter	Type	Description	Default
`after`	`Cursor`	Returns results that come after the specified cursor. Should be used together with `first` parameter. Cannot be used if `before` is set.	—
`before`	`Cursor`	Returns results that come before the specified cursor. Should be used together with `last` parameter. Cannot be used if `after` is set.	—
`first`	`Integer`	Returns up to the first N elements from the list. Required if `after` parameter is set. Cannot be used together with `last`.	—
`last`	`Integer`	Returns up to the first N elements from the list. Required if `before` parameter is set. Cannot be used together with `first`.	—
`reverse`	`Boolean`	Allows to reverse the order of the query results list (default order is by a skill taxonomy term title, ascending).	`false`
`title`	`String`	Optional filter by a skill taxonomy term title. Works with `CONTAINS` operator.	—

The query returns a paginated list of TaxonomyTerm objects of all levels. Here is an example of the query execution:

query getAllSkills {
  getAllSkills(first: 3) {
    edges {
      node {
        id
        name
        weight
      }
    }
    totalItems
  }
}

{
  "data": {
    "getAllSkills": {
      "edges": [
        {
          "node": {
            "id": "4",
            "name": "Communication",
            "weight": 2
          }
        },
        {
          "node": {
            "id": "1",
            "name": "Creativity",
            "weight": 1
          }
        },
        {
          "node": {
            "id": "3",
            "name": "Management",
            "weight": 3
          }
        }
      ],
      "totalItems": 15
    }
  }
}

Target skills

Only top-level skills can be assigned as a target skill to a user. They can be assigned either individually, or as a part of a skills profile.

`TargetSkill` API object

TargetSkill API object exposes the learner’s acquisition progress for that skill, whether it is currently locked, and the available call-to-action options.

Parameter	Type	Description
`criticality`	`TargetSkillCriticality`	Optional. The skill criticality in scope of the selected profile, or as assigned individually.
`cta`	`[Cta]`	Optional. The list of available call-to-action objects for the skill.
`hasSubSkills`	`Boolean`	Required. Indicates if the skill has sub-skills.
`id`	`ID`	Required. Skill term ID.
`locked`	`Boolean`	Required. Indicates if the acquisition of the skill is currently locked.
`lockReasons`	`[SkillLockReason]`	Optional. The reasons why the skill is locked. Empty if the skill is available or already acquired.
`name`	`String`	Required. Skill taxonomy term name.
`parent`	`TaxonomyTerm`	Optional. The parent skill term, defining the taxonomy term level.
`progress`	`Int`	Required. Skill acquisition progress, in percent. If the skill is not a leaf, all its sub-skills should be acquired as well to reach 100%.
`userSkill`	`UserSkill`	Optional. The related user skill data, if the user has already started acquiring the skill.

`SkillLockReason` API object

A target skill is locked when it has unmet prerequisites, or if there are any not acquired sub-skills.

Parameter	Type	Description
`reason`	`SkillLockReasonType`	Required. Describes the reason why the skill cannot be acquired now. There are two possible options: `NOT_ACQUIRED_PREREQUISITE` points that there is a prerequisite skill that should be completed first, or `NOT_ACQUIRED_SUB_SKILL` means that there is a sub-skill that is not acquired.
`skill`	`TargetSkill`	Required. The skill that should be completed first to unlock the current one.

`TargetSkillCriticality` API object

Defines the list of possible levels of target skill criticality.

Criticality level	Description
`ESSENTIAL`	A skill must be acquired through verified training; cannot be claimed.
`IMPORTANT`	A skill must be acquired; can be fast-tracked by a quiz; cannot be claimed.
`ACCESSORY`	A skill can be self-declared as claimed without a proof.

Get all target skills

To get the list of all skills that can be used as target ones (top-level terms only), getAllTargetSkills query should be executed.

Parameter	Type	Description	Default
`after`	`Cursor`	Returns results that come after the specified cursor. Should be used together with `first` parameter. Cannot be used if `before` is set.	—
`before`	`Cursor`	Returns results that come before the specified cursor. Should be used together with `last` parameter. Cannot be used if `after` is set.	—
`first`	`Integer`	Returns up to the first N elements from the list. Required if `after` parameter is set. Cannot be used together with `last`.	—
`last`	`Integer`	Returns up to the first N elements from the list. Required if `before` parameter is set. Cannot be used together with `first`.	—
`reverse`	`Boolean`	Allows to reverse the order of the query results list (default order is ascending).	`false`
`title`	`String`	Optional filter by a skill taxonomy term title.	—

The query returns a paginated list of TaxonomyTerm objects.

query getAllTargetSkills {
  getAllTargetSkills(first: 2) {
    edges {
      node {
        id
        name
      }
    }
    totalItems
  }
}

{
  "data": {
    "getAllTargetSkills": {
      "edges": [
        {
          "node": {
            "id": "3",
            "name": "Management"
          }
        },
        {
          "node": {
            "id": "4",
            "name": "Communication"
          }
        }
      ],
      "totalItems": 2
    }
  }
}

Get target skills of a learner

To get the target skills currently assigned to a learner, getUserContextTargetSkills query should be executed.

Parameter	Type	Description	Default
`after`	`Cursor`	Returns results that come after the specified cursor. Should be used together with `first` parameter. Cannot be used if `before` is set.	—
`assignment`	`TargetSkillAssignmentType`	Filters the results by how the skill was assigned: `PROFILE` or `INDIVIDUAL`. Leave empty to ignore this parameter.	—
`before`	`Cursor`	Returns results that come before the specified cursor. Should be used together with `last` parameter. Cannot be used if `after` is set.	—
`first`	`Integer`	Returns up to the first N elements from the list. Required if `after` parameter is set. Cannot be used together with `last`.	—
`last`	`Integer`	Returns up to the first N elements from the list. Required if `before` parameter is set. Cannot be used together with `first`.	—
`reverse`	`Boolean`	Allows to reverse the order of the query results list (default order is ascending).	`false`
`title`	`String`	Optional filter by a skill title. Works with `CONTAINS` operator.	—
`userContextUuid`	`ID`	UUID of the user context to get the target skills for. If empty, current API user context will be used.	—

The query returns a paginated list of TargetSkill objects.

query getUserContextTargetSkills {
  getUserContextTargetSkills(first: 1, userContextUuid: "a1b2c3d4-e5f6-7890-abcd-ef1234567890") {
    edges {
      node {
        id
        name
        criticality
        progress
        locked
        hasSubSkills
      }
    }
    totalItems
  }
}

{
  "data": {
    "getUserContextTargetSkills": {
      "edges": [
        {
          "node": {
            "id": "3",
            "name": "Management",
            "criticality": "ESSENTIAL",
            "progress": 60,
            "locked": false,
            "hasSubSkills": true
          }
        }
      ],
      "totalItems": 1
    }
  }
}

Get sub-skills

To get the sub-skills of a given target skill, getSubSkills query should be executed. Unlike the other target skill queries, this one is not paginated and returns a plain list of TargetSkill objects.

Parameter	Type	Description
`skillId`	`ID`	Required. ID of the target skill taxonomy term to get the sub-skills of.
`userContextUuid`	`ID`	Optional. UUID of the user context to get the sub-skills for. If empty, current API user will be used.

query getSubSkills {
  getSubSkills(skillId: 3, userContextUuid: "a1b2c3d4-e5f6-7890-abcd-ef1234567890") {
    id
    name
    criticality
    progress
    locked
  }
}

{
  "data": {
    "getSubSkills": [
      {
        "id": "5",
        "name": "Project Management",
        "criticality": "ESSENTIAL",
        "progress": 100,
        "locked": false
      },
      {
        "id": "6",
        "name": "Team Leadership",
        "criticality": "IMPORTANT",
        "progress": 0,
        "locked": true
      }
    ]
  }
}

Manage learner’s target skills

Target skills can be defined for learners by users with ADMINISTRATOR scope. Every target skill is assigned with a criticality level: ESSENTIAL, IMPORTANT, or ACCESSORY. Criticality defines possible ways of the skill acquisition.

Assign an individual target skill

To assign a target skill to a learner, assignTargetSkill mutation should be executed.

Argument	Type	Description
`criticality`	`TargetSkillCriticality`	Required. The skill criticality: `ESSENTIAL`, `IMPORTANT`, or `ACCESSORY`.
`skillId`	`ID`	Required. ID of the skill taxonomy term that should be assigned as a target one to the given user context.
`userContextUuid`	`ID`	Required. UUID of the user context to assign the target skill to.

Here is an example of the mutation execution:

mutation assignTargetSkill {
  assignTargetSkill(
    skillId: 2
    userContextUuid: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    criticality: ESSENTIAL
  ) {
    errors
    response
  }
}

{
  "data": {
    "assignTargetSkill": {
      "errors": [],
      "response": true
    }
  }
}

If the mutation executed without any errors, a boolean value will be returned as a response, indicating the success status.

Remove an individual target skill

To remove a skill from the list of target ones for the learner, removeTargetSkill mutation should be executed.

Argument	Type	Description
`skillId`	`ID`	Required. ID of the skill term that should be removed from the list of the target ones.
`userContextUuid`	`ID`	Required. UUID of the user context to remove the target skill from.

Here is an example of the mutation execution:

mutation removeTargetSkill {
  removeTargetSkill(
    skillId: 2
    userContextUuid: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ) {
    errors
    response
  }
}

{
  "data": {
    "removeTargetSkill": {
      "errors": [],
      "response": true
    }
  }
}

Skills are basically taxonomy terms, they can be managed using UI in the backoffice or with Opigno Enterprise API:

Taxonomy terms API

Check how to create, update or delete taxonomy terms using API.

Pagination

Learn how to efficiently navigate through large sets of items using cursor-based pagination.

Getting started

Integration & Concepts

Use cases

Hierarchy Management

Zapier Integration

Mobile application

Skills management

Get all available skills

Target skills

`TargetSkill` API object

`SkillLockReason` API object

`TargetSkillCriticality` API object

Get all target skills

Get target skills of a learner

Get sub-skills

Manage learner’s target skills

Assign an individual target skill

Remove an individual target skill

Taxonomy terms API

Pagination

​Get all available skills

​Target skills

​TargetSkill API object

​SkillLockReason API object

​TargetSkillCriticality API object

​Get all target skills

​Get target skills of a learner

​Get sub-skills

​Manage learner’s target skills

​Assign an individual target skill

​Remove an individual target skill

​Related Features

Taxonomy terms API

Pagination

Get all available skills

Target skills

`TargetSkill` API object

`SkillLockReason` API object

`TargetSkillCriticality` API object

Get all target skills

Get target skills of a learner

Get sub-skills

Manage learner’s target skills

Assign an individual target skill

Remove an individual target skill

Related Features