iSpring Learn performance-management API
The performance-management API from iSpring Learn — 37 operation(s) for performance-management.
The performance-management API from iSpring Learn — 37 operation(s) for performance-management.
openapi: 3.0.0
info:
title: Learn Rest Api assignments performance-management API
version: '3.0'
description: Assignment operations
servers:
- url: https://api-learn.ispring.com
description: Main server
security:
- bearerAuth: []
tags:
- name: performance-management
paths:
/performance-management/competencies/scale/list:
get:
tags:
- performance-management
summary: List competency scales
operationId: ListCompetencyScales
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CompetencyScale'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CompetencyScale'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/scale/create:
post:
tags:
- performance-management
summary: Create competency scale
operationId: CreateCompetencyScale
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCompetencyScaleData'
responses:
'200':
description: Success Response
content:
application/json:
schema:
description: The scale ID
type: string
format: uuid
application/xml:
schema:
description: The scale ID
type: string
format: uuid
xml:
name: response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/scale/{scaleId}/change:
post:
tags:
- performance-management
summary: Change competency scale
operationId: ChangeCompetencyScale
parameters:
- name: scaleId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeCompetencyScaleRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Scale not found
/performance-management/competencies/group/create:
post:
tags:
- performance-management
summary: Create competency group
operationId: CreateCompetencyGroup
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCompetencyGroupData'
responses:
'200':
description: Success Response
content:
application/json:
schema:
description: The group ID
type: string
format: uuid
application/xml:
schema:
description: The group ID
type: string
format: uuid
xml:
name: response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/group/{groupId}/rename:
post:
tags:
- performance-management
summary: Change competency group name
operationId: ChangeCompetencyGroupName
parameters:
- name: groupId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
required:
- name
properties:
name:
type: string
type: object
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Group not found
/performance-management/competencies/group/batch-move:
post:
tags:
- performance-management
summary: Move competency groups to parent group
operationId: MoveCompetencyGroups
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MoveCompetencyGroupsToParentGroup'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Group not found
/performance-management/competencies/competency/batch-move:
post:
tags:
- performance-management
summary: Move competencies to group
operationId: MoveCompetenciesToGroup
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MoveCompetenciesToGroup'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Group not found
/performance-management/competencies/group/list:
get:
tags:
- performance-management
summary: List competency groups
operationId: ListCompetencyGroups
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CompetencyGroup'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CompetencyGroup'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/competency/list:
post:
tags:
- performance-management
summary: List competencies
operationId: ListCompetencies
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListCompetenciesRequest'
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Competency'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Competency'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/competency/create:
post:
tags:
- performance-management
summary: Create competency
operationId: CreateCompetency
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCompetencyData'
responses:
'200':
description: Success Response
content:
application/json:
schema:
description: The competency ID
type: string
format: uuid
application/xml:
schema:
description: The competency ID
type: string
format: uuid
xml:
name: response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/competency/{competencyId}/change:
post:
tags:
- performance-management
summary: Change competency
operationId: ChangeCompetency
parameters:
- name: competencyId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeCompetencyData'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Competency not found
/performance-management/competencies/competency/{competencyId}/indicator/create:
post:
tags:
- performance-management
summary: Create competency indicator
operationId: CreateCompetencyIndicator
parameters:
- name: competencyId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CompetencyIndicatorData'
responses:
'200':
description: Success Response
content:
application/json:
schema:
description: The competency indicator ID
type: string
format: uuid
application/xml:
schema:
description: The competency indicator ID
type: string
format: uuid
xml:
name: response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/competencies/competency/{competencyId}/indicator/{indicatorId}/change:
post:
tags:
- performance-management
summary: Change competency indicator
operationId: ChangeCompetencyIndicator
parameters:
- name: competencyId
in: path
required: true
schema:
type: string
format: uuid
- name: indicatorId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CompetencyIndicatorData'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Indicator not found
/performance-management/competencies/profile/list:
post:
tags:
- performance-management
summary: List competency profiles
operationId: ListCompetencyProfiles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListCompetencyProfilesRequest'
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CompetencyProfile'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CompetencyProfile'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/appraisal/session/list:
post:
tags:
- performance-management
summary: List appraisal sessions
operationId: ListAppraisalSessions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAppraisalSessionsRequest'
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSession'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSession'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/employee-card/list:
get:
tags:
- performance-management
summary: List appraisal session employee cards
operationId: ListAppraisalSessionEmployeeCards
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionEmployeeCard'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionEmployeeCard'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/review/list:
get:
tags:
- performance-management
summary: List appraisal session reviews
operationId: ListAppraisalSessionReviews
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionReview'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionReview'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/results:
get:
tags:
- performance-management
summary: Get appraisal session results
operationId: GetAppraisalSessionResults
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionEmployeeResults'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionEmployeeResults'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
/performance-management/appraisal/session/{sessionId}/content/competencies:
get:
tags:
- performance-management
summary: Get appraisal session content competencies
operationId: GetAppraisalSessionContentCompetencies
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
content:
application/json:
schema:
$ref: '#/components/schemas/AppraisalSessionContentCompetencies'
application/xml:
schema:
properties:
? ''
: $ref: '#/components/schemas/AppraisalSessionContentCompetencies'
type: object
xml:
name: response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/user/attributes/list:
post:
tags:
- performance-management
summary: List appraisal session user attributes
operationId: ListAppraisalSessionUserAttributes
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListAppraisalSessionUserAttributesRequest'
responses:
'200':
description: Success Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionUserAttributes'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AppraisalSessionUserAttributes'
xml:
name: response
wrapped: true
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/start:
post:
tags:
- performance-management
summary: Start appraisal session
operationId: StartAppraisalSession
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
content:
application/json:
schema:
$ref: '#/components/schemas/StartAppraisalSessionStatusCode'
application/xml:
schema:
$ref: '#/components/schemas/StartAppraisalSessionStatusCode'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/restart:
post:
tags:
- performance-management
summary: Restart appraisal session
operationId: RestartAppraisalSession
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
content:
application/json:
schema:
$ref: '#/components/schemas/RestartAppraisalSessionStatusCode'
application/xml:
schema:
$ref: '#/components/schemas/RestartAppraisalSessionStatusCode'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/complete:
post:
tags:
- performance-management
summary: Complete appraisal session
operationId: CompleteAppraisalSession
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
description: Session not found
/performance-management/appraisal/session/{sessionId}/update:
post:
tags:
- performance-management
summary: Updating the appraisal session
operationId: UpdateAppraisalSession
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAppraisalSessionRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/create:
post:
tags:
- performance-management
summary: Creating the appraisal session
operationId: CreateAppraisalSession
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAppraisalSessionRequest'
responses:
'200':
description: Success Response
content:
application/json:
schema:
description: Created session id
type: string
format: uuid
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/employee-card/add:
post:
tags:
- performance-management
summary: Add employee cards to the appraisal session
operationId: AddAppraisalSessionEmployeeCards
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddAppraisalSessionEmployeeCardsRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/employee-card/reviewer/replace:
post:
tags:
- performance-management
summary: Replaces employee card reviewers in an appraisal session
operationId: ReplaceAppraisalSessionEmployeeReviewers
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReplaceAppraisalSessionEmployeeReviewersRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/employee-card/remove:
post:
tags:
- performance-management
summary: Remove employee cards from the appraisal session
operationId: RemoveAppraisalSessionEmployeeCards
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveAppraisalSessionEmployeeCardsRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/employee-card/reviewer/remove:
post:
tags:
- performance-management
summary: Remove reviewers from the appraisal session
operationId: RemoveAppraisalSessionReviewers
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveAppraisalSessionReviewersRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/question/add:
post:
tags:
- performance-management
summary: Adding the appraisal session question
operationId: AddAppraisalQuestion
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddAppraisalQuestionRequest'
responses:
'200':
description: Success Response
content:
application/json:
schema:
description: Added question id
type: string
format: uuid
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/question/{questionId}/update:
post:
tags:
- performance-management
summary: Updating the appraisal session question
operationId: UpdateAppraisalQuestion
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
- name: questionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAppraisalQuestionRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/question/change-order:
post:
tags:
- performance-management
summary: Changing the appraisal session question orders
operationId: ChangeAppraisalQuestionOrders
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeAppraisalQuestionOrdersRequest'
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/question/{questionId}/remove:
post:
tags:
- performance-management
summary: Removing the appraisal session question
operationId: RemoveAppraisalQuestion
parameters:
- name: sessionId
in: path
required: true
schema:
type: string
format: uuid
- name: questionId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success Response
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
/performance-management/appraisal/session/{sessionId}/permissions/add:
post:
tags:
- performance-management
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ispring/refs/heads/main/openapi/ispring-performance-management-api-openapi.yml