AVAILABLE WITH ENTERPRISE SUBSCRIPTION

POST /performance-management/appraisal/session/{sessionId}/question/add

Permissions to Run the Request

Account Owner and Account Administrators

Request Headers

HeaderDescription
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
sessionId (required) The session ID
text (required) The text content of the new question. The question may contain up to 2000 characters.
isRequired (required) 

Indicates whether answering the question is required
Possible values:

  • false — optional
  • true — required
targetRoles (required) 

Reviewer roles eligible to see this question:

  • REVIEWER_ROLE_SELF_REVIEW — self-assessment
  • REVIEWER_ROLE_DIRECT_MANAGER — manager
  • REVIEWER_ROLE_PEER — colleagues
  • REVIEWER_ROLE_DIRECT_REPORT — subordinates
  • REVIEWER_ROLE_CUSTOMER — customers
  • REVIEWER_ROLE_EXPERT — experts

Allowed role combinations:

  • All roles
  • All roles except self-assessment (REVIEWER_ROLE_SELF_REVIEW)
  • Each role individually
Existing customers may continue using ispringlearn.com, and new customers should use ispring.com.

Response Codes

CodeTextDescription
200OКThe question has been added
400Bad requestA request error
401UnauthorizedAn authorization error

Sample Request

POST /performance-management/appraisal/session/8e7a5d39-1ae3-11f0-ae26-765c58ce190a/question/add
Host: api-learn.ispringlearn.com 
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://myaccount.ispringlearn.com
Authorization: Bearer y5ymQne6iBZucoM24sNxRKtmciVKG7-XUhQ5sLhXn5I

{
  "text": "New question",
  "isRequired": "true",
  "targetRoles": [
    "REVIEWER_ROLE_SELF_REVIEW",
    "REVIEWER_ROLE_DIRECT_MANAGER",
    "REVIEWER_ROLE_PEER",
    "REVIEWER_ROLE_DIRECT_REPORT",
    "REVIEWER_ROLE_CUSTOMER",
    "REVIEWER_ROLE_EXPERT"
  ]
}
XML

Sample Response

HTTP/1.1 200 OK
"c5ea65eb-1ae4-11f0-ae26-765c58ce190a"  
XML