iSpring Learn performance-management API
The performance-management API from iSpring Learn — 37 operation(s) for performance-management.
iSpring Learn performance-management API is one of 20 APIs that iSpring Learn publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include performance-management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 37 operations across 37 paths, and defines 64 schemas. It is described by OpenAPI 3.0.0, at version 3.0.
Requests are made against a single base URL, https://api-learn.ispring.com.
37 operations
37 paths
64 schemas
7 GET30 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
iSpring Learn performance-management API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 37
Across 37 paths, the API surfaces 37 operations — 7 GET, 30 POST. Each is listed below with its method, path, parameters, and response codes.
performance-management 37
GET
/performance-management/competencies/scale/list
List competency scales
POST
/performance-management/competencies/scale/create
Create competency scale
POST
/performance-management/competencies/scale/{scaleId}/change
Change competency scale
POST
/performance-management/competencies/group/create
Create competency group
POST
/performance-management/competencies/group/{groupId}/rename
Change competency group name
POST
/performance-management/competencies/group/batch-move
Move competency groups to parent group
POST
/performance-management/competencies/competency/batch-move
Move competencies to group
GET
/performance-management/competencies/group/list
List competency groups
POST
/performance-management/competencies/competency/list
List competencies
POST
/performance-management/competencies/competency/create
Create competency
POST
/performance-management/competencies/competency/{competencyId}/change
Change competency
POST
/performance-management/competencies/competency/{competencyId}/indicator/create
Create competency indicator
POST
/performance-management/competencies/competency/{competencyId}/indicator/{indicatorId}/change
Change competency indicator
POST
/performance-management/competencies/profile/list
List competency profiles
POST
/performance-management/appraisal/session/list
List appraisal sessions
GET
/performance-management/appraisal/session/{sessionId}/employee-card/list
List appraisal session employee cards
GET
/performance-management/appraisal/session/{sessionId}/review/list
List appraisal session reviews
GET
/performance-management/appraisal/session/{sessionId}/results
Get appraisal session results
GET
/performance-management/appraisal/session/{sessionId}/content/competencies
Get appraisal session content competencies
POST
/performance-management/appraisal/session/{sessionId}/user/attributes/list
List appraisal session user attributes
POST
/performance-management/appraisal/session/{sessionId}/start
Start appraisal session
POST
/performance-management/appraisal/session/{sessionId}/restart
Restart appraisal session
POST
/performance-management/appraisal/session/{sessionId}/complete
Complete appraisal session
POST
/performance-management/appraisal/session/{sessionId}/update
Updating the appraisal session
POST
/performance-management/appraisal/session/create
Creating the appraisal session
POST
/performance-management/appraisal/session/{sessionId}/employee-card/add
Add employee cards to the appraisal session
POST
/performance-management/appraisal/session/{sessionId}/employee-card/reviewer/replace
Replaces employee card reviewers in an appraisal session
POST
/performance-management/appraisal/session/{sessionId}/employee-card/remove
Remove employee cards from the appraisal session
POST
/performance-management/appraisal/session/{sessionId}/employee-card/reviewer/remove
Remove reviewers from the appraisal session
POST
/performance-management/appraisal/session/{sessionId}/question/add
Adding the appraisal session question
POST
/performance-management/appraisal/session/{sessionId}/question/{questionId}/update
Updating the appraisal session question
POST
/performance-management/appraisal/session/{sessionId}/question/change-order
Changing the appraisal session question orders
POST
/performance-management/appraisal/session/{sessionId}/question/{questionId}/remove
Removing the appraisal session question
POST
/performance-management/appraisal/session/{sessionId}/permissions/add
Adding the appraisal session permissions
POST
/performance-management/appraisal/session/{sessionId}/permissions/remove
Removing the appraisal session permissions
GET
/performance-management/appraisal/session/{sessionId}/info
Getting the appraisal session full info
POST
/performance-management/appraisal/session/{sessionId}/notification/change
Changing the appraisal session notification settings
Schemas 64
The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are AppraisalSessionInfo (14 properties), AppraisalSessionContentCompetency (8 properties), Competency (8 properties), AppraisalSession (8 properties). Each schema is shown below with its type and property counts.
AppraisalSessionUserAttribute
object
3 properties
3 required
AppraisalSessionContentCompetencyReviewMethod
string
AppraisalSessionContentScaleLevelData
object
2 properties
2 required
AppraisalSessionNotificationSettings
object
2 properties
2 required
ReplaceAppraisalSessionEmployeeReviewersRequest
object
1 property
1 required
AddAppraisalQuestionRequest
object
3 properties
3 required
ErrorResponse
object
2 properties
2 required
AppraisalSessionReviewerRole
string
AppraisalSessionContentCommentsRequirementLevel
string
UpdateAppraisalSessionRequest
object
6 properties
CreateCompetencyData
object
7 properties
7 required
StartAppraisalSessionStatusCode
string
AppraisalSessionEmployeeDetailedCard
object
2 properties
2 required
RemoveAppraisalSessionEmployeeCardsRequest
object
1 property
1 required
ChangeAppraisalSessionNotificationSettingsRequest
object
2 properties
2 required
CompetencyIndicatorData
object
2 properties
2 required
Competency
object
8 properties
7 required
AppraisalSessionStatus
string
CompetencyGroup
object
The root group has an empty parentId
4 properties
4 required
AppraisalSession
object
8 properties
7 required
ListAppraisalSessionUserAttributesRequest
object
1 property
1 required
ProfileCompetencyData
object
2 properties
2 required
MoveCompetenciesToGroup
object
2 properties
2 required
ListAppraisalSessionsRequest
object
1 property
ListCompetencyProfilesRequest
object
1 property
ChangeCompetencyData
object
6 properties
5 required
CompetencyIndicator
object
3 properties
3 required
AppraisalSessionContentCompetency
object
8 properties
7 required
AddAppraisalSessionPermissionsRequest
object
1 property
1 required
AppraisalSessionEmployeeCompetencyResults
object
2 properties
1 required
ProfileIndicatorData
object
2 properties
2 required
ChangeAppraisalQuestionOrdersRequest
object
1 property
1 required
CreateCompetencyGroupData
object
2 properties
2 required
AppraisalSessionUserStatus
string
AppraisalSessionReview
object
6 properties
6 required
AppraisalSessionReviewStatus
string
CreateCompetencyScaleLevelData
object
2 properties
2 required
AppraisalSessionUserAttributes
object
8 properties
8 required
AppraisalSessionContentIndicatorData
object
3 properties
2 required
RestartAppraisalSessionStatusCode
string
ListCompetenciesRequest
object
1 property
RemoveAppraisalSessionPermissionsRequest
object
1 property
1 required
AppraisalSessionReviewer
object
2 properties
2 required
AppraisalSessionContentScale
object
2 properties
2 required
CreateAppraisalSessionRequest
object
3 properties
2 required
AppraisalSessionEmployeeResults
object
4 properties
4 required
CreateCompetencyScaleData
object
2 properties
2 required
AppraisalSessionContentCompetencies
object
2 properties
2 required
ChangeCompetencyScaleRequest
object
2 properties
2 required
CompetencyScale
object
3 properties
3 required
AppraisalQuestion
object
4 properties
4 required
CompetencyScaleLevel
object
3 properties
3 required
AddAppraisalSessionEmployeeCardsRequest
object
1 property
1 required
CompetencyReviewMethod
string
AppraisalSessionEmployeeCard
object
2 properties
2 required
AppraisalSessionEmployeeIndicatorResults
object
2 properties
1 required
CompetencyCommentsRequirementLevel
string
CompetencyIndicatorLevel
object
2 properties
1 required
AppraisalSessionInfo
object
14 properties
13 required
UpdateAppraisalQuestionRequest
object
3 properties
AppraisalSessionContentRequiredLevelData
object
2 properties
2 required
MoveCompetencyGroupsToParentGroup
object
2 properties
2 required
CompetencyProfile
object
5 properties
5 required
RemoveAppraisalSessionReviewersRequest
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from iSpring Learn 12
Other APIs iSpring Learn publishes across the network.
iSpring Learn assignments API
iSpring Learn certificate API
iSpring Learn content API
iSpring Learn department API
iSpring Learn departments API
iSpring Learn enrollment API
iSpring Learn gamification API
iSpring Learn group API
iSpring Learn jobtraining API
iSpring Learn learning_track API
iSpring Learn quizzes API
iSpring Learn report API
#performance-management