AVAILABLE WITH BUSINESS SUBSCRIPTION

GET /performance-management/appraisal/session/{sessionId}/content/competencies

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.
ParameterDescription

sessionIds
(required)

Session ID

Response Parameters

ParameterDescription

competencies

An array with competencies data
competencyIdCompetency ID
nameCompetency name
scaleIdThe ID of the scale used to evaluate competency
requiredLevel

The minimum required level for the competency

name

The name of the required level for the competency

score

Score for the competency

reviewMethod

How the competency is evaluated:

  • COMPETENCY_ENTIRELY — Evaluate by levels of competency,
  • INDICATORS_INDIVIDUALLY — Evaluate competency based on indicators.
indicatorsAn array with indicators data
indicatorIdIndicator ID
nameIndicator name
requiredLevelThe minimum required level for the indicator
nameThe name of the required level for the competency
score
Score for the indicator
commentsRequirementLevelOption to leave comments:

DISABLED the reviewer can’t comment on their selected choice.
OPTIONAL the reviewer can comment on their selected choice if they want. 
REQUIRED  the reviewer must leave a comment on the selected choice.
emptyAnswersEnabled
  • true — "Don`t know" option is added to the rating scale.
  • false — "Don`t know" option is not added to the rating scale. 
scalesAn array with rating scales data
scaleIdRating scale ID
levelsAn array of levels (2-100 elements allowed)
levelIdLevel ID
scoreScore per level (from -10000 to 10000)

Response Codes

Code

Text

Description

200OK

The request has been successfully processed.

400Bad RequestA request error.
401UnauthorizedAn authorization error
403Permission deniedNo permission to run this request. 
Only the Account Owner and Account Administrators can run this request.
404Session not foundThe session was not found.

Sample Request

GET /performance-management/appraisal/session/{sessionId}/content/competencies
Host: api-learn.ispringlearn.com
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://myaccount.ispringlearn.com
Authorization: Bearer N3Hk5sds1_DVj1JFTqJKFWjGHf94DWp1YSffLxeZX8co
CODE

Sample Response

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