AVAILABLE WITH BUSINESS SUBSCRIPTION

Request: POST/performance-management/competencies/competency/list

Permissions to Run the Request

Account Owner and Account Administrators

Request Headers

Header

Description

Authorization (required)Access token. You can obtain a token by making a request.
Content-Type: application/json
(required)
Property for processing a request in JSON.
Accept: application/json
(required)
Property for processing a request in JSON.

Response Parameters

ParameterDescription
competencyIdThe ID of competency
nameName of the competency
descriptionDescription of competency
scaleIdThe ID of the scale used to assess competence
reviewMethod

How the competencies are evaluated:

  • COMPETENCY_ENTIRELY — Evaluate by levels of competency.
  • INDICATORS_INDIVIDUALLY — Evaluate competency based on indicators.
indicatorsAn array with indicators data
indicatorIdThe ID of indicator
nameThe name of indicator
levelsAn array of levels (from 2 to 100 elements)
levelIdThe ID of level
descriptionDescription of the level
commentsRequirementLevel Ability to leave a comment on the rating.

DISABLED — the reviewer can’t comment on the competence.

OPTIONAL — the reviewers can’t comment on the selected competence if they wish.

REQUIRED — the reviewer must leave a comment on the selected level.

emptyAnswersEnabled

The "Don`t know" option is not taken into account when calculating the results.

  • true — the "Don`t know" option  is added to the rating scale.
  • false — the answer "Don`t know" is not added

Response Codes

Code

Text

Description

200OKThe request has been successfully processed. 
401UnauthorizedAn authorization error
403Permission deniedThe user doesn't have enough permissions to get information regarding the course

Sample Request

GET ​/performance-management/competencies​/competency​/list
Host: api-learn.ispringlearn.com
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://myaccount.ispringlearn.com
Authorization: Bearer N3Hk5sds1_DVj1JFTqJKFWjGHf94DWp1YSffLxeZX8co

{
  "competencyIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
CODE

Sample Response

[
  {
    "competencyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "scaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reviewMethod": "INDICATORS_INDIVIDUALLY",
    "indicators": [
      {
        "indicatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "levels": [
          {
            "levelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string"
          }
        ]
      }
    ],
    "commentsRequirementLevel": "DISABLED",
    "emptyAnswersEnabled": true
  }
]
CODE