AVAILABLE WITH BUSINESS SUBSCRIPTION

POST /performance-management/appraisal/session/{sessionId}/user/attributes/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.
Parameter

sessionIds
(required)

Session ID

userIds

(required)

The ID of the user whose data we want to obtain.
To get a user ID, use Getting a List of Employees and Reviewers in Session

Response Parameters

ParameterDescription
sessionIdSession ID
userIdUser ID
displayingName

User's first and last name. If these are not provided, their login will be displayed instead.

initialsFirst letters of the first and last name or login. 
departmentIdThe ID of department this user is part of.
departmentNameThe name of department this user is part of
status

User status in the system:

  • ACTIVE — active,
  • DEACTIVATEDdeactivated,
  • DELETED — deleted,
  • TERMINATED — employment ended. 
attributesUser profile fields. 
keyField ID
valueField value
titleField label in the interface

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

POST /performance-management/appraisal/session/{sessionId}/user/attributes/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
 
{
  "userIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
CODE

Sample Response

[
  {
    "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayingName": "string",
    "initials": "string",
    "departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "departmentName": "string",
    "status": "ACTIVE",
    "attributes": [
      {
        "key": "string",
        "value": "string",
        "title": "string"
      }
    ]
  }
]
CODE