AVAILABLE WITH ENTERPRISE SUBSCRIPTION

POST /performance-management/appraisal/session/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

Session ID
If sessionID is not provided, a list of all sessions will be returned.

Existing customers may continue using ispringlearn.com, and new customers should use ispring.com.

Response Parameters

ParameterDescription

sessionId

Session ID

name

Session name

description

Session description

managerId

Assessment manager ID

profileId

Competency profile ID

status

The status of the session:

  • NOT_STARTED — The session hasn't started.
  • IN_PROGRESS — The session is in progress.
  • COMPLETED — The session has finished.

startDate

The date and time when the session begins.

endDate

The date and time when the session ends.

Response Codes

Code

Text

Description

200OKThe 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​/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
 
{
  "sessionIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}  
CODE

Sample Response

[
  {
    "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "managerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "NOT_STARTED",
    "startDate": "string",
    "endDate": "string"
  }
CODE