openapi: 3.0.0 info: description: The Small Improvements REST API (v2) provides programmatic access to the core performance management platform, covering users, feedback cycles, review questionnaires, objectives, 1:1 meetings, pulse surveys, praise, messages, and administrative settings. Authentication uses personal Bearer access tokens generated from user profile settings. version: '2.0' title: Small Improvements API contact: url: https://www.small-improvements.com name: Small Improvements x-api-id: small-improvements-rest-api tags: - name: action-item-resource description: Action Item Resource - name: activity-stream-resource description: Activity Stream Resource - name: admin-overview-link-resource description: Admin Overview Link Resource - name: anytime-feedback-default-resource description: Anytime Feedback Default Resource - name: anytime-feedback-export-resource description: Anytime Feedback Export Resource - name: anytime-feedback-resource description: Anytime Feedback Resource - name: assessment-admin-resource description: Assessment Admin Resource - name: assessment-resource description: Assessment Resource - name: audit-record-resource description: Audit Record Resource - name: automations-options-resource description: Automations Options Resource - name: automations-resource description: Automations Resource - name: automations-settings-resource description: Automations Settings Resource - name: badges-resource description: Badges Resource - name: bounced-email-resource description: Bounced Email Resource - name: calendar-integration-admin-resource description: Calendar Integration Admin Resource - name: calendar-resource description: Calendar Resource - name: companies-design-settings-resource description: Companies Design Settings Resource - name: companies-email-templates-resource description: Companies Email Templates Resource - name: companies-resource description: Companies Resource - name: company-analytics-resource description: Company Analytics Resource - name: company-date-time-settings-resource description: Company Date Time Settings Resource - name: company-visibility-settings-resource description: Company Visibility Settings Resource - name: cycle-resource description: Cycle Resource - name: downloadable-file-resource description: Downloadable File Resource - name: drafts-resource description: Drafts Resource - name: email-configuration-resource description: Email Configuration Resource - name: email-event-resource description: Email Event Resource - name: email-template-mini-resource description: Email Template Mini Resource - name: email-templates-resource description: Email Templates Resource - name: email-verifications-resource description: Email Verifications Resource - name: events-resource description: Events Resource - name: feature-selection-resource description: Feature Selection Resource - name: features-resource description: Features Resource - name: feedback-cycle-admin-resource description: Feedback Cycle Admin Resource - name: feedback-cycles-resource description: Feedback Cycles Resource - name: feedback-export-resource description: Feedback Export Resource - name: feedback-participants-resource description: Feedback Participants Resource - name: feedback-provide-resource description: Feedback Provide Resource - name: feedback-requests-resource description: Feedback Requests Resource - name: feedback-reviewers-resource description: Feedback Reviewers Resource - name: feedback-statistics-resource description: Feedback Statistics Resource - name: feedback-template-resource description: Feedback Template Resource - name: helpful-resources-attachments-resource description: Helpful Resources Attachments Resource - name: insights-resource description: Insights Resource - name: logout-resource description: Logout Resource - name: meeting-actions-resource description: Meeting Actions Resource - name: meeting-attachment-resource description: Meeting Attachment Resource - name: meeting-calendar-company-observer-resource description: Meeting Calendar Company Observer Resource - name: meeting-calendar-configuration-resource description: Meeting Calendar Configuration Resource - name: meeting-calendar-settings-resource description: Meeting Calendar Settings Resource - name: meeting-note-resource description: Meeting Note Resource - name: meeting-resource description: Meeting Resource - name: meeting-space-resource description: Meeting Space Resource - name: meeting-template-resource description: Meeting Template Resource - name: message-settings-resource description: Message Settings Resource - name: messages-peer-feedback-resource description: Messages Peer Feedback Resource - name: messages-resource description: Messages Resource - name: notification-log-resource description: Notification Log Resource - name: nudge-resource description: Nudge Resource - name: objective-categories-resource description: Objective Categories Resource - name: objective-clone-resource description: Objective Clone Resource - name: objective-cycle-admin-resource description: Objective Cycle Admin Resource - name: objective-cycles-export-resource description: Objective Cycles Export Resource - name: objective-cycles-resource description: Objective Cycles Resource - name: objective-pdf-resource description: Objective Pdf Resource - name: objective-ratings-resource description: Objective Ratings Resource - name: objective-summaries-resource description: Objective Summaries Resource - name: objectives-resource description: Objectives Resource - name: outlook-o-auth-resource description: Outlook O Auth Resource - name: personal-access-token-resource description: Personal Access Token Resource - name: praise-resource description: Praise Resource - name: praise-wall-open-resource description: Praise Wall Open Resource - name: praise-wall-resource description: Praise Wall Resource - name: profile-pictures-resource description: Profile Pictures Resource - name: public-calendar-resource description: Public Calendar Resource - name: public-images-resource description: Public Images Resource - name: public-me-resource description: Public Me Resource - name: reaction-resource description: Reaction Resource - name: release-notes-resource description: Release Notes Resource - name: replacements-resource description: Replacements Resource - name: report-resource description: Report Resource - name: request-feedback-resource description: Request Feedback Resource - name: review-attachment-resource description: Review Attachment Resource - name: review-cycle-admin-resource description: Review Cycle Admin Resource - name: review-cycle-import-resource description: Review Cycle Import Resource - name: review-cycle-resource description: Review Cycle Resource - name: review-cycles-resource description: Review Cycles Resource - name: review-export-resource description: Review Export Resource - name: review-graph-resource description: Review Graph Resource - name: review-questionnaire-resource description: Review Questionnaire Resource - name: review-resource description: Review Resource - name: review-statistics-resource description: Review Statistics Resource - name: reviewees-resource description: Reviewees Resource - name: reviews-resource description: Reviews Resource - name: sample-content-resource description: Sample Content Resource - name: slack-configuration-resource description: Slack Configuration Resource - name: subdomain-resource description: Subdomain Resource - name: summary-assistant-resource description: Summary Assistant Resource - name: survey-admin-resource description: Survey Admin Resource - name: survey-analytics-resource description: Survey Analytics Resource - name: survey-observer-resource description: Survey Observer Resource - name: survey-templates-resource description: Survey Templates Resource - name: survey-viewer-resource description: Survey Viewer Resource - name: talking-point-resource description: Talking Point Resource - name: unified-feedback-resource description: Unified Feedback Resource - name: user-attachment-resource description: User Attachment Resource - name: user-import-configuration-resource description: User Import Configuration Resource - name: user-import-resource description: User Import Resource - name: user-merge-resource description: User Merge Resource - name: user-settings-resource description: User Settings Resource - name: user-stats-resource description: User Stats Resource - name: users-change-resource description: Users Change Resource - name: users-resource description: Users Resource - name: writing-assistant-resource description: Writing Assistant Resource - name: your-surveys-resource description: Your Surveys Resource paths: /calendars/{id}.ics: get: tags: - public-calendar-resource summary: get operationId: getUsingGET_13 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: text/calendar;charset=UTF-8: schema: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found head: tags: - public-calendar-resource summary: get operationId: getUsingHEAD parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: text/calendar;charset=UTF-8: schema: type: string '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /imageservice: get: tags: - public-images-resource summary: get operationId: getUsingGET_14 parameters: - name: crop in: query description: crop required: false schema: type: boolean default: true - name: format in: query description: format required: false schema: type: string enum: - ORIGINAL - PNG default: ORIGINAL - name: id in: query description: id required: true schema: type: string - name: size in: query description: size required: false schema: type: integer format: int32 default: 200 responses: '200': description: OK content: '*/*': schema: type: object '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found head: tags: - public-images-resource summary: get operationId: getUsingHEAD_1 parameters: - name: crop in: query description: crop required: false schema: type: boolean default: true - name: format in: query description: format required: false schema: type: string enum: - ORIGINAL - PNG default: ORIGINAL - name: id in: query description: id required: true schema: type: string - name: size in: query description: size required: false schema: type: integer format: int32 default: 200 responses: '200': description: OK content: '*/*': schema: type: object '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /me: get: tags: - public-me-resource summary: get operationId: getUsingGET_15 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeResponse' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /praise/wall: get: tags: - praise-wall-open-resource summary: getPraiseForWall operationId: getPraiseForWallUsingGET parameters: - name: token in: query description: token required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_PraiseDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /praise/wall/config: get: tags: - praise-wall-open-resource summary: getConfig operationId: getConfigUsingGET parameters: - name: token in: query description: token required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallConfigDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /subdomain: get: tags: - subdomain-resource summary: get operationId: getUsingGET_20 parameters: - name: subDomain in: query description: subDomain required: false schema: type: string responses: '200': description: OK content: text/plain: schema: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/action-items: get: tags: - action-item-resource summary: getActionsItems operationId: getActionsItemsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_ActionItemDTO_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/activities: get: tags: - activity-stream-resource summary: getActivityStream operationId: getActivityStreamUsingGET parameters: - name: modules in: query description: modules required: false explode: true schema: type: array items: type: string enum: - FEEDBACK - MESSAGE - OBJECTIVE - PRAISE - REVIEW - USER enum: - FEEDBACK - MESSAGE - OBJECTIVE - PRAISE - REVIEW - USER - name: size in: query description: size required: false schema: type: integer format: int32 default: 100 - name: userIds in: query description: userIds required: false explode: true schema: type: array items: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin-calendar-integration: get: tags: - calendar-integration-admin-resource summary: getConfiguration operationId: getConfigurationUsingGET parameters: - name: companyId in: query description: companyId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarConfigurationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin-calendar-integration/remove-provider: post: tags: - calendar-integration-admin-resource summary: removeProvider operationId: removeProviderUsingPOST responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin-calendar-integration/verify-google: put: tags: - calendar-integration-admin-resource summary: verifyGoogleConnection operationId: verifyGoogleConnectionUsingPUT responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: boolean '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin-links/integrations: get: tags: - admin-overview-link-resource summary: getIntegrations operationId: getIntegrationsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_AdminLink_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin-links/settings: get: tags: - admin-overview-link-resource summary: get operationId: getUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_AdminLink_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin/feature-selection/settings: get: tags: - feature-selection-resource summary: getSettings operationId: getSettingsUsingGET_2 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_SettingDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - feature-selection-resource summary: saveSettings operationId: saveSettingsUsingPOST requestBody: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SettingDto' description: settingDtos required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_SettingDto_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/admin/links: get: tags: - admin-overview-link-resource summary: getForOldFrontend operationId: getForOldFrontendUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_AdminLink_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/all-companies: get: tags: - companies-resource summary: listAll operationId: listAllUsingGET parameters: - name: jumpTo in: query description: jumpTo required: false schema: type: boolean default: false - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: prefixQuery in: query required: false schema: type: boolean - name: query in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - creation - expiry - name - size responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: type: object '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/analytics/events: get: tags: - events-resource summary: list operationId: listUsingGET parameters: - name: from in: query description: from required: true schema: type: string format: date-time - name: to in: query description: to required: true schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Iterable_Event_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback: post: tags: - anytime-feedback-resource summary: request operationId: requestUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackRequestDto' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-default: get: tags: - anytime-feedback-default-resource summary: getAnytimeFeedbackDefault operationId: getAnytimeFeedbackDefaultUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackDefaultDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - anytime-feedback-default-resource summary: updateAnytimeFeedbackDefault operationId: updateAnytimeFeedbackDefaultUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/AnytimeFeedbackDefaultDto' description: anytimeFeedbackDefaultDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackDefaultDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-export: post: tags: - anytime-feedback-export-resource summary: triggerExport operationId: triggerExportUsingPOST parameters: - name: format in: query description: format required: true schema: type: string enum: - CSV - EXCEL - name: from in: query description: from required: true schema: type: string - name: until in: query description: until required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-export/team: post: tags: - anytime-feedback-export-resource summary: triggerExportForTeam operationId: triggerExportForTeamUsingPOST parameters: - name: format in: query description: format required: true schema: type: string enum: - CSV - EXCEL - name: from in: query description: from required: true schema: type: string - name: until in: query description: until required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-overview/company: get: tags: - anytime-feedback-resource summary: getCompanyOverview operationId: getCompanyOverviewUsingGET parameters: - name: from in: query description: from required: true schema: type: string format: date-time - name: to in: query description: to required: true schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UnifiedFeedbackDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-overview/team: get: tags: - anytime-feedback-resource summary: getTeamOverview operationId: getTeamOverviewUsingGET parameters: - name: from in: query description: from required: true schema: type: string format: date-time - name: to in: query description: to required: true schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UnifiedFeedbackDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-response/{requestId}/{reviewerId}: get: tags: - anytime-feedback-resource summary: getResponse operationId: getResponseUsingGET parameters: - name: requestId in: path description: requestId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackResponseDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-response/{requestId}/{reviewerId}/answer: post: tags: - anytime-feedback-resource summary: answer operationId: answerUsingPOST parameters: - name: requestId in: path description: requestId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/AnswerDtoArray2' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-response/{requestId}/{reviewerId}/decline: post: tags: - anytime-feedback-resource summary: declineResponse operationId: declineResponseUsingPOST parameters: - name: requestId in: path description: requestId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-response/{requestId}/{reviewerId}/reopen: post: tags: - anytime-feedback-resource summary: reopenResponse operationId: reopenResponseUsingPOST parameters: - name: requestId in: path description: requestId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-response/{requestId}/{reviewerId}/share: post: tags: - anytime-feedback-resource summary: shareResponse operationId: shareResponseUsingPOST parameters: - name: requestId in: path description: requestId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback-stats: get: tags: - anytime-feedback-resource summary: getAnytimeFeedbackStats operationId: getAnytimeFeedbackStatsUsingGET parameters: - name: from in: query description: from required: true schema: type: string format: date-time - name: to in: query description: to required: true schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackStatsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/anytime-feedback/{id}: get: tags: - anytime-feedback-resource summary: showRequest operationId: showRequestUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackRequestDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - anytime-feedback-resource summary: updateRequest operationId: updateRequestUsingPUT parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AnytimeFeedbackRequestDto' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AnytimeFeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - anytime-feedback-resource summary: deleteRequest operationId: deleteRequestUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/anytime-feedback/{id}/nudge/{reviewerId}: put: tags: - anytime-feedback-resource summary: nudgeReviewer operationId: nudgeReviewerUsingPUT parameters: - name: id in: path description: id required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UnifiedFeedbackDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment: get: tags: - assessment-resource summary: loadAssessments operationId: loadAssessmentsUsingGET parameters: - name: reviewId in: query description: reviewId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AssessmentDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - assessment-admin-resource summary: createAssessment operationId: createAssessmentUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateAssessmentCommand' description: createAssessmentCommand required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Assessment' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/preview/questionnaire: post: tags: - assessment-resource summary: loadFakeAssessmentsForPreviewQuestionnaire operationId: loadFakeAssessmentsForPreviewQuestionnaireUsingPOST requestBody: $ref: '#/components/requestBodies/ReviewCycleCreateRequest' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/preview/questionnaire/{cycleId}: get: tags: - assessment-resource summary: loadFakeAssessmentsForPreviewQuestionnaire operationId: loadFakeAssessmentsForPreviewQuestionnaireUsingGET parameters: - name: asReviewee in: query description: asReviewee required: false schema: type: boolean default: true - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AssessmentDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/{assessmentKey}: get: tags: - assessment-resource summary: loadAssessment operationId: loadAssessmentUsingGET parameters: - name: assessmentKey in: path description: assessmentKey required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AssessmentDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/{assessmentKey}/answers: post: tags: - assessment-resource summary: addAnswer operationId: addAnswerUsingPOST parameters: - name: assessmentKey in: path description: assessmentKey required: true schema: type: string requestBody: $ref: '#/components/requestBodies/AnswerDtoArray' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/{assessmentKey}/answers/{authorKey}: post: tags: - assessment-admin-resource summary: moderateAnswers operationId: moderateAnswersUsingPOST parameters: - name: assessmentKey in: path description: assessmentKey required: true schema: type: string requestBody: $ref: '#/components/requestBodies/AnswerDtoArray' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/{assessmentKey}/indicatedDone: post: tags: - assessment-resource summary: indicateDone operationId: indicateDoneUsingPOST parameters: - name: assessmentKey in: path description: assessmentKey required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: type: boolean description: indicated required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/{assessmentKey}/share: post: tags: - assessment-resource summary: share operationId: shareUsingPOST parameters: - name: assessmentKey in: path description: assessmentKey required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessment/{assessmentKey}/unshare: post: tags: - assessment-resource summary: unshare operationId: unshareUsingPOST parameters: - name: assessmentKey in: path description: assessmentKey required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/assessments: post: tags: - assessment-resource summary: createAssessment operationId: createAssessmentUsingPOST_1 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateOwnAssessmentCommand' description: createAssessmentCommand required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AssessmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/audit-record: post: tags: - audit-record-resource summary: getLogs operationId: getLogsUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AuditRecordQuery' description: query required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CursorResultList_AuditRecordMediumDto_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/audit-record/categories: get: tags: - audit-record-resource summary: getCategories operationId: getCategoriesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: integer format: int32 '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/audit-record/types: get: tags: - audit-record-resource summary: getTypes operationId: getTypesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: integer format: int32 '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/audit-record/{id}: get: tags: - audit-record-resource summary: getLog operationId: getLogUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AuditRecordDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/automations: get: tags: - automations-resource summary: getList operationId: getListUsingGET parameters: - name: employeeCreated in: query description: employeeCreated required: true schema: type: boolean responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AutomationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - automations-resource summary: create operationId: createUsingPOST requestBody: $ref: '#/components/requestBodies/CreateAutomationRequest' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AutomationDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/automations/options: get: tags: - automations-options-resource summary: getAutomationsOptions operationId: getAutomationsOptionsUsingGET parameters: - name: targetGroup in: query description: targetGroup required: true schema: type: string enum: - ADMIN - IC - MANAGER responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/OptionsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/automations/settings: get: tags: - automations-settings-resource summary: getAutomationsSettings operationId: getAutomationsSettingsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AutomationsSettings' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - automations-settings-resource summary: setAutomationsSettings operationId: setAutomationsSettingsUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AutomationsSettings' description: settings required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AutomationsSettings' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/automations/{id}: get: tags: - automations-resource summary: get operationId: getUsingGET_1 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AutomationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - automations-resource summary: edit operationId: editUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/CreateAutomationRequest' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AutomationDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - automations-resource summary: delete operationId: deleteUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/badges: get: tags: - badges-resource summary: getBadges operationId: getBadgesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_MiniBadge_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - badges-resource summary: createBadgePrototype operationId: createBadgePrototypeUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/BadgePrototypeDTO' description: badge required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniBadgePrototype' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/badges/icons: get: tags: - badges-resource summary: getAllIcons operationId: getAllIconsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array uniqueItems: true items: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/badges/order: post: tags: - badges-resource summary: reorderBadgePrototypes operationId: reorderBadgePrototypesUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/BadgePrototypeOrder' description: newOrder required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniBadgePrototype' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/badges/prototypes: get: tags: - badges-resource summary: getBadgePrototypes operationId: getBadgePrototypesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_MiniBadgePrototype_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/badges/{id}: put: tags: - badges-resource summary: editBadgePrototype operationId: editBadgePrototypeUsingPUT parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BadgePrototypeDTO' description: badge required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniBadgePrototype' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - badges-resource summary: deleteBadgePrototype operationId: deleteBadgePrototypeUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniBadgePrototype' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/bounced-email/company/{companyId}/aggregate: get: tags: - bounced-email-resource summary: getBouncedAggregatesByCompanyId operationId: getBouncedAggregatesByCompanyIdUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/BouncedEmailAggregate' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/bounced-email/company/{companyId}/aggregate/{encodedEmail}: delete: tags: - bounced-email-resource summary: removeFromBounced operationId: removeFromBouncedUsingDELETE parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: encodedEmail in: path description: encodedEmail required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/bounced-email/email: get: tags: - bounced-email-resource summary: getBouncedByEmail operationId: getBouncedByEmailUsingGET parameters: - name: companyId in: query description: companyId required: false schema: type: string - name: email in: query description: email required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/BouncedEmail' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/bounced-email/{id}: delete: tags: - bounced-email-resource summary: removeFromBounced operationId: removeFromBouncedUsingDELETE_1 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/calendar/upcoming-admin-events: get: tags: - calendar-resource summary: getEvents operationId: getEventsUsingGET parameters: - name: from in: query description: from required: true schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_CalendarEventDTO_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/calendars: post: tags: - calendar-resource summary: post operationId: postUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarDTO' description: calendarDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarDTO' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/calendars/{id}: get: tags: - calendar-resource summary: get operationId: getUsingGET_2 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - calendar-resource summary: put operationId: putUsingPUT parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CalendarDTO' description: calendarDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarDTO' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - calendar-resource summary: delete operationId: deleteUsingDELETE_1 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/companies: get: tags: - companies-resource summary: listCurrentCompany operationId: listCurrentCompanyUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: type: object '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/generate_excel: get: tags: - companies-resource summary: generateExcelDownload operationId: generateExcelDownloadUsingGET parameters: - name: onlyPaying in: query description: onlyPaying required: false schema: type: string responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/merge: post: tags: - companies-resource summary: mergeCompanies operationId: mergeCompaniesUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MergeCompanyDto' description: payload required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/wicket-compatible: get: tags: - companies-resource summary: listForUserpicker operationId: listForUserpickerUsingGET parameters: - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: prefixQuery in: query required: false schema: type: boolean - name: query in: query required: false schema: type: string - name: sortBy in: query required: false schema: type: string enum: - creation - expiry - name - size responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_Map_string_object_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}: get: tags: - companies-resource summary: get operationId: getUsingGET_4 parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDetailsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/billing: post: tags: - companies-resource summary: editBilling operationId: editBillingUsingPOST parameters: - name: companyId in: path description: companyId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyPaymentDto' description: request required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDetailsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/design: get: tags: - companies-design-settings-resource summary: get operationId: getUsingGET_3 parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDesignSettings' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - companies-design-settings-resource summary: update operationId: updateUsingPUT parameters: - name: companyId in: path description: companyId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDesignSettingsDTO' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDesignSettings' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/design/image: post: tags: - companies-design-settings-resource summary: addImage operationId: addImageUsingPOST parameters: - name: companyId in: path description: companyId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/addImageUsingPOSTBody' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/emails/modifications: get: tags: - companies-email-templates-resource summary: getModifications operationId: getModificationsUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/EmailTemplateModificationInfo' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/emails/preview/{type}: get: tags: - companies-email-templates-resource summary: getPreview operationId: getPreviewUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: type in: path description: type required: true schema: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplatePreview' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/emails/{templateId}/dummyPreview: get: tags: - companies-email-templates-resource summary: renderDummyPreview operationId: renderDummyPreviewUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: templateId in: path description: templateId required: true schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplatePreview' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/companies/{companyId}/emails/{templateId}/preview: get: tags: - companies-email-templates-resource summary: renderPreview operationId: renderPreviewUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: feedbackCycleId in: query description: feedbackCycleId required: false schema: type: string - name: reviewCycleId in: query description: reviewCycleId required: false schema: type: string - name: templateId in: path description: templateId required: true schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplatePreview' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/companies/{companyId}/emails/{type}: get: tags: - companies-email-templates-resource summary: getModificationForType operationId: getModificationForTypeUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: type in: path description: type required: true schema: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplateModificationInfo' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/mini-users: get: tags: - companies-resource summary: getCompanyMiniUsers operationId: getCompanyMiniUsersUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: includeGuests in: query description: includeGuests required: false schema: type: boolean default: true - name: showLocked in: query description: showLocked required: false schema: type: boolean default: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/replacements: get: tags: - companies-resource summary: getReplacements operationId: getReplacementsUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/users: get: tags: - companies-resource summary: getCompanyUsers operationId: getCompanyUsersUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: includeGuests in: query description: includeGuests required: false schema: type: boolean default: true - name: showLocked in: query description: showLocked required: false schema: type: boolean default: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObserverUserDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/companies/{companyId}/users/denormalise-reports: post: tags: - companies-resource summary: denormaliseReports operationId: denormaliseReportsUsingPOST parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-analytics/company-created/{companyId}: get: tags: - company-analytics-resource summary: getCompanyDateCreated operationId: getCompanyDateCreatedUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string format: date-time '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-analytics/cycle-data/{companyId}: get: tags: - company-analytics-resource summary: getCycleData operationId: getCycleDataUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewCycleDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-analytics/leave-probability/{companyId}: get: tags: - company-analytics-resource summary: getLeaveProbability operationId: getLeaveProbabilityUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/LeaveProbabilityDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-analytics/settings: get: tags: - company-analytics-resource summary: getSettings operationId: getSettingsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/RetentionAnalyticsSettingsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - company-analytics-resource summary: updateSettings operationId: updateSettingsUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/RetentionAnalyticsSettingsDto' description: retentionAnalyticsSettingsDto required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-analytics/{companyId}: get: tags: - company-analytics-resource summary: getCompanyAnalytics operationId: getCompanyAnalyticsUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyAnalyticsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - company-analytics-resource summary: recalculateCompanyAnalytics operationId: recalculateCompanyAnalyticsUsingPUT parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-observer/surveys/{surveyId}: get: tags: - survey-observer-resource summary: getSurvey operationId: getSurveyUsingGET parameters: - name: surveyId in: path description: surveyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-settings/meeting-visibility: put: tags: - company-visibility-settings-resource summary: updateCompanyVisibilitySettings operationId: updateCompanyVisibilitySettingsUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/MeetingCompanyVisibilitySettingsDto' description: settings required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingCompanyVisibilitySettingsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/company-settings/{id}/date-time: get: tags: - company-date-time-settings-resource summary: getSettings operationId: getSettingsUsingGET_1 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDateTimeSettingsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - company-date-time-settings-resource summary: set operationId: setUsingPUT parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyDateTimeSettingsDto' description: dateTimeSettings required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CompanyDateTimeSettingsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/cycle-feedback-response/{responseId}: get: tags: - feedback-provide-resource summary: getResponse operationId: getResponseUsingGET_1 parameters: - name: responseId in: path description: responseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CycleFeedbackResponseDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/cycle-feedback-response/{responseId}/answer: post: tags: - feedback-provide-resource summary: answer operationId: answerUsingPOST_1 parameters: - name: responseId in: path description: responseId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/AnswerDtoArray2' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CycleFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/cycle-feedback-response/{responseId}/reopen: post: tags: - feedback-provide-resource summary: reopenResponse operationId: reopenResponseUsingPOST_1 parameters: - name: responseId in: path description: responseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CycleFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/cycle-feedback-response/{responseId}/share: post: tags: - feedback-provide-resource summary: shareResponse operationId: shareResponseUsingPOST_1 parameters: - name: responseId in: path description: responseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CycleFeedbackResponseDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/cycles/all: get: tags: - cycle-resource summary: getAllCycles operationId: getAllCyclesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_CycleDTO_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/cycles/recent: get: tags: - cycle-resource summary: getRecentCycles operationId: getRecentCyclesUsingGET parameters: - name: amount in: query description: amount required: true schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_CycleDTO_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/downloadable-file: get: tags: - downloadable-file-resource summary: getUsersDownloadableFiles operationId: getUsersDownloadableFilesUsingGET parameters: - name: from in: query description: from required: false schema: type: string format: date-time - name: limit in: query description: limit required: false schema: type: integer format: int32 default: 100 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Iterable_DownloadableFileDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/downloadable-file/{fileId}: get: tags: - downloadable-file-resource summary: getFileInfo operationId: getFileInfoUsingGET parameters: - name: fileId in: path description: fileId required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadableFileDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - downloadable-file-resource summary: deleteFile operationId: deleteFileUsingDELETE parameters: - name: fileId in: path description: fileId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/downloadable-file/{fileId}/download: get: tags: - downloadable-file-resource summary: downloadFile operationId: downloadFileUsingGET parameters: - name: fileId in: path description: fileId required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/drafts: get: tags: - drafts-resource summary: query operationId: queryUsingGET parameters: - name: date in: query required: false schema: type: string format: date-time - name: identifier in: query required: false schema: type: string - name: type in: query required: false schema: type: string enum: - ALL - ANYTIME_FEEDBACK - BOSS_EVALUATION - COMMENT - FEEDBACK - GOALS - OBJECTIVE - REPLY - SELF_ASSESSMENT responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Draft' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - drafts-resource summary: save operationId: saveUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DraftDto' description: draftDto required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/drafts/{draftId}: get: tags: - drafts-resource summary: get operationId: getUsingGET_5 parameters: - name: draftId in: path description: draftId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Draft' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - drafts-resource summary: delete operationId: deleteUsingDELETE_2 parameters: - name: draftId in: path description: draftId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/email-configuration: get: tags: - email-configuration-resource summary: getConfiguration operationId: getConfigurationUsingGET_1 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailConfigurationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - email-configuration-resource summary: setConfiguration operationId: setConfigurationUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailConfigurationDto' description: emailConfigurationDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailConfigurationDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-events: get: tags: - email-event-resource summary: getMailEvents operationId: getMailEventsUsingGET parameters: - name: cursor in: query required: false schema: type: string - name: events in: query required: false explode: true schema: type: array items: type: string - name: fromDate in: query required: false schema: type: string format: date-time - name: pageSize in: query required: false schema: type: integer format: int32 - name: recipientEmail in: query required: false schema: type: string - name: toDate in: query required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailEventResult' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-events/{companyId}: get: tags: - email-event-resource summary: getMailEventsForCompany operationId: getMailEventsForCompanyUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: cursor in: query required: false schema: type: string - name: events in: query required: false explode: true schema: type: array items: type: string - name: fromDate in: query required: false schema: type: string format: date-time - name: pageSize in: query required: false schema: type: integer format: int32 - name: recipientEmail in: query required: false schema: type: string - name: toDate in: query required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailEventResult' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-templates: get: tags: - email-templates-resource summary: getByIds operationId: getByIdsUsingGET_1 parameters: - name: feedbackCycleId in: query description: feedbackCycleId required: false schema: type: string - name: moduleType in: query description: moduleType required: false schema: type: string enum: - ANYTIME_FEEDBACK - APP - FEEDBACK - MEETING - MESSAGE - OBJECTIVE - PRAISE - PULSE_SURVEY - REVIEW - USER - name: reviewCycleId in: query description: reviewCycleId required: false schema: type: string - name: types in: query description: types required: false explode: true schema: type: array items: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/EmailTemplateDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-templates-mini: get: tags: - email-template-mini-resource summary: getByIds operationId: getByIdsUsingGET parameters: - name: feedbackCycleId in: query description: feedbackCycleId required: false schema: type: string - name: reviewCycleId in: query description: reviewCycleId required: false schema: type: string - name: types in: query description: types required: false explode: true schema: type: array items: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/EmailTemplateMiniDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-templates/preview: post: tags: - email-templates-resource summary: renderPreview operationId: renderPreviewUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplateDto' description: emailTemplateDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplatePreview' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-templates/preview/{type}: get: tags: - email-templates-resource summary: getPreview operationId: getPreviewUsingGET_1 parameters: - name: feedbackCycleId in: query description: feedbackCycleId required: false schema: type: string - name: reviewCycleId in: query description: reviewCycleId required: false schema: type: string - name: type in: path description: type required: true schema: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplatePreview' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-templates/{type}: put: tags: - email-templates-resource summary: saveTemplate operationId: saveTemplateUsingPUT parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailTemplateDto' description: emailTemplateDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplateDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - email-templates-resource summary: resetTemplate operationId: resetTemplateUsingDELETE parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU - ANYTIME_FEEDBACK_SELF_REFLECTION - ANYTIME_FEEDBACK_SHARED_WITH_REPORT - ANYTIME_FEEDBACK_SHARED_WITH_YOU - CONFIRM_EMAIL - FEEDBACK_RELEASED_DAILY_NOTIFICATION - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS - FEEDBACK_REQUEST_NUDGE_MANAGER - FEEDBACK_REQUEST_NUDGE_REVIEWEE - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE - FEEDBACK_REQUEST_PARTICIPANT_DECLINED - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE - GUEST_INVITED - INFORM_MANAGER_ABOUT_NEW_REPORTS - MEETING_NUDGE - MESSAGE_CHANGED_BY_NON_AUTHOR - MESSAGE_NOTIFICATION - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK - OBJECTIVES_DUE - OBJECTIVES_NUDGE_EMPLOYEE - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE - OBJECTIVES_NUDGE_INITIAL - OBJECTIVES_NUDGE_MANAGER - OBJECTIVES_NUDGE_MANAGER_INITIAL - OBJECTIVE_UPDATE_FOR_MANAGER - OBJECTIVE_UPDATE_FOR_USER - PASSWORD_CHANGED - PASSWORD_CHANGE_INSTRUCTIONS - PASSWORD_RESET - PASSWORD_WELCOME_INSTRUCTIONS - PRAISE_CHANGED_BY_NON_AUTHOR - PRAISE_NOTIFICATION - PRAISE_NOTIFY_MANAGER - REVIEW_CHANGED_BY_MANAGER - REVIEW_CHANGED_BY_REVIEWEE - REVIEW_HID_BY_EMPLOYEE - REVIEW_HID_BY_MANAGER - REVIEW_INDICATED_BY_MANAGER - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC - REVIEW_INFORM_MANAGER_UNSPECIFIC - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_INFORM_TEAM_MEMBER - REVIEW_NUDGE_MANAGER - REVIEW_NUDGE_MANAGER_UNSPECIFIC - REVIEW_NUDGE_REPORT - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC - REVIEW_SHARE_WITH_EMPLOYEE - REVIEW_SHARE_WITH_MANAGER - REVIEW_SIGNED_BY_MANAGER - REVIEW_SIGNED_BY_REPORT - SURVEY_NOTIFICATION - USER_DIGEST - USER_INVITED - USER_PROFILE_NUDGE responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/EmailTemplateDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/email-verifications: post: tags: - email-verifications-resource summary: verify operationId: verifyUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/VerificationAttempt' description: attempt required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-verifications/{address}/resend: post: tags: - email-verifications-resource summary: resend operationId: resendUsingPOST parameters: - name: address in: path description: address required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/email-verifications/{address}/verified: get: tags: - email-verifications-resource summary: verified operationId: verifiedUsingGET parameters: - name: address in: path description: address required: true schema: type: string - name: company in: query description: company required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/IsVerified' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/features: get: tags: - features-resource summary: featureMap operationId: featureMapUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles: get: tags: - feedback-cycles-resource summary: getFeedbackCycles operationId: getFeedbackCyclesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackCycleListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/guided/create: post: tags: - feedback-cycles-resource summary: createFeedbackCycleGuided operationId: createFeedbackCycleGuidedUsingPOST requestBody: $ref: '#/components/requestBodies/FeedbackCycleGuidedDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/guided/edit: post: tags: - feedback-cycles-resource summary: editFeedbackCycleGuided operationId: editFeedbackCycleGuidedUsingPOST requestBody: $ref: '#/components/requestBodies/FeedbackCycleGuidedDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/guided/{cycleId}: get: tags: - feedback-cycles-resource summary: getFeedbackCycleGuided operationId: getFeedbackCycleGuidedUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleGuidedDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/hidden-feedback-for-user/{userId}: get: tags: - feedback-cycles-resource summary: getFeedbackCyclesWithHiddenFeedbackFor operationId: getFeedbackCyclesWithHiddenFeedbackForUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackCycleListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/preview/{cycleId}: get: tags: - feedback-cycles-resource summary: getFeedbackCyclePreview operationId: getFeedbackCyclePreviewUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleGuidedDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/statistics: get: tags: - feedback-statistics-resource summary: getCycleStatistics operationId: getCycleStatisticsUsingGET_1 parameters: - name: cycleIds in: query description: cycleIds required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackCycleStatisticsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}: get: tags: - feedback-cycles-resource summary: get operationId: getUsingGET_6 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-cycles-resource summary: delete operationId: deleteUsingDELETE_3 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/approve_all: post: tags: - feedback-cycles-resource summary: approveAll operationId: approveAllUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/archive: put: tags: - feedback-cycles-resource summary: archive operationId: archiveUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/bulk_add_team_members: post: tags: - feedback-requests-resource summary: bulkAddTeamMembers operationId: bulkAddTeamMembersUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/bulk_approve: post: tags: - feedback-cycles-resource summary: bulkApprove operationId: bulkApproveUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: type: array items: type: string description: feedbackRequestIds required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/complete_all: post: tags: - feedback-cycles-resource summary: completeAll operationId: completeAllUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/cycle-admins: post: tags: - feedback-cycle-admin-resource summary: editFeedbackCycleAdmins operationId: editFeedbackCycleAdminsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/editFeedbackCycleAdminsUsingPOSTUserids' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/cycle-admins/{userId}: put: tags: - feedback-cycle-admin-resource summary: addCycleAdmin operationId: addCycleAdminUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-cycle-admin-resource summary: removeCycleAdmin operationId: removeCycleAdminUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/export/lazy/{exportType}/{outputType}: post: tags: - feedback-export-resource summary: lazyExportFeedback operationId: lazyExportFeedbackUsingPOST parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/export/pdf/{perspective}: post: tags: - feedback-export-resource summary: exportPdf operationId: exportPdfUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ExportPdfOptions' description: exportPdfOptions required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/export/{exportType}/columns: get: tags: - feedback-export-resource summary: availableColumns operationId: availableColumnsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AvailableColumn' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/export/{exportType}/{outputType}: get: tags: - feedback-export-resource summary: exportFeedback operationId: exportFeedbackUsingGET parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/export_xml: get: tags: - feedback-export-resource summary: generateXML operationId: generateXMLUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/export_xml/lazy: post: tags: - feedback-export-resource summary: lazyGenerateXML operationId: lazyGenerateXMLUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests: get: tags: - feedback-requests-resource summary: list operationId: listUsingGET_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: managerId in: query description: managerId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackRequestDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - feedback-requests-resource summary: createBulkReviews operationId: createBulkReviewsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UserIdHolderArray2' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateFeedbackRequestsBulkResult' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/add-all-managers-as-reviewers: post: tags: - feedback-requests-resource summary: bulkAddManagers operationId: bulkAddManagersUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/add-self-assessments: post: tags: - feedback-requests-resource summary: bulkAddSelfAssessments operationId: bulkAddSelfAssessmentsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/count: get: tags: - feedback-requests-resource summary: count operationId: countUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: integer format: int64 '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/nudge: post: tags: - feedback-requests-resource summary: bulkNudge operationId: bulkNudgeUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: target in: query description: target required: true schema: type: string enum: - MANAGER - REVIEWEE requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}: get: tags: - feedback-requests-resource summary: getFeedbackRequest operationId: getFeedbackRequestUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-requests-resource summary: delete operationId: deleteUsingDELETE_4 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/approved: put: tags: - feedback-requests-resource summary: approveFeedbackRequest operationId: approveFeedbackRequestUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-requests-resource summary: unapproveFeedbackRequest operationId: unapproveFeedbackRequestUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/completed: put: tags: - feedback-requests-resource summary: completeFeedbackRequest operationId: completeFeedbackRequestUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-requests-resource summary: reopenFeedbackRequest operationId: reopenFeedbackRequestUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/markAsDone: put: tags: - feedback-requests-resource summary: markAsDone operationId: markAsDoneUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-requests-resource summary: markAsNotDone operationId: markAsNotDoneUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/nudge: post: tags: - feedback-requests-resource summary: nudge operationId: nudgeUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/participants: get: tags: - feedback-participants-resource summary: list operationId: listUsingGET_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackParticipantListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - feedback-participants-resource summary: addParticipants operationId: addParticipantsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UserIdHolderArray2' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackParticipantListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/participants/{participantId}: get: tags: - feedback-participants-resource summary: getItemById operationId: getItemByIdUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: participantId in: path description: participantId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-participants-resource summary: deleteItem operationId: deleteItemUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: participantId in: path description: participantId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackParticipantListDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/participants/{participantId}/completed: put: tags: - feedback-participants-resource summary: complete operationId: completeUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: participantId in: path description: participantId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-participants-resource summary: reopen operationId: reopenUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: participantId in: path description: participantId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/participants/{participantId}/declined: put: tags: - feedback-participants-resource summary: decline operationId: declineUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: participantId in: path description: participantId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeedbackReasonDto' description: feedbackReasonDto responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/participants/{participantId}/nudge: post: tags: - feedback-participants-resource summary: nudgeReviewer operationId: nudgeReviewerUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: participantId in: path description: participantId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/release-feedback: put: tags: - feedback-requests-resource summary: releaseFeedback operationId: releaseFeedbackUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackRequestDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/feedback-requests/{requestId}/updateNoteToReviewers: put: tags: - feedback-requests-resource summary: addNoteToReviewers operationId: addNoteToReviewersUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: requestId in: path description: requestId required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: string description: body required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/inform_all: post: tags: - feedback-cycles-resource summary: informAllManagersToApproveReviewers operationId: informAllManagersToApproveReviewersUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: onlyWithNominees in: query description: onlyWithNominees required: false schema: type: boolean - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/inform_managers_to_nominate: post: tags: - feedback-cycles-resource summary: informAllManagersToNominateReviewers operationId: informAllManagersToNominateReviewersUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/nudge_all: post: tags: - feedback-cycles-resource summary: nudgeAll operationId: nudgeAllUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: onlyWithNominees in: query description: onlyWithNominees required: false schema: type: boolean - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/reviewers: get: tags: - feedback-reviewers-resource summary: listUserParticipations operationId: listUserParticipationsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackParticipationByUserDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/reviewers/{reviewerId}/nudge: post: tags: - feedback-reviewers-resource summary: nudgeReviewerForAllHisParticipations operationId: nudgeReviewerForAllHisParticipationsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/reviewers/{reviewerId}/participations: get: tags: - feedback-reviewers-resource summary: getUserParticipations operationId: getUserParticipationsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewerId in: path description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackParticipantListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/statistics: get: tags: - feedback-statistics-resource summary: getCycleStatistics operationId: getCycleStatisticsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleStatisticsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-cycles/{cycleId}/unarchive: put: tags: - feedback-cycles-resource summary: unarchive operationId: unarchiveUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback-requests/{requestId}/feedback-reviewee-rating: put: tags: - feedback-requests-resource summary: getFeedbackRequest operationId: getFeedbackRequestUsingPUT parameters: - name: requestId in: path description: requestId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeedbackRequestRating' description: ratingDTO required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-requests-resource summary: getFeedbackRequest operationId: getFeedbackRequestUsingDELETE parameters: - name: requestId in: path description: requestId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback/new-unsolicited: post: tags: - feedback-participants-resource summary: newUnsolicitedFeedback operationId: newUnsolicitedFeedbackUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/NewUnsolicitedFeedbackDto' description: newUnsolicitedFeedbackDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/participant/mini/{participantId}: get: tags: - feedback-participants-resource summary: getMiniById operationId: getMiniByIdUsingGET parameters: - name: participantId in: path description: participantId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantMini' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/provide-feedback: post: tags: - feedback-participants-resource summary: provideFeedback operationId: provideFeedbackUsingPOST parameters: - name: saveDraft in: query description: saveDraft required: false schema: type: boolean default: false requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackDto' description: feedbackDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/request/overview/company: get: tags: - request-feedback-resource summary: getSummariesCompany operationId: getSummariesCompanyUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/RequestFeedbackSummary' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/feedback/request/overview/team: get: tags: - request-feedback-resource summary: getSummariesTeam operationId: getSummariesTeamUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/RequestFeedbackSummary' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/template/order: get: tags: - feedback-template-resource summary: getOrderLegacy operationId: getOrderLegacyUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackTemplateOrderDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/template/{id}: put: tags: - feedback-template-resource summary: editTemplate operationId: editTemplateUsingPUT parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeedbackTemplateDto' description: template required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackTemplateDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - feedback-template-resource summary: deleteTemplate operationId: deleteTemplateUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/feedback/template/{type}: get: tags: - feedback-template-resource summary: getTemplates operationId: getTemplatesUsingGET parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME - CYCLE responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackTemplateDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - feedback-template-resource summary: createTemplate operationId: createTemplateUsingPOST parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME - CYCLE requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackTemplateDto' description: template required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackTemplateDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/template/{type}/active: get: tags: - feedback-template-resource summary: getActiveTemplates operationId: getActiveTemplatesUsingGET parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME - CYCLE responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/FeedbackTemplateDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/template/{type}/order: get: tags: - feedback-template-resource summary: getOrder operationId: getOrderUsingGET parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME - CYCLE responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackTemplateOrderDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - feedback-template-resource summary: updateOrder operationId: updateOrderUsingPUT parameters: - name: type in: path description: type required: true schema: type: string enum: - ANYTIME - CYCLE requestBody: content: application/json: schema: $ref: '#/components/schemas/FeedbackTemplateOrderDto' description: body required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackTemplateOrderDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/unsolicited/reviewees: get: tags: - feedback-participants-resource summary: getPossibleRevieweesInCycle operationId: getPossibleRevieweesInCycleUsingGET parameters: - name: cycleId in: query description: cycleId required: true schema: type: string - name: reviewerId in: query description: reviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniFeedbackRequest' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/feedback/{feedbackId}: get: tags: - feedback-participants-resource summary: getFeedback operationId: getFeedbackUsingGET parameters: - name: feedbackId in: path description: feedbackId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackParticipantProvideDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/admin: get: tags: - helpful-resources-attachments-resource summary: getAllForAdmin operationId: getAllForAdminUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AttachmentDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/file: post: tags: - helpful-resources-attachments-resource summary: createFile operationId: createFileUsingPOST requestBody: $ref: '#/components/requestBodies/CreateFileAttachmentDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AttachmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/file/{attachmentKey}: put: tags: - helpful-resources-attachments-resource summary: updateFile operationId: updateFileUsingPUT parameters: - name: attachmentKey in: path description: attachmentKey required: true schema: type: string requestBody: $ref: '#/components/requestBodies/CreateFileAttachmentDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AttachmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/link: post: tags: - helpful-resources-attachments-resource summary: createLink operationId: createLinkUsingPOST requestBody: $ref: '#/components/requestBodies/CreateLinkAttachmentDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AttachmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/link/{attachmentKey}: put: tags: - helpful-resources-attachments-resource summary: updateLink operationId: updateLinkUsingPUT parameters: - name: attachmentKey in: path description: attachmentKey required: true schema: type: string requestBody: $ref: '#/components/requestBodies/CreateLinkAttachmentDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AttachmentDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/sidebar: get: tags: - helpful-resources-attachments-resource summary: getAllForSidebar operationId: getAllForSidebarUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AttachmentDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/helpful-resources/attachments/{attachmentKey}: delete: tags: - helpful-resources-attachments-resource summary: delete operationId: deleteUsingDELETE_5 parameters: - name: attachmentKey in: path description: attachmentKey required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/helpful-resources/attachments/{attachmentKey}/download: get: tags: - helpful-resources-attachments-resource summary: download operationId: downloadUsingGET parameters: - name: attachmentKey in: path description: attachmentKey required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/logout: post: tags: - logout-resource summary: logoutUser operationId: logoutUserUsingPOST responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-actions: get: tags: - meeting-actions-resource summary: getAll operationId: getAllUsingGET parameters: - name: forUser in: query description: forUser required: false schema: type: string - name: participants in: query description: participants required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/MeetingActionDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - meeting-actions-resource summary: create operationId: createUsingPOST_1 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingActionCreate' description: createRequest required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MeetingActionDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found patch: tags: - meeting-actions-resource summary: update operationId: updateUsingPATCH requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingActionUpdate' description: update required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MeetingActionDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meeting-actions/{actionId}: delete: tags: - meeting-actions-resource summary: delete operationId: deleteUsingDELETE_6 parameters: - name: actionId in: path description: actionId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meeting-calendar-integration/companies/{companyId}/users/{userId}/events: get: tags: - meeting-calendar-company-observer-resource summary: getCalendarEvents operationId: getCalendarEventsUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/CalendarEventDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-calendar-integration/configuration: get: tags: - meeting-calendar-configuration-resource summary: getConfiguration operationId: getConfigurationUsingGET_2 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingCalendarConfiguration' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - meeting-calendar-configuration-resource summary: saveConfiguration operationId: saveConfigurationUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMeetingCalendarConfigurationRequest' description: request required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingCalendarConfiguration' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-calendar-integration/configuration/{companyId}: get: tags: - meeting-calendar-configuration-resource summary: getConfigurationForCompany operationId: getConfigurationForCompanyUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingCalendarConfiguration' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-calendar-integration/provider: get: tags: - meeting-calendar-configuration-resource summary: getProvider operationId: getProviderUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string enum: - GOOGLE - OUTLOOK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-calendar-integration/settings: get: tags: - meeting-calendar-settings-resource summary: getSettings operationId: getSettingsUsingGET_3 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarSettingsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - meeting-calendar-settings-resource summary: updateCalendarSettings operationId: updateCalendarSettingsUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/CalendarSettingsUpdateRequest' description: updateRequest required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-insights: post: tags: - insights-resource summary: getInsights operationId: getInsightsUsingPOST requestBody: $ref: '#/components/requestBodies/InsightsRequest' responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/InsightsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-insights/download-csv: post: tags: - insights-resource summary: triggerCsvDownload operationId: triggerCsvDownloadUsingPOST requestBody: $ref: '#/components/requestBodies/InsightsRequest' responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-insights/team: post: tags: - insights-resource summary: getTeamInsights operationId: getTeamInsightsUsingPOST requestBody: $ref: '#/components/requestBodies/InsightsRequest' responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/InsightsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-nudges/spaces: get: tags: - nudge-resource summary: getMeetingNudges operationId: getMeetingNudgesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingSpaceNudgesRecordDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - nudge-resource summary: sendNudges operationId: sendNudgesUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/NudgeRequests' description: nudgeRequests required: true x-examples: application/json: '[{''participants'': [''string'',''string''], ''nudgeeKey'': ''string (one of participants)''}]' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingSpaceNudgesRecordDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-spaces/me: get: tags: - meeting-space-resource summary: getMyMeetingSpaces operationId: getMyMeetingSpacesUsingGET parameters: - name: id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingSpaceDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-spaces/mini/shared: get: tags: - meeting-space-resource summary: getSharedMeetingSpacesMini operationId: getSharedMeetingSpacesMiniUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingSpaceMiniDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-spaces/shared: get: tags: - meeting-space-resource summary: getSharedMeetingSpaces operationId: getSharedMeetingSpacesUsingGET parameters: - name: id in: query required: false schema: type: string - name: minUpdatedDate in: query description: minUpdatedDate required: true schema: type: string format: date-time - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingSpaceDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-spaces/shared-count: get: tags: - meeting-space-resource summary: getSharedMeetingSpacesCount operationId: getSharedMeetingSpacesCountUsingGET parameters: - name: minUpdatedDate in: query description: minUpdatedDate required: true schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingSpacesSharedCount' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-templates: get: tags: - meeting-template-resource summary: getMeetingTemplates operationId: getMeetingTemplatesUsingGET parameters: - name: required-permission in: query description: required-permission required: false schema: type: string enum: - EDIT - SEE - USE default: SEE - name: type in: query description: type required: true schema: type: string enum: - COMPANY - USER responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingTemplateDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - meeting-template-resource summary: createMeetingTemplate operationId: createMeetingTemplateUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingTemplateDetails' description: meetingTemplateDetails required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingTemplateDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-templates-usage: post: tags: - meeting-template-resource summary: recordTemplateUsage operationId: recordTemplateUsageUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingTemplateUsageRequest' description: meetingTemplateUsageRequest required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-templates/create-meeting: post: tags: - meeting-template-resource summary: createMeetingFromTemplate operationId: createMeetingFromTemplateUsingPOST parameters: - name: id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingFromTemplateRequest' description: request required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meeting-templates/{id}: get: tags: - meeting-template-resource summary: getMeetingTemplate operationId: getMeetingTemplateUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingTemplateDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - meeting-template-resource summary: updateMeetingTemplate operationId: updateMeetingTemplateUsingPUT parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MeetingTemplateDetails' description: meetingTemplateDetails required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingTemplateDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - meeting-template-resource summary: deleteMeetingTemplate operationId: deleteMeetingTemplateUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meetings: get: tags: - meeting-resource summary: listMyMeetingsWithParticipant operationId: listMyMeetingsWithParticipantUsingGET parameters: - name: endDate.chronology.calendarType in: query required: false schema: type: string - name: endDate.chronology.id in: query required: false schema: type: string - name: endDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDate.era in: query required: false schema: type: string enum: - BCE - CE - name: endDate.leapYear in: query required: false schema: type: boolean - name: endDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDate.monthValue in: query required: false schema: type: integer format: int32 - name: endDate.year in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDateTime.hour in: query required: false schema: type: integer format: int32 - name: endDateTime.minute in: query required: false schema: type: integer format: int32 - name: endDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: endDateTime.nano in: query required: false schema: type: integer format: int32 - name: endDateTime.second in: query required: false schema: type: integer format: int32 - name: endDateTime.year in: query required: false schema: type: integer format: int32 - name: id in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: participants[0].id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: startDate.chronology.calendarType in: query required: false schema: type: string - name: startDate.chronology.id in: query required: false schema: type: string - name: startDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDate.era in: query required: false schema: type: string enum: - BCE - CE - name: startDate.leapYear in: query required: false schema: type: boolean - name: startDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDate.monthValue in: query required: false schema: type: integer format: int32 - name: startDate.year in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDateTime.hour in: query required: false schema: type: integer format: int32 - name: startDateTime.minute in: query required: false schema: type: integer format: int32 - name: startDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: startDateTime.nano in: query required: false schema: type: integer format: int32 - name: startDateTime.second in: query required: false schema: type: integer format: int32 - name: startDateTime.year in: query required: false schema: type: integer format: int32 - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - meeting-resource summary: createMeeting operationId: createMeetingUsingPOST parameters: - name: id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateMeetingRequest' description: createMeetingRequest required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/export-content-csv: post: tags: - meeting-resource summary: triggerContentDownload operationId: triggerContentDownloadUsingPOST parameters: - name: from in: query description: from required: false schema: type: string format: date - name: until in: query description: until required: false schema: type: string format: date responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/metadata: get: tags: - meeting-resource summary: listMeetingsMetadata operationId: listMeetingsMetadataUsingGET parameters: - name: endDate.chronology.calendarType in: query required: false schema: type: string - name: endDate.chronology.id in: query required: false schema: type: string - name: endDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDate.era in: query required: false schema: type: string enum: - BCE - CE - name: endDate.leapYear in: query required: false schema: type: boolean - name: endDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDate.monthValue in: query required: false schema: type: integer format: int32 - name: endDate.year in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDateTime.hour in: query required: false schema: type: integer format: int32 - name: endDateTime.minute in: query required: false schema: type: integer format: int32 - name: endDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: endDateTime.nano in: query required: false schema: type: integer format: int32 - name: endDateTime.second in: query required: false schema: type: integer format: int32 - name: endDateTime.year in: query required: false schema: type: integer format: int32 - name: id in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: participants[0].id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: startDate.chronology.calendarType in: query required: false schema: type: string - name: startDate.chronology.id in: query required: false schema: type: string - name: startDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDate.era in: query required: false schema: type: string enum: - BCE - CE - name: startDate.leapYear in: query required: false schema: type: boolean - name: startDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDate.monthValue in: query required: false schema: type: integer format: int32 - name: startDate.year in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDateTime.hour in: query required: false schema: type: integer format: int32 - name: startDateTime.minute in: query required: false schema: type: integer format: int32 - name: startDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: startDateTime.nano in: query required: false schema: type: integer format: int32 - name: startDateTime.second in: query required: false schema: type: integer format: int32 - name: startDateTime.year in: query required: false schema: type: integer format: int32 - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingMetadataDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/relevant: get: tags: - meeting-resource summary: listRelevantMeetings operationId: listRelevantMeetingsUsingGET parameters: - name: endDate.chronology.calendarType in: query required: false schema: type: string - name: endDate.chronology.id in: query required: false schema: type: string - name: endDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDate.era in: query required: false schema: type: string enum: - BCE - CE - name: endDate.leapYear in: query required: false schema: type: boolean - name: endDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDate.monthValue in: query required: false schema: type: integer format: int32 - name: endDate.year in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDateTime.hour in: query required: false schema: type: integer format: int32 - name: endDateTime.minute in: query required: false schema: type: integer format: int32 - name: endDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: endDateTime.nano in: query required: false schema: type: integer format: int32 - name: endDateTime.second in: query required: false schema: type: integer format: int32 - name: endDateTime.year in: query required: false schema: type: integer format: int32 - name: id in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: participants[0].id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: startDate.chronology.calendarType in: query required: false schema: type: string - name: startDate.chronology.id in: query required: false schema: type: string - name: startDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDate.era in: query required: false schema: type: string enum: - BCE - CE - name: startDate.leapYear in: query required: false schema: type: boolean - name: startDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDate.monthValue in: query required: false schema: type: integer format: int32 - name: startDate.year in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDateTime.hour in: query required: false schema: type: integer format: int32 - name: startDateTime.minute in: query required: false schema: type: integer format: int32 - name: startDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: startDateTime.nano in: query required: false schema: type: integer format: int32 - name: startDateTime.second in: query required: false schema: type: integer format: int32 - name: startDateTime.year in: query required: false schema: type: integer format: int32 - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingRelevantDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/visibility: post: tags: - meeting-resource summary: bulkUpdateVisibility operationId: bulkUpdateVisibilityUsingPOST parameters: - name: endDate.chronology.calendarType in: query required: false schema: type: string - name: endDate.chronology.id in: query required: false schema: type: string - name: endDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDate.era in: query required: false schema: type: string enum: - BCE - CE - name: endDate.leapYear in: query required: false schema: type: boolean - name: endDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDate.monthValue in: query required: false schema: type: integer format: int32 - name: endDate.year in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: endDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: endDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: endDateTime.hour in: query required: false schema: type: integer format: int32 - name: endDateTime.minute in: query required: false schema: type: integer format: int32 - name: endDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: endDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: endDateTime.nano in: query required: false schema: type: integer format: int32 - name: endDateTime.second in: query required: false schema: type: integer format: int32 - name: endDateTime.year in: query required: false schema: type: integer format: int32 - name: id in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: mergeVisibility in: query description: mergeVisibility required: true schema: type: boolean - name: participants[0].id in: query required: false schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: startDate.chronology.calendarType in: query required: false schema: type: string - name: startDate.chronology.id in: query required: false schema: type: string - name: startDate.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDate.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDate.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDate.era in: query required: false schema: type: string enum: - BCE - CE - name: startDate.leapYear in: query required: false schema: type: boolean - name: startDate.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDate.monthValue in: query required: false schema: type: integer format: int32 - name: startDate.year in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfMonth in: query required: false schema: type: integer format: int32 - name: startDateTime.dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: startDateTime.dayOfYear in: query required: false schema: type: integer format: int32 - name: startDateTime.hour in: query required: false schema: type: integer format: int32 - name: startDateTime.minute in: query required: false schema: type: integer format: int32 - name: startDateTime.month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: startDateTime.monthValue in: query required: false schema: type: integer format: int32 - name: startDateTime.nano in: query required: false schema: type: integer format: int32 - name: startDateTime.second in: query required: false schema: type: integer format: int32 - name: startDateTime.year in: query required: false schema: type: integer format: int32 - name: totalSeconds in: query required: false schema: type: integer format: int32 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ViewersDto' description: viewersDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MeetingDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/{id}: get: tags: - meeting-resource summary: getMeeting operationId: getMeetingUsingGET parameters: - name: id in: query description: id required: true schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - meeting-resource summary: deleteMeeting operationId: deleteMeetingUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden patch: tags: - meeting-resource summary: patchMeeting operationId: patchMeetingUsingPATCH parameters: - name: id in: query description: id required: true schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MeetingPatchRequest' description: meetingPatch required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meetings/{id}/attachments: post: tags: - meeting-attachment-resource summary: create operationId: createUsingPOST_2 parameters: - name: id in: query description: id required: true schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateAttachmentCommand' description: command required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/{meetingId}/attachments/{attachmentId}: get: tags: - meeting-attachment-resource summary: download operationId: downloadUsingGET_1 parameters: - name: attachmentId in: path description: attachmentId required: true schema: type: string - name: meetingId in: path description: meetingId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - meeting-attachment-resource summary: delete operationId: deleteUsingDELETE_7 parameters: - name: attachmentId in: path description: attachmentId required: true schema: type: string - name: id in: query required: false schema: type: string - name: meetingId in: path description: meetingId required: true schema: type: string - name: rules.fixedOffset in: query required: false schema: type: boolean - name: rules.transitionRules[0].dayOfMonthIndicator in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].dayOfWeek in: query required: false schema: type: string enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY - name: rules.transitionRules[0].localTime.hour in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.minute in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.nano in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].localTime.second in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].midnightEndOfDay in: query required: false schema: type: boolean - name: rules.transitionRules[0].month in: query required: false schema: type: string enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER - name: rules.transitionRules[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitionRules[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].standardOffset.id in: query required: false schema: type: string - name: rules.transitionRules[0].standardOffset.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitionRules[0].timeDefinition in: query required: false schema: type: string enum: - STANDARD - UTC - WALL - name: rules.transitions[0].dateTimeAfter in: query required: false schema: type: string format: date-time - name: rules.transitions[0].dateTimeBefore in: query required: false schema: type: string format: date-time - name: rules.transitions[0].duration.nano in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].duration.negative in: query required: false schema: type: boolean - name: rules.transitions[0].duration.seconds in: query required: false schema: type: integer format: int64 - name: rules.transitions[0].duration.units[0].dateBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].durationEstimated in: query required: false schema: type: boolean - name: rules.transitions[0].duration.units[0].timeBased in: query required: false schema: type: boolean - name: rules.transitions[0].duration.zero in: query required: false schema: type: boolean - name: rules.transitions[0].gap in: query required: false schema: type: boolean - name: rules.transitions[0].instant in: query required: false schema: type: string format: date-time - name: rules.transitions[0].offsetAfter.id in: query required: false schema: type: string - name: rules.transitions[0].offsetAfter.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].offsetBefore.id in: query required: false schema: type: string - name: rules.transitions[0].offsetBefore.totalSeconds in: query required: false schema: type: integer format: int32 - name: rules.transitions[0].overlap in: query required: false schema: type: boolean - name: totalSeconds in: query required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meetings/{meetingId}/notes: post: tags: - meeting-note-resource summary: createNote operationId: createNoteUsingPOST parameters: - name: meetingId in: path description: meetingId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateNoteCommand' description: command required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingNoteDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/{meetingId}/notes/{noteId}: put: tags: - meeting-note-resource summary: editNote operationId: editNoteUsingPUT parameters: - name: meetingId in: path description: meetingId required: true schema: type: string - name: noteId in: path description: noteId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EditNoteCommand' description: command required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingNoteDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - meeting-note-resource summary: deleteNote operationId: deleteNoteUsingDELETE parameters: - name: meetingId in: path description: meetingId required: true schema: type: string - name: noteId in: path description: noteId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meetings/{meetingId}/talkingpoints: post: tags: - talking-point-resource summary: createTalkingPoints operationId: createTalkingPointsUsingPOST parameters: - name: meetingId in: path description: meetingId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateTalkingPointCommandList' description: commandList required: true x-examples: application/json: '[{''content'': ''string'', ''visibility'': ''SHARED'', ''checked'': true}]' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/TalkingPointDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - talking-point-resource summary: reorderTalkingPoint operationId: reorderTalkingPointUsingPUT parameters: - name: meetingId in: path description: meetingId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EditPositionCommand' description: command required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/TalkingPointDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/meetings/{meetingId}/talkingpoints/{pointId}: put: tags: - talking-point-resource summary: editTalkingPoint operationId: editTalkingPointUsingPUT parameters: - name: meetingId in: path description: meetingId required: true schema: type: string - name: pointId in: path description: pointId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EditTalkingPointCommand' description: command required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - talking-point-resource summary: deletePoint operationId: deletePointUsingDELETE parameters: - name: meetingId in: path description: meetingId required: true schema: type: string - name: pointId in: path description: pointId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/meetings/{meetingId}/talkingpoints/{pointId}/check: put: tags: - talking-point-resource summary: toggleTalkingPoint operationId: toggleTalkingPointUsingPUT parameters: - name: checked in: query description: checked required: true schema: type: boolean - name: meetingId in: path description: meetingId required: true schema: type: string - name: pointId in: path description: pointId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/message-settings: get: tags: - message-settings-resource summary: getMessageSettings operationId: getMessageSettingsUsingGET responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MessageSettingsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - message-settings-resource summary: editMessageSettings operationId: editMessageSettingsUsingPUT requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageSettingsDto' description: messageSettingsDto required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MessageSettingsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages: get: tags: - messages-resource summary: getMessages operationId: getMessagesUsingGET parameters: - name: author in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string format: date-time - name: includeAnonymous in: query required: false schema: type: boolean - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: projectId in: query required: false schema: type: string - name: recipient in: query required: false schema: type: string - name: startDate in: query required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - messages-resource summary: createMessage operationId: createMessageUsingPOST parameters: - name: source in: query description: source required: false schema: type: string enum: - GMAIL - HIPCHAT - SLACK - WEBAPP default: WEBAPP requestBody: $ref: '#/components/requestBodies/MessageDTO' responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/peer-feedback-export: post: tags: - messages-peer-feedback-resource summary: triggerPeerFeedbackExport operationId: triggerPeerFeedbackExportUsingPOST parameters: - name: format in: query description: format required: true schema: type: string enum: - CSV - EXCEL - name: from in: query description: from required: true schema: type: string format: date - name: to in: query description: to required: true schema: type: string format: date responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/preview/{id}: get: tags: - messages-resource summary: getPreview operationId: getPreviewUsingGET_2 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessagePreviewWithStatus' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/relevant: get: tags: - messages-resource summary: getRelevantMessages operationId: getRelevantMessagesUsingGET parameters: - name: author in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string format: date-time - name: includeAnonymous in: query required: false schema: type: boolean - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: projectId in: query required: false schema: type: string - name: recipient in: query required: false schema: type: string - name: startDate in: query required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MessageRelevantView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{companyId}/usage-statistics: get: tags: - messages-resource summary: getUserUsageStatistics operationId: getUserUsageStatisticsUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: endDate in: query description: endDate required: true schema: type: string - name: includeDeactivated in: query description: includeDeactivated required: false schema: type: boolean default: false - name: startDate in: query description: startDate required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_UserMessageStatisticsDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{companyId}/usage-statistics/export: post: tags: - messages-resource summary: triggerCsvDownload operationId: triggerCsvDownloadUsingPOST_1 parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: endDate in: query description: endDate required: true schema: type: string - name: includeDeactivated in: query description: includeDeactivated required: false schema: type: boolean default: false - name: startDate in: query description: startDate required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{id}: get: tags: - messages-resource summary: get operationId: getUsingGET_7 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - messages-resource summary: delete operationId: deleteUsingDELETE_8 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/messages/{messageId}: put: tags: - messages-resource summary: editMessage operationId: editMessageUsingPUT parameters: - name: messageId in: path description: messageId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageDTO' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{messageId}/downvote: post: tags: - messages-resource summary: downvote operationId: downvoteUsingPOST parameters: - name: messageId in: path description: messageId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{messageId}/replies: get: tags: - messages-resource summary: getReplies operationId: getRepliesUsingGET parameters: - name: author in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string format: date-time - name: includeAnonymous in: query required: false schema: type: boolean - name: limit in: query required: false schema: type: integer format: int32 - name: messageId in: path description: messageId required: true schema: type: string - name: offset in: query required: false schema: type: integer format: int32 - name: projectId in: query required: false schema: type: string - name: recipient in: query required: false schema: type: string - name: startDate in: query required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - messages-resource summary: createReply operationId: createReplyUsingPOST parameters: - name: messageId in: path description: messageId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/MessageDTO' responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{messageId}/unveil: post: tags: - messages-resource summary: unveil operationId: unveilUsingPOST parameters: - name: messageId in: path description: messageId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{messageId}/upvote: post: tags: - messages-resource summary: upvote operationId: upvoteUsingPOST parameters: - name: messageId in: path description: messageId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/messages/{messageId}/visibleTo: put: tags: - messages-resource summary: updateVisibleToPermissions operationId: updateVisibleToPermissionsUsingPUT parameters: - name: messageId in: path description: messageId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UserIdHolderArray' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/notificationLogs/count/new: get: tags: - notification-log-resource summary: getNewCount operationId: getNewCountUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/NotificationLogCountDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/notificationLogs/count/reset: post: tags: - notification-log-resource summary: resetNewCount operationId: resetNewCountUsingPOST responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/NotificationLogCountDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/notificationLogs/latest: get: tags: - notification-log-resource summary: getLatest operationId: getLatestUsingGET parameters: - name: limit in: query description: limit required: false schema: type: integer format: int32 default: 10 - name: offset in: query description: offset required: false schema: type: integer format: int32 default: 0 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/NotificationLogDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/notificationLogs/markAllAsRead: post: tags: - notification-log-resource summary: markAllAsRead operationId: markAllAsReadUsingPOST responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/notificationLogs/markAsRead/{id}: post: tags: - notification-log-resource summary: markAsRead operationId: markAsReadUsingPOST parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/NotificationLogDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/notificationLogs/markAsUnread/{id}: post: tags: - notification-log-resource summary: markAsUnread operationId: markAsUnreadUsingPOST parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/NotificationLogDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-categories: get: tags: - objective-categories-resource summary: get operationId: getUsingGET_8 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveCategory' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - objective-categories-resource summary: put operationId: putUsingPUT_1 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ObjectiveCategory' description: objectiveCategories required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveCategory' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles: get: tags: - objective-cycles-resource summary: list operationId: listUsingGET_3 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveCycleDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/all/objectives/browse-view: get: tags: - objectives-resource summary: browseView operationId: browseViewUsingGET parameters: - name: allUsers in: query description: allUsers required: false schema: type: boolean default: false - name: cycleIds in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: ownerIds in: query required: false schema: type: string - name: sortKey in: query required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/BrowserView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/all/objectives/relevant: get: tags: - objectives-resource summary: listAllRelevant operationId: listAllRelevantUsingGET parameters: - name: endDate in: query description: endDate required: false schema: type: string format: date-time - name: startDate in: query description: startDate required: false schema: type: string format: date-time - name: userId in: query description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ClippyView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/guided/create: post: tags: - objective-cycles-resource summary: createObjectiveCycleGuided operationId: createObjectiveCycleGuidedUsingPOST requestBody: $ref: '#/components/requestBodies/ObjectiveCycleGuidedDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/guided/edit: post: tags: - objective-cycles-resource summary: editObjectiveCycleGuided operationId: editObjectiveCycleGuidedUsingPOST requestBody: $ref: '#/components/requestBodies/ObjectiveCycleGuidedDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/guided/{cycleId}: get: tags: - objective-cycles-resource summary: getObjectiveCycleGuided operationId: getObjectiveCycleGuidedUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleGuidedDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}: get: tags: - objective-cycles-resource summary: get operationId: getUsingGET_9 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - objective-cycles-resource summary: delete operationId: deleteUsingDELETE_9 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/objective-cycles/{cycleId}/archive: put: tags: - objective-cycles-resource summary: archive operationId: archiveUsingPUT_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/bulk-inform: post: tags: - objective-cycles-resource summary: bulkNotify operationId: bulkNotifyUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: target in: query description: target required: false schema: type: string requestBody: $ref: '#/components/requestBodies/editFeedbackCycleAdminsUsingPOSTUserids' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/cycle-admins: post: tags: - objective-cycle-admin-resource summary: editObjectiveCycleAdmins operationId: editObjectiveCycleAdminsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/editFeedbackCycleAdminsUsingPOSTUserids' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/cycle-admins/{userId}: put: tags: - objective-cycle-admin-resource summary: addCycleAdmin operationId: addCycleAdminUsingPUT_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - objective-cycle-admin-resource summary: removeCycleAdmin operationId: removeCycleAdminUsingDELETE_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/objective-cycles/{cycleId}/export/lazy/{exportType}/{outputType}: post: tags: - objective-cycles-export-resource summary: lazyExportFeedback operationId: lazyExportFeedbackUsingPOST_1 parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/export/xml: get: tags: - objective-cycles-export-resource summary: generateXML operationId: generateXMLUsingGET_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/export/{exportType}/columns: get: tags: - objective-cycles-export-resource summary: availableColumns operationId: availableColumnsUsingGET_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string enum: - ByObjective - ByUser responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AvailableColumn' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/export/{exportType}/{outputType}: get: tags: - objective-cycles-export-resource summary: exportObjectives operationId: exportObjectivesUsingGET parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string enum: - ByObjective - ByUser - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/export_xml/lazy: post: tags: - objective-cycles-export-resource summary: lazyGenerateXML operationId: lazyGenerateXMLUsingPOST_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/nudge-user: post: tags: - objective-cycles-resource summary: nudgeUser operationId: nudgeUserUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: query description: userId required: false schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives: get: tags: - objectives-resource summary: list operationId: listUsingGET_4 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: query description: userId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/BrowserView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - objectives-resource summary: createObjective operationId: createObjectiveUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveDTO' description: dto required: true responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/changeWeightings: post: tags: - objectives-resource summary: bulkChangeWeighting operationId: bulkChangeWeightingUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: integer format: int32 description: weightingByObjectiveId required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/view: get: tags: - objectives-resource summary: listView operationId: listViewUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: query description: userId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/{id}: get: tags: - objectives-resource summary: get operationId: getUsingGET_12 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - objectives-resource summary: editObjective operationId: editObjectiveUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectiveDTO' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - objectives-resource summary: delete operationId: deleteUsingDELETE_10 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/objective-cycles/{cycleId}/objectives/{id}/changeCompletionPercentage: post: tags: - objectives-resource summary: changeCompletionPercentage operationId: changeCompletionPercentageUsingPOST parameters: - name: completionPercentage in: query description: completionPercentage required: false schema: type: integer format: int32 - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/{id}/changeCycle: post: tags: - objectives-resource summary: changeCycle operationId: changeCycleUsingPOST parameters: - name: copy in: query description: copy required: false schema: type: boolean - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string - name: newCycleId in: query description: newCycleId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/{id}/changeRating: post: tags: - objectives-resource summary: changeRating operationId: changeRatingUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string - name: rating in: query description: rating required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/{id}/changeStatus: post: tags: - objectives-resource summary: changeStatus operationId: changeStatusUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string - name: status in: query description: status required: false schema: type: integer format: int32 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/{id}/messages: post: tags: - objectives-resource summary: createMessage operationId: createMessageUsingPOST_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/MiniCommentView' responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CommentView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/objectives/{id}/nudge: post: tags: - objectives-resource summary: nudge operationId: nudgeUsingPOST_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/permissions: post: tags: - objective-cycles-resource summary: addRestriction operationId: addRestrictionUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/editFeedbackCycleAdminsUsingPOSTUserids' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - objective-cycles-resource summary: setRestriction operationId: setRestrictionUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string description: userIds required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/permissions/{userId}: delete: tags: - objective-cycles-resource summary: deleteRestriction operationId: deleteRestrictionUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/objective-cycles/{cycleId}/summaries: get: tags: - objective-summaries-resource summary: getDto operationId: getDtoUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: filterMode in: query description: filterMode required: false schema: type: integer format: int32 default: 0 - name: managerId in: query description: managerId required: false schema: type: string - name: onlyDirectReports in: query description: onlyDirectReports required: false schema: type: boolean default: false responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveSummaryDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/summaries/{summaryId}: get: tags: - objective-summaries-resource summary: getDto operationId: getDtoUsingGET_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: summaryId in: path description: summaryId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveSummaryDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/summaries/{summaryId}/nudge: post: tags: - objective-summaries-resource summary: nudge operationId: nudgeUsingPOST_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: summaryId in: path description: summaryId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-cycles/{cycleId}/unarchive: put: tags: - objective-cycles-resource summary: unarchive operationId: unarchiveUsingPUT_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-preview/{id}: get: tags: - objectives-resource summary: get operationId: getUsingGET_11 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectivePreviewDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective-ratings: get: tags: - objective-ratings-resource summary: get operationId: getUsingGET_10 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveRating' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - objective-ratings-resource summary: put operationId: putUsingPUT_2 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ObjectiveRating' description: objectiveRatings required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObjectiveRating' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objective/{id}: get: tags: - objectives-resource summary: getFromId operationId: getFromIdUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/comment-counts: post: tags: - objectives-resource summary: getCommentCounts operationId: getCommentCountsUsingPOST requestBody: content: application/json;charset=UTF-8: schema: type: array items: type: string description: objectiveIds required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/CommentCountView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/preview/{id}: get: tags: - objectives-resource summary: getPreview operationId: getPreviewUsingGET_3 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectivePreviewWithStatus' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{cycleId}/{userId}/getPdf: get: tags: - objective-pdf-resource summary: getFile operationId: getFileUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{id}/activities: get: tags: - objectives-resource summary: activities operationId: activitiesUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AuditRecordMiniDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{id}/clone: post: tags: - objective-clone-resource summary: get operationId: getUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/editFeedbackCycleAdminsUsingPOSTUserids' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{id}/messages: get: tags: - objectives-resource summary: getComments operationId: getCommentsUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/CommentView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - objectives-resource summary: createMessageWithoutCycleId operationId: createMessageWithoutCycleIdUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/MiniCommentView' responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CommentView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{id}/messages/{messageId}: put: tags: - objectives-resource summary: editComment operationId: editCommentUsingPUT parameters: - name: id in: path description: id required: true schema: type: string - name: messageId in: path description: messageId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectiveCommentEditTextDTO' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CommentView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - objectives-resource summary: updateVisibleToPermissions operationId: updateVisibleToPermissionsUsingDELETE parameters: - name: id in: path description: id required: true schema: type: string - name: messageId in: path description: messageId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/objectives/{id}/messages/{messageId}/downvote: post: tags: - objectives-resource summary: downvote operationId: downvoteUsingPOST_1 parameters: - name: id in: path description: id required: true schema: type: string - name: messageId in: path description: messageId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CommentView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{id}/messages/{messageId}/upvote: post: tags: - objectives-resource summary: upvote operationId: upvoteUsingPOST_1 parameters: - name: id in: path description: id required: true schema: type: string - name: messageId in: path description: messageId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CommentView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/objectives/{id}/messages/{messageId}/visibleTo: put: tags: - objectives-resource summary: updateVisibleToPermissions operationId: updateVisibleToPermissionsUsingPUT_1 parameters: - name: id in: path description: id required: true schema: type: string - name: messageId in: path description: messageId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UserIdHolderArray' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CommentView' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/outlook/oauth/authorize: get: tags: - outlook-o-auth-resource summary: authorizeAdmin operationId: authorizeAdminUsingGET responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RedirectView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/outlook/oauth/callback: get: tags: - outlook-o-auth-resource summary: adminConsentCallback operationId: adminConsentCallbackUsingGET parameters: - name: error in: query description: error required: false schema: type: string - name: error_description in: query description: error_description required: false schema: type: string - name: state in: query description: state required: false schema: type: string - name: tenant in: query description: tenant required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RedirectView' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/personal-access-token: get: tags: - personal-access-token-resource summary: getTokens operationId: getTokensUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/PersonalAccessTokenDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - personal-access-token-resource summary: createToken operationId: createTokenUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PersonalAccessTokenRequest' description: request required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PersonalAccessTokenDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - personal-access-token-resource summary: revokeAllTokens operationId: revokeAllTokensUsingDELETE responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/personal-access-token/{tokenId}: delete: tags: - personal-access-token-resource summary: revokeToken operationId: revokeTokenUsingDELETE parameters: - name: tokenId in: path description: tokenId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/praise: get: tags: - praise-resource summary: getPraiseList operationId: getPraiseListUsingGET parameters: - name: authorId in: query required: false schema: type: string - name: endDate in: query required: false schema: type: string format: date-time - name: limit in: query required: false schema: type: integer format: int32 - name: offset in: query required: false schema: type: integer format: int32 - name: recipientId in: query required: false schema: type: string - name: startDate in: query required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - praise-resource summary: createPraise operationId: createPraiseUsingPOST parameters: - name: source in: query description: source required: false schema: type: string enum: - GMAIL - HIPCHAT - SLACK - WEBAPP default: WEBAPP requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseCreateCommand' description: command required: true responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise-export: post: tags: - praise-resource summary: triggerExport operationId: triggerExportUsingPOST_1 parameters: - name: format in: query description: format required: true schema: type: string enum: - CSV - EXCEL - name: from in: query description: from required: true schema: type: string - name: until in: query description: until required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DownloadableFileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/preview/{id}: get: tags: - praise-resource summary: getPreview operationId: getPreviewUsingGET_4 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessagePreviewWithStatus' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/wall/config: get: tags: - praise-wall-resource summary: getConfig operationId: getConfigUsingGET_1 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallConfigDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - praise-wall-resource summary: saveConfig operationId: saveConfigUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallConfigDto' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallConfigDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/wall/custom-logo: post: tags: - praise-wall-resource summary: uploadCustomLogo operationId: uploadCustomLogoUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ImageData' description: customLogo required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ImageInfo' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/wall/token: get: tags: - praise-wall-resource summary: getWallToken operationId: getWallTokenUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallTokenDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/wall/token/activate: patch: tags: - praise-wall-resource summary: activate operationId: activateUsingPATCH parameters: - name: active in: query description: active required: false schema: type: boolean default: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallTokenDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/praise/wall/token/refresh: post: tags: - praise-wall-resource summary: refreshWallToken operationId: refreshWallTokenUsingPOST responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/PraiseWallTokenDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/{praiseId}: get: tags: - praise-resource summary: getPraiseItem operationId: getPraiseItemUsingGET parameters: - name: praiseId in: path description: praiseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - praise-resource summary: editMessage operationId: editMessageUsingPUT_1 parameters: - name: praiseId in: path description: praiseId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PraiseEditCommand' description: command required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - praise-resource summary: delete operationId: deleteUsingDELETE_11 parameters: - name: praiseId in: path description: praiseId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/praise/{praiseId}/comments: get: tags: - praise-resource summary: getComments operationId: getCommentsUsingGET_1 parameters: - name: praiseId in: path description: praiseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - praise-resource summary: createComment operationId: createCommentUsingPOST parameters: - name: praiseId in: path description: praiseId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/MessageDTO' responses: '201': description: Created content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/{praiseId}/comments/{commentId}: put: tags: - praise-resource summary: updateComment operationId: updateCommentUsingPUT parameters: - name: commentId in: path description: commentId required: true schema: type: string - name: praiseId in: path description: praiseId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageDTO' description: comment required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - praise-resource summary: deleteComment operationId: deleteCommentUsingDELETE parameters: - name: commentId in: path description: commentId required: true schema: type: string - name: praiseId in: path description: praiseId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/praise/{praiseId}/downvote: put: tags: - praise-resource summary: downvote operationId: downvoteUsingPUT parameters: - name: praiseId in: path description: praiseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/praise/{praiseId}/upvote: put: tags: - praise-resource summary: upvote operationId: upvoteUsingPUT parameters: - name: praiseId in: path description: praiseId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/reaction: post: tags: - reaction-resource summary: create operationId: createUsingPOST_3 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReaction' description: request required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Reaction' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/reaction/{containerId}: get: tags: - reaction-resource summary: getByContainerId operationId: getByContainerIdUsingGET parameters: - name: containerId in: path description: containerId required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Reaction' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/reaction/{id}: post: tags: - reaction-resource summary: update operationId: updateUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReaction' description: newFeedback required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Reaction' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - reaction-resource summary: delete operationId: deleteUsingDELETE_12 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/release-notes: get: tags: - release-notes-resource summary: getLastUpdatedReleaseNotes operationId: getLastUpdatedReleaseNotesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string format: date-time '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - release-notes-resource summary: setLastUpdatedReleaseNotes operationId: setLastUpdatedReleaseNotesUsingPUT responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string format: date-time '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/replacements/customizations: get: tags: - replacements-resource summary: getCustomReplacements operationId: getCustomReplacementsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CustomizationsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - replacements-resource summary: putCustomReplacements operationId: putCustomReplacementsUsingPUT requestBody: $ref: '#/components/requestBodies/putCustomReplacementsUsingPUTReplacements' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/replacements/defaults: get: tags: - replacements-resource summary: getDefaultReplacements operationId: getDefaultReplacementsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/replacements/{companyId}/customizations: get: tags: - replacements-resource summary: getCustomReplacementsForCompany operationId: getCustomReplacementsForCompanyUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CustomizationsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - replacements-resource summary: putCustomReplacementsForCompany operationId: putCustomReplacementsForCompanyUsingPUT parameters: - name: companyId in: path description: companyId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/putCustomReplacementsUsingPUTReplacements' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/reports/{reportType}: get: tags: - report-resource summary: getReportSubscription operationId: getReportSubscriptionUsingGET parameters: - name: reportType in: path description: reportType required: true schema: type: string enum: - ADMIN_REPORT responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReportSubscription' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - report-resource summary: createReportSubscription operationId: createReportSubscriptionUsingPUT parameters: - name: reportType in: path description: reportType required: true schema: type: string enum: - ADMIN_REPORT requestBody: content: application/json;charset=UTF-8: schema: type: object description: configurationMap required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReportSubscription' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - report-resource summary: deleteReportSubscription operationId: deleteReportSubscriptionUsingDELETE parameters: - name: reportType in: path description: reportType required: true schema: type: string enum: - ADMIN_REPORT responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycle: get: tags: - review-cycle-resource summary: list operationId: listUsingGET_5 parameters: - name: contributingReviewerId in: query description: contributingReviewerId required: true schema: type: string - name: mainReviewerId in: query description: mainReviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewCycleListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - review-cycle-resource summary: create operationId: createUsingPOST_4 requestBody: $ref: '#/components/requestBodies/ReviewCycleCreateRequest' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycle' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycle/import: post: tags: - review-cycle-import-resource summary: importCycle operationId: importCycleUsingPOST requestBody: content: multipart/form-data: schema: type: object properties: targetCompany.id: type: string dateFormat: type: string hrUserTargetCompany.id: type: string csv: type: string format: binary cycleName: type: string columnMapping: type: array items: type: string enum: - COMPLETED - REVIEWEE_ANSWER - REVIEWEE_ANSWER_COMMENT - REVIEWEE_EMAIL - REVIEWEE_FIRST_NAME - REVIEWEE_LAST_EDITED - REVIEWEE_LAST_NAME - REVIEWEE_QUESTION - REVIEWEE_SHARED - REVIEWEE_SIGNED - REVIEWER_ANSWER - REVIEWER_ANSWER_COMMENT - REVIEWER_CONFIDENTIAL_QUESTION - REVIEWER_EMAIL - REVIEWER_LAST_EDITED - REVIEWER_QUESTION - REVIEWER_SHARED - REVIEWER_SIGNED - SKIP responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycle/{cycleId}/reviews-graph: get: tags: - review-graph-resource summary: getReviewsGraph operationId: getReviewsGraphUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: mainReviewerId in: query description: mainReviewerId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_ReviewGraphDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycle/{cycleKey}/reviewers: post: tags: - review-resource summary: bulkUpdateReviewers operationId: bulkUpdateReviewersUsingPOST parameters: - name: cycleKey in: path description: cycleKey required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewersBulkUpdateDto' description: reviewersBulkUpdate required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycle/{cycleKey}/timeline-extension: post: tags: - review-resource summary: bulkExtendTimeline operationId: bulkExtendTimelineUsingPOST parameters: - name: cycleKey in: path description: cycleKey required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/BulkTimelineExtensionDto' description: bulkTimelineExtensionDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles: get: tags: - review-cycles-resource summary: list operationId: listUsingGET_6 parameters: - name: onlyManageable in: query description: onlyManageable required: false schema: type: boolean responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewCycleListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles-all: get: tags: - review-cycles-resource summary: getAllCycles operationId: getAllCyclesUsingGET_1 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_ReviewCycleListDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/guided/edit: post: tags: - review-cycles-resource summary: editCycle operationId: editCycleUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleGuidedDto' description: reviewCycleGuidedDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/guided/{cycleId}: get: tags: - review-cycles-resource summary: getCycle operationId: getCycleUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleGuidedDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/guided/{cycleId}/copy: get: tags: - review-cycles-resource summary: getCycleForCopy operationId: getCycleForCopyUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleGuidedDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/statistics: get: tags: - review-statistics-resource summary: getCycleStatistics operationId: getCycleStatisticsUsingGET_3 parameters: - name: cycleIds in: query description: cycleIds required: true explode: true schema: type: array items: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewCycleStatsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}: get: tags: - review-cycles-resource summary: get operationId: getUsingGET_16 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - review-cycles-resource summary: delete operationId: deleteUsingDELETE_14 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycles/{cycleId}/archive: put: tags: - review-cycles-resource summary: archiveCycle operationId: archiveCycleUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/bulk_inform: post: tags: - review-cycles-resource summary: bulkNotify operationId: bulkNotifyUsingPOST_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: target in: query description: target required: false schema: type: string requestBody: $ref: '#/components/requestBodies/editFeedbackCycleAdminsUsingPOSTUserids' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/changeManagerRatings: put: tags: - reviews-resource summary: changeManagerRatings operationId: changeManagerRatingsUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: isSecondaryRating in: query description: isSecondaryRating required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: '#/components/schemas/ManagerRatingChanges' description: managerRatingChanges required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/complete_all: post: tags: - review-cycles-resource summary: completeOpenReviews operationId: completeOpenReviewsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/cycle-admins: post: tags: - review-cycle-admin-resource summary: editReviewCycleAdmins operationId: editReviewCycleAdminsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/Key_User_' description: userIds required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/cycle-admins/{userId}: put: tags: - review-cycle-admin-resource summary: addCycleAdmin operationId: addCycleAdminUsingPUT_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - review-cycle-admin-resource summary: removeCycleAdmin operationId: removeCycleAdminUsingDELETE_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycles/{cycleId}/export/lazy/{exportType}/{outputType}: get: tags: - review-export-resource summary: lazyExportReview operationId: lazyExportReviewUsingGET parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string - name: filters in: query description: filters required: true schema: type: string items: type: object additionalProperties: type: string - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - review-export-resource summary: lazyExportReview operationId: lazyExportReviewUsingPOST parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string - name: filters in: query description: filters required: true schema: type: string items: type: object additionalProperties: type: string - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/export/{exportType}/columns: get: tags: - review-export-resource summary: getAvailableColumns operationId: getAvailableColumnsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AvailableColumn' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/export/{exportType}/{outputType}: get: tags: - review-export-resource summary: exportReview operationId: exportReviewUsingGET parameters: - name: columns in: query description: columns required: true schema: type: string - name: cycleId in: path description: cycleId required: true schema: type: string - name: exportType in: path description: exportType required: true schema: type: string - name: outputType in: path description: outputType required: true schema: type: string enum: - CSV - EXCEL responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/review-cycles/{cycleId}/export_pdf: get: tags: - review-export-resource summary: exportPDF operationId: exportPDFUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/ReviewExportPdfOptions' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string enum: - NOTHING_TO_EXPORT - SUCCESS '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - review-export-resource summary: exportPDF operationId: exportPDFUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/ReviewExportPdfOptions' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: string enum: - NOTHING_TO_EXPORT - SUCCESS '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/export_xml: get: tags: - review-export-resource summary: generateXML operationId: generateXMLUsingGET_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/xml: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/export_xml/lazy: get: tags: - review-export-resource summary: lazyGenerateXML operationId: lazyGenerateXMLUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - review-export-resource summary: lazyGenerateXML operationId: lazyGenerateXMLUsingPOST_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/inform_all: post: tags: - review-cycles-resource summary: notifyAll operationId: notifyAllUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/nudge_all: post: tags: - review-cycles-resource summary: nudgeAll operationId: nudgeAllUsingPOST_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: filter in: query description: filter required: false schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews: get: tags: - reviews-resource summary: listAllReviews operationId: listAllReviewsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: ignoreCache in: query description: ignoreCache required: false schema: type: boolean - name: managerId in: query description: managerId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - reviews-resource summary: createReviews operationId: createReviewsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UserIdHolder' description: reviewees required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews/{reviewId}: get: tags: - reviews-resource summary: getReview operationId: getReviewUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - reviews-resource summary: delete operationId: deleteUsingDELETE_16 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycles/{cycleId}/reviews/{reviewId}/changeManagerRating: put: tags: - reviews-resource summary: changeManagerRating operationId: changeManagerRatingUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/ManagerRatingCode' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews/{reviewId}/changeSecondaryManagerRating: put: tags: - reviews-resource summary: changeSecondaryManagerRating operationId: changeSecondaryManagerRatingUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/ManagerRatingCode' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews/{reviewId}/completed: put: tags: - reviews-resource summary: complete operationId: completeUsingPUT_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - reviews-resource summary: reopen operationId: reopenUsingDELETE_1 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycles/{cycleId}/reviews/{reviewId}/cycle: put: tags: - reviews-resource summary: moveReviewToCycle operationId: moveReviewToCycleUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: newCycleId in: query description: newCycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews/{reviewId}/indicateManagerDone: put: tags: - reviews-resource summary: indicateManagerDone operationId: indicateManagerDoneUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews/{reviewId}/nudge: post: tags: - reviews-resource summary: nudge operationId: nudgeUsingPOST_3 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/reviews/{reviewId}/shared: put: tags: - reviews-resource summary: share operationId: shareUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - reviews-resource summary: hide operationId: hideUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycles/{cycleId}/reviews/{reviewId}/signed: put: tags: - reviews-resource summary: sign operationId: signUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - reviews-resource summary: revokeSignature operationId: revokeSignatureUsingDELETE parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: reviewId in: path description: reviewId required: true schema: type: string - name: target in: query description: target required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewListDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review-cycles/{cycleId}/share_all: post: tags: - review-cycles-resource summary: bulkShareAllReviews operationId: bulkShareAllReviewsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/share_all_managers: post: tags: - review-cycles-resource summary: bulkShareAllManagerReviews operationId: bulkShareAllManagerReviewsUsingPOST parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/statistics: get: tags: - review-statistics-resource summary: getCycleStatistics operationId: getCycleStatisticsUsingGET_2 parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleStatsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/trends: get: tags: - review-cycles-resource summary: getTrends operationId: getTrendsUsingGET parameters: - name: cycleId in: path description: cycleId required: true schema: type: string - name: days in: query description: days required: false schema: type: integer format: int32 default: -1 responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-cycles/{cycleId}/unarchive: put: tags: - review-cycles-resource summary: unarchiveCycle operationId: unarchiveCycleUsingPUT parameters: - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleListDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-questionnaire: get: tags: - review-questionnaire-resource summary: list operationId: listUsingGET_7 parameters: - name: includeArchived in: query description: includeArchived required: false schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DtoEntity_QuestionnaireDto_ReviewQuestionnaire_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - review-questionnaire-resource summary: create operationId: createUsingPOST_5 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/QuestionnaireDto' description: questionnaireDto required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DtoEntity_QuestionnaireDto_ReviewQuestionnaire_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review-questionnaire/{id}: get: tags: - review-questionnaire-resource summary: get operationId: getUsingGET_17 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DtoEntity_QuestionnaireDto_ReviewQuestionnaire_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - review-questionnaire-resource summary: update operationId: updateUsingPUT_1 parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QuestionnaireDto' description: questionnaireDto required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DtoEntity_QuestionnaireDto_ReviewQuestionnaire_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - review-questionnaire-resource summary: delete operationId: deleteUsingDELETE_15 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review/about/{id}: get: tags: - review-resource summary: getForReviewee operationId: getForRevieweeUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Stream_ReviewDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/forReviewee/{reviewee}: get: tags: - review-resource summary: getActiveReviewsForReviewee operationId: getActiveReviewsForRevieweeUsingGET parameters: - name: reviewee in: path description: reviewee required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewForRevieweeDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/preview/questionnaire: post: tags: - review-resource summary: getFakeReviewForPreviewQuestionnaire operationId: getFakeReviewForPreviewQuestionnaireUsingPOST requestBody: $ref: '#/components/requestBodies/ReviewCycleCreateRequest' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/preview/questionnaire/{cycleId}: get: tags: - review-resource summary: getFakeReviewForPreviewQuestionnaire operationId: getFakeReviewForPreviewQuestionnaireUsingGET parameters: - name: asReviewee in: query description: asReviewee required: false schema: type: boolean default: true - name: cycleId in: path description: cycleId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/yourReviews: get: tags: - review-resource summary: getYourReviews operationId: getYourReviewsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/YourCycleAndReviewsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}: get: tags: - review-resource summary: get operationId: getUsingGET_18 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}/answerAssessment/{assessmentId}: post: tags: - review-resource summary: answerAssessment operationId: answerAssessmentUsingPOST parameters: - name: assessmentId in: path description: assessmentId required: true schema: type: string - name: id in: path description: id required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AssessmentAnswerDto' description: answer required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}/attachment: post: tags: - review-attachment-resource summary: addAttachment operationId: addAttachmentUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/AttachmentCreateCommand' description: command required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}/attachment/{attachmentId}: get: tags: - review-attachment-resource summary: download operationId: downloadUsingGET_2 parameters: - name: attachmentId in: path description: attachmentId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - review-attachment-resource summary: delete operationId: deleteUsingDELETE_13 parameters: - name: attachmentId in: path description: attachmentId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/review/{id}/hide/{assessmentId}: post: tags: - review-resource summary: hideAssessment operationId: hideAssessmentUsingPOST parameters: - name: assessmentId in: path description: assessmentId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}/share/{assessmentId}: post: tags: - review-resource summary: shareAssessment operationId: shareAssessmentUsingPOST parameters: - name: assessmentId in: path description: assessmentId required: true schema: type: string - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}/sign: post: tags: - review-resource summary: sign operationId: signUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewSignDto' description: reviewSignDto responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{id}/timeline-extension: post: tags: - review-resource summary: extendTimeline operationId: extendTimelineUsingPOST parameters: - name: id in: path description: id required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/TimelineExtensionDto' description: timelineExtensionDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{reviewId}/contributing-reviewers: put: tags: - review-resource summary: updateContributingReviewers operationId: updateContributingReviewersUsingPUT parameters: - name: reviewId in: path description: reviewId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/updateContributingReviewersUsingPUTUpdatedcontributingreviewers' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{reviewId}/updateContributingReviewers: put: tags: - review-resource summary: updateContributingReviewersLegacy operationId: updateContributingReviewersLegacyUsingPUT parameters: - name: reviewId in: path description: reviewId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/updateContributingReviewersUsingPUTUpdatedcontributingreviewers' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/review/{reviewKey}/main-reviewer: put: tags: - review-resource summary: updateMainReviewer operationId: updateMainReviewerUsingPUT parameters: - name: reviewKey in: path description: reviewKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MainReviewerDto' description: mainReviewerDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/review/{reviewKey}/reviewers: put: tags: - review-resource summary: updateReviewers operationId: updateReviewersUsingPUT parameters: - name: reviewKey in: path description: reviewKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewersDto' description: reviewers required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found deprecated: true /v2/reviews/mini/relevant-for-user: get: tags: - reviews-resource summary: getRelevantForUserMini operationId: getRelevantForUserMiniUsingGET parameters: - name: endDate in: query description: endDate required: false schema: type: string format: date-time - name: startDate in: query description: startDate required: false schema: type: string format: date-time - name: userId in: query description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ReviewMini' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/reviews/mini/{reviewId}: get: tags: - reviews-resource summary: getReviewMini operationId: getReviewMiniUsingGET parameters: - name: reviewId in: path description: reviewId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewMini' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/reviews/reviewees/me: get: tags: - reviewees-resource summary: getCycleSpecificRevieweesInOngoingCyclesAsWicketUsers operationId: getCycleSpecificRevieweesInOngoingCyclesAsWicketUsersUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MiniUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/sample-content/config: get: tags: - sample-content-resource summary: getConfig operationId: getConfigUsingGET_2 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SampleContentManagementDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/sample-content/delete-all: post: tags: - sample-content-resource summary: deleteAllContentIncludingCycles operationId: deleteAllContentIncludingCyclesUsingPOST requestBody: $ref: '#/components/requestBodies/SampleContentManagementDto' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/sample-content/delete-sample-users: post: tags: - sample-content-resource summary: deleteSampleUsers operationId: deleteSampleUsersUsingPOST responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/sample-content/reset-trial: post: tags: - sample-content-resource summary: resetSampleContentAndUsers operationId: resetSampleContentAndUsersUsingPOST requestBody: $ref: '#/components/requestBodies/SampleContentManagementDto' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/slack-configurations: get: tags: - slack-configuration-resource summary: get operationId: getUsingGET_19 responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SlackConfigurationState' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - slack-configuration-resource summary: save operationId: saveUsingPOST_1 requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SlackConfigurationState' description: slackConfigurationState required: true responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - slack-configuration-resource summary: delete operationId: deleteUsingDELETE_17 responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/slack-configurations/access-slack: get: tags: - slack-configuration-resource summary: access operationId: accessUsingGET parameters: - name: code in: query description: code required: false schema: type: string - name: error in: query description: error required: false schema: type: string - name: state in: query description: state required: false schema: type: string responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/slack-configurations/authorize-si: get: tags: - slack-configuration-resource summary: authorize operationId: authorizeUsingGET responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/slack-configurations/channels: get: tags: - slack-configuration-resource summary: getChannels operationId: getChannelsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SlackChannelDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/slack-configurations/errors: delete: tags: - slack-configuration-resource summary: deleteLastApiError operationId: deleteLastApiErrorUsingDELETE responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/slack-configurations/status: get: tags: - slack-configuration-resource summary: checkIntegrationStatus operationId: checkIntegrationStatusUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SlackIntegrationStatusDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/summary-assistant: post: tags: - summary-assistant-resource summary: prompt operationId: promptUsingPOST requestBody: content: application/json: schema: $ref: '#/components/schemas/SummaryAssistantRequest' description: request required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SummaryResponse' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/summary-assistant/tokens: get: tags: - summary-assistant-resource summary: getAllowedRequests operationId: getAllowedRequestsUsingGET responses: '200': description: OK content: application/json: schema: type: integer format: int64 '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/summary-assistant/{id}: get: tags: - summary-assistant-resource summary: getKeyTakeaways operationId: getKeyTakeawaysUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SummaryResponse' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/survey-schedule: post: tags: - survey-observer-resource summary: calculateSurveySchedule operationId: calculateSurveyScheduleUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' description: surveyDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/GenericObject' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/survey-templates: get: tags: - survey-templates-resource summary: getSurveyTemplates operationId: getSurveyTemplatesUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SurveyTemplateDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys: get: tags: - survey-viewer-resource summary: getSurveys operationId: getSurveysUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SurveyDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - survey-admin-resource summary: createSurvey operationId: createSurveyUsingPOST requestBody: $ref: '#/components/requestBodies/SurveyDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys/{surveyId}: get: tags: - survey-viewer-resource summary: getSurvey operationId: getSurveyUsingGET_1 parameters: - name: surveyId in: path description: surveyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - survey-admin-resource summary: updateSurvey operationId: updateSurveyUsingPUT parameters: - name: surveyId in: path description: surveyId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/SurveyDto' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - survey-admin-resource summary: deleteSurvey operationId: deleteSurveyUsingDELETE parameters: - name: surveyId in: path description: surveyId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/surveys/{surveyId}/archive-status: put: tags: - survey-admin-resource summary: updateArchiveStatus operationId: updateArchiveStatusUsingPUT parameters: - name: surveyId in: path description: surveyId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveStatusDto' description: archiveStatusDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys/{surveyId}/dates: get: tags: - survey-analytics-resource summary: viewSurveyDates operationId: viewSurveyDatesUsingGET parameters: - name: surveyId in: path description: surveyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SurveyDatesDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys/{surveyId}/export: get: tags: - survey-admin-resource summary: getSurveyExport operationId: getSurveyExportUsingGET parameters: - name: format in: query description: format required: true schema: type: string enum: - CSV - EXCEL - name: from in: query description: from required: true schema: type: string - name: surveyId in: path description: surveyId required: true schema: type: string - name: to in: query description: to required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DownloadableFileDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys/{surveyId}/responses: get: tags: - survey-analytics-resource summary: viewSurveyResponses operationId: viewSurveyResponsesUsingGET parameters: - name: from in: query description: from required: true schema: type: string - name: grouping in: query description: grouping required: true schema: type: string enum: - DEPARTMENT - EMPLOYMENT_TYPE - GENDER - LOCATION - MANAGER - MANAGER_OR_IC - NONE - ROLE - TEAM - TENURE - name: surveyId in: path description: surveyId required: true schema: type: string - name: to in: query description: to required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyResponseAggregationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys/{surveyId}/stopped-status: put: tags: - survey-admin-resource summary: updateStoppedStatus operationId: updateStoppedStatusUsingPUT parameters: - name: surveyId in: path description: surveyId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StoppedStatusDto' description: stoppedStatusDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/surveys/{surveyId}/viewers: put: tags: - survey-admin-resource summary: updateViewers operationId: updateViewersUsingPUT parameters: - name: surveyId in: path description: surveyId required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Key_User_' description: viewers required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/unified-feedback/details-you-provided/{id}: get: tags: - unified-feedback-resource summary: getFeedbackDetailsYouProvided operationId: getFeedbackDetailsYouProvidedUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UnifiedFeedbackDetailsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/unified-feedback/details/{id}: get: tags: - unified-feedback-resource summary: getFeedback operationId: getFeedbackUsingGET_1 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UnifiedFeedbackDetailsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/unified-feedback/details/{id}/view-as/{view-as}: get: tags: - unified-feedback-resource summary: getFeedbackViewedAs operationId: getFeedbackViewedAsUsingGET parameters: - name: id in: path description: id required: true schema: type: string - name: view-as in: path description: view-as required: true schema: type: string enum: - DIRECT_MANAGER - HR - INDIRECT_MANAGER - REVIEWEE responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UnifiedFeedbackDetailsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/unified-feedback/someones/{revieweeId}: get: tags: - unified-feedback-resource summary: getSomeonesFeedback operationId: getSomeonesFeedbackUsingGET parameters: - name: from in: query description: from required: false schema: type: string format: date-time - name: revieweeId in: path description: revieweeId required: true schema: type: string - name: to in: query description: to required: false schema: type: string format: date-time responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UnifiedFeedbackDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/unified-feedback/you-provided: get: tags: - unified-feedback-resource summary: getFeedbackYouProvided operationId: getFeedbackYouProvidedUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UnifiedFeedbackDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/unified-feedback/your: get: tags: - unified-feedback-resource summary: getYourFeedback operationId: getYourFeedbackUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UnifiedFeedbackDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-calendar: get: tags: - calendar-resource summary: getUsersCalendar operationId: getUsersCalendarUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CalendarDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import-configurations/CSV: put: tags: - user-import-configuration-resource summary: updateCsv operationId: updateCsvUsingPUT requestBody: $ref: '#/components/requestBodies/UserImportConfigurationDTO' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import-configurations/GOOGLE_APPS: get: tags: - user-import-configuration-resource summary: getGoogleApps operationId: getGoogleAppsUsingGET parameters: - name: company in: query description: company required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserImportConfigurationDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - user-import-configuration-resource summary: updateGoogleApps operationId: updateGoogleAppsUsingPUT requestBody: $ref: '#/components/requestBodies/UserImportConfigurationDTO' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import-configurations/synchronization-intervals: get: tags: - user-import-configuration-resource summary: getSynchronizationIntervals operationId: getSynchronizationIntervalsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SynchronizationIntervalHolder' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import-configurations/{companyId}/{type}: put: tags: - user-import-configuration-resource summary: reset operationId: resetUsingPUT parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: type in: path description: type required: true schema: type: string enum: - BAMBOO - CSV - GOOGLE_APPS - NAMELY - PERSONIO - SAPLING responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserImportConfigurationDTO' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import-configurations/{type}: get: tags: - user-import-configuration-resource summary: get operationId: getUsingGET_21 parameters: - name: company in: query description: company required: false schema: type: string - name: type in: path description: type required: true schema: type: string enum: - BAMBOO - CSV - GOOGLE_APPS - NAMELY - PERSONIO - SAPLING responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserImportConfigurationDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - user-import-configuration-resource summary: update operationId: updateUsingPUT_2 requestBody: $ref: '#/components/requestBodies/UserImportConfigurationDTO' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/CSV: post: tags: - user-import-resource summary: importUsersCsv operationId: importUsersCsvUsingPOST parameters: - name: company in: query description: company required: false schema: type: string requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/GOOGLE_APPS: post: tags: - user-import-resource summary: importGoogleAppsUsers operationId: importGoogleAppsUsersUsingPOST requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/GOOGLE_APPS/preview: post: tags: - user-import-resource summary: createGoogleAppsPreview operationId: createGoogleAppsPreviewUsingPOST parameters: - name: company in: query description: company required: false schema: type: string requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/GOOGLE_APPS/preview/{id}: get: tags: - user-import-resource summary: getGoogleAppsPreview operationId: getGoogleAppsPreviewUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserImportPreview' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/GOOGLE_APPS/simulate: post: tags: - user-import-resource summary: simulateGoogleAppsImportUser operationId: simulateGoogleAppsImportUserUsingPOST parameters: - name: company in: query description: company required: false schema: type: string requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SimulationDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/GOOGLE_APPS/simulation/{id}: get: tags: - user-import-resource summary: getSimulationGoogleApps operationId: getSimulationGoogleAppsUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SimulationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/GOOGLE_APPS/simulations: get: tags: - user-import-resource summary: getSimulationOverviewListGoogleApps operationId: getSimulationOverviewListGoogleAppsUsingGET parameters: - name: company in: query description: company required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SimulationOverviewDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/{type}: post: tags: - user-import-resource summary: importUsers operationId: importUsersUsingPOST parameters: - name: type in: path description: type required: true schema: type: string enum: - BAMBOO - CSV - GOOGLE_APPS - NAMELY - PERSONIO - SAPLING requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/{type}/preview: post: tags: - user-import-resource summary: createPreview operationId: createPreviewUsingPOST parameters: - name: company in: query description: company required: false schema: type: string - name: type in: path description: type required: true schema: type: string enum: - BAMBOO - CSV - GOOGLE_APPS - NAMELY - PERSONIO - SAPLING requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/{type}/preview/{id}: get: tags: - user-import-resource summary: getPreview operationId: getPreviewUsingGET_5 parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserImportPreview' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/{type}/simulate: post: tags: - user-import-resource summary: simulateImportUser operationId: simulateImportUserUsingPOST parameters: - name: company in: query description: company required: false schema: type: string - name: type in: path description: type required: true schema: type: string enum: - BAMBOO - CSV - GOOGLE_APPS - NAMELY - PERSONIO - SAPLING requestBody: $ref: '#/components/requestBodies/importUsersCsvUsingPOSTData' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SimulationDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/{type}/simulation/{id}: get: tags: - user-import-resource summary: getSimulation operationId: getSimulationUsingGET parameters: - name: id in: path description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SimulationDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-import/{type}/simulations: get: tags: - user-import-resource summary: getSimulationOverviewList operationId: getSimulationOverviewListUsingGET parameters: - name: company in: query description: company required: false schema: type: string - name: type in: path description: type required: true schema: type: string enum: - BAMBOO - CSV - GOOGLE_APPS - NAMELY - PERSONIO - SAPLING responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/SimulationOverviewDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-settings: get: tags: - user-settings-resource summary: getUserSettings operationId: getUserSettingsUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserSettingsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - user-settings-resource summary: updateUserSettings operationId: updateUserSettingsUsingPOST requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserSettingsDto' description: updatedUserSettings required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserSettingsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-settings/checked-release-notes: post: tags: - user-settings-resource summary: setLastCheckedReleaseNotesDate operationId: setLastCheckedReleaseNotesDateUsingPOST responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserSettingsDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/user-stats: get: tags: - user-stats-resource summary: getStats operationId: getStatsUsingGET parameters: - name: companyId in: query description: companyId required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/CompanyUserStatsDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users: get: tags: - users-resource summary: listUsers operationId: listUsersUsingGET parameters: - name: includeGuests in: query description: includeGuests required: false schema: type: boolean - name: managerId in: query description: managerId required: false schema: type: string - name: showLocked in: query description: showLocked required: false schema: type: boolean responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_UserListDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users-for-company/{companyId}: get: tags: - users-resource summary: listUsers operationId: listUsersUsingGET_1 parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObserverUserDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users-for-company/{companyId}/medium: get: tags: - users-resource summary: listUsersMedium operationId: listUsersMediumUsingGET parameters: - name: companyId in: path description: companyId required: true schema: type: string - name: includeGuests in: query description: includeGuests required: false schema: type: boolean - name: showLocked in: query description: showLocked required: false schema: type: boolean responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users-for-company/{companyId}/medium/super-users: get: tags: - users-resource summary: listSuperUsersMedium operationId: listSuperUsersMediumUsingGET_1 parameters: - name: companyId in: path description: companyId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/by-ids: get: tags: - users-resource summary: getUsersById operationId: getUsersByIdUsingGET parameters: - name: ids in: query description: ids required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_UserProfileDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/export_csv: get: tags: - users-resource summary: generateCsvExport operationId: generateCsvExportUsingGET parameters: - name: isFullExport in: query description: isFullExport required: false schema: type: boolean default: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/export_excel: get: tags: - users-resource summary: generateExcelExport operationId: generateExcelExportUsingGET parameters: - name: isFullExport in: query description: isFullExport required: false schema: type: boolean default: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/hrs: get: tags: - users-resource summary: getHrs operationId: getHrsUsingGET parameters: - name: include-assistants in: query description: include-assistants required: true schema: type: boolean responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_UserListDto_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/invite: post: tags: - users-resource summary: inviteUsers operationId: inviteUsersUsingPOST parameters: - name: User-Agent in: header description: User-Agent required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UserInvitationDTOArray' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_UserListDto_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/invite-onboarding/: post: tags: - users-resource summary: inviteUsersInOnboarding operationId: inviteUsersInOnboardingUsingPOST requestBody: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UserOnboardingInvitationDTO' description: invitations required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_UserListDto_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/mail/new-reports: post: tags: - users-resource summary: batchSendManagerNewReportsMails operationId: batchSendManagerNewReportsMailsUsingPOST requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/mail/password-reset: post: tags: - users-resource summary: batchSendPasswordResetMails operationId: batchSendPasswordResetMailsUsingPOST requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/mail/profile-nudge: post: tags: - users-resource summary: batchSendProfileNudgeMails operationId: batchSendProfileNudgeMailsUsingPOST requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/mail/welcome: post: tags: - users-resource summary: batchSendWelcomeMails operationId: batchSendWelcomeMailsUsingPOST requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/mail/welcome-all: post: tags: - users-resource summary: sendWelcomeMailToAll operationId: sendWelcomeMailToAllUsingPOST responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/me: get: tags: - users-resource summary: getCurrentUser operationId: getCurrentUserUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CurrentUserDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium: get: tags: - users-resource summary: listUsersMedium operationId: listUsersMediumUsingGET_1 parameters: - name: includeGuests in: query description: includeGuests required: false schema: type: boolean - name: managerId in: query description: managerId required: false schema: type: string - name: showLocked in: query description: showLocked required: false schema: type: boolean responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/by-external-system-id/{externalSystemId}: get: tags: - users-resource summary: getMediumUserByExternalSystemId operationId: getMediumUserByExternalSystemIdUsingGET parameters: - name: externalSystemId in: path description: externalSystemId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/by-id: get: tags: - users-resource summary: getMediumUserById operationId: getMediumUserByIdUsingGET parameters: - name: id in: query description: id required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/by-ids: get: tags: - users-resource summary: getMediumUsersById operationId: getMediumUsersByIdUsingGET parameters: - name: ids in: query description: ids required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_MediumUser_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/by-login: get: tags: - users-resource summary: getMediumUserByLoginname operationId: getMediumUserByLoginnameUsingGET parameters: - name: loginname in: query description: loginname required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/by-logins: post: tags: - users-resource summary: getMediumUsersByLoginname operationId: getMediumUsersByLoginnameUsingPOST requestBody: content: application/json;charset=UTF-8: schema: type: array items: type: string description: loginnames required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MediumUser' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/invite: post: tags: - users-resource summary: inviteUsersMedium operationId: inviteUsersMediumUsingPOST requestBody: $ref: '#/components/requestBodies/UserInvitationDTOArray' responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MediumUser' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/medium/super-users: get: tags: - users-resource summary: listSuperUsersMedium operationId: listSuperUsersMediumUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/MediumUser' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/merge/{sourceId}/{destinationId}: post: tags: - user-merge-resource summary: mergeUsers operationId: mergeUsersUsingPOST parameters: - name: deleteSourceAfterMerge in: query description: deleteSourceAfterMerge required: false schema: type: boolean - name: destinationId in: path description: destinationId required: true schema: type: string - name: sourceId in: path description: sourceId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/relationship/{a}/{b}: get: tags: - users-resource summary: getRelationship operationId: getRelationshipUsingGET parameters: - name: a in: path description: a required: true schema: type: string - name: b in: path description: b required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserRelationship' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/roles/lock: post: tags: - users-change-resource summary: lockUsers operationId: lockUsersUsingPOST requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_string_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/roles/unlock: post: tags: - users-change-resource summary: unlockUsers operationId: unlockUsersUsingPOST requestBody: $ref: '#/components/requestBodies/bulkNudgeUsingPOSTIds' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_string_' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/search: get: tags: - users-resource summary: search operationId: searchUsingGET parameters: - name: email in: query description: email required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/ObserverUserDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/search-wicket: get: tags: - users-resource summary: searchForWicket operationId: searchForWicketUsingGET parameters: - name: companyId in: query description: companyId required: false schema: type: string - name: includeGuests in: query description: includeGuests required: false schema: type: boolean default: false - name: showDeactivated in: query description: showDeactivated required: false schema: type: boolean default: false - name: term in: query description: term required: false schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Iterable_WicketUser_' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}: get: tags: - users-resource summary: getUserById operationId: getUserByIdUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found put: tags: - users-change-resource summary: updateUser operationId: updateUserUsingPUT parameters: - name: Si-User-Password in: header description: Si-User-Password required: false schema: type: string - name: userId in: path description: userId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserUpdate' description: dto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - users-resource summary: delete operationId: deleteUsingDELETE_19 parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/users/{userId}/2fa: put: tags: - users-change-resource summary: setTwoFactorRequirement operationId: setTwoFactorRequirementUsingPUT parameters: - name: required in: query description: required required: false schema: type: boolean - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/attachments: post: tags: - user-attachment-resource summary: create operationId: createUsingPOST_6 parameters: - name: userId in: path description: userId required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateUserAttachmentDto' description: createUserAttachment required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/attachments/{attachmentId}: get: tags: - user-attachment-resource summary: download operationId: downloadUsingGET_3 parameters: - name: attachmentId in: path description: attachmentId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/Download' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found delete: tags: - user-attachment-resource summary: delete operationId: deleteUsingDELETE_18 parameters: - name: attachmentId in: path description: attachmentId required: true schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/users/{userId}/available-profile-pictures: get: tags: - profile-pictures-resource summary: getAvailableProfilePictures operationId: getAvailableProfilePicturesUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/badges: get: tags: - users-resource summary: badges operationId: badgesUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/BadgeDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/calendars: get: tags: - users-resource summary: getByUserId operationId: getByUserIdUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/CalendarDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/custom-profile-picture: post: tags: - profile-pictures-resource summary: setCustomProfilePicture operationId: setCustomProfilePictureUsingPOST parameters: - name: userId in: path description: userId required: true schema: type: string requestBody: $ref: '#/components/requestBodies/addImageUsingPOSTBody' responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/isLoggedIn: get: tags: - users-resource summary: isLoggedIn operationId: isLoggedInUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserSessionStatusDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/mail/password-reset: post: tags: - users-resource summary: sendPasswordResetMail operationId: sendPasswordResetMailUsingPOST parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/mail/profile-nudge: post: tags: - users-resource summary: sendProfileNudgeMail operationId: sendProfileNudgeMailUsingPOST parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/mail/welcome: post: tags: - users-resource summary: sendWelcomeMail operationId: sendWelcomeMailUsingPOST parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/manager: put: tags: - users-change-resource summary: setManager operationId: setManagerUsingPUT parameters: - name: managerId in: query description: managerId required: false schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/merge-stats: get: tags: - user-merge-resource summary: getUserMergeStats operationId: getUserMergeStatsUsingGET parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserStatsDTO' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userId}/password: delete: tags: - users-resource summary: clearPassword operationId: clearPasswordUsingDELETE parameters: - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK '204': description: No Content '401': description: Unauthorized '403': description: Forbidden /v2/users/{userId}/secondary-reviewer: put: tags: - users-change-resource summary: setSecondaryReviewer operationId: setSecondaryReviewerUsingPUT parameters: - name: secondaryReviewerId in: query description: secondaryReviewerId required: false schema: type: string - name: userId in: path description: userId required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/users/{userKey}/roles: put: tags: - users-change-resource summary: updateRoles operationId: updateRolesUsingPUT parameters: - name: userKey in: path description: userKey required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserRolesDto' description: userRoles required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/UserProfileDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/writing-assistant: post: tags: - writing-assistant-resource summary: prompt operationId: promptUsingPOST_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/WritingAssistantRequest' description: request required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PromptResponse' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/writing-assistant/tokens: get: tags: - writing-assistant-resource summary: getAllowedRequests operationId: getAllowedRequestsUsingGET_1 responses: '200': description: OK content: application/json: schema: type: integer format: int64 '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/your-surveys: get: tags: - your-surveys-resource summary: getYourSurveys operationId: getYourSurveysUsingGET responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YourSurveysDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/your-surveys/{surveyInstanceKey}: get: tags: - your-surveys-resource summary: getYourSurvey operationId: getYourSurveyUsingGET parameters: - name: surveyInstanceKey in: path description: surveyInstanceKey required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YourSurveyDto' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found post: tags: - your-surveys-resource summary: answerSurveyInstance operationId: answerSurveyInstanceUsingPOST parameters: - name: surveyInstanceKey in: path description: surveyInstanceKey required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyAnswersDto' description: surveyAnswerDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YourSurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found /v2/your-surveys/{surveyInstanceKey}/submission: put: tags: - your-surveys-resource summary: updateSurveySubmission operationId: updateSurveySubmissionUsingPUT parameters: - name: surveyInstanceKey in: path description: surveyInstanceKey required: true schema: type: string requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveySubmissionDto' description: surveySubmissionDto required: true responses: '200': description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YourSurveyDto' '201': description: Created '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found servers: - url: https://app.small-improvements.com/api description: Small Improvements API components: requestBodies: putCustomReplacementsUsingPUTReplacements: content: application/json: schema: type: object additionalProperties: type: string description: replacements required: true UserIdHolderArray: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserIdHolder' description: users required: true MiniCommentView: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MiniCommentView' description: dto required: true SurveyDto: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SurveyDto' description: surveyCreationDto required: true AnswerDtoArray: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AnswerDto' description: answerDto required: true AnswerDtoArray2: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/AnswerDto' description: answers required: true ManagerRatingCode: content: application/json: schema: $ref: '#/components/schemas/ManagerRatingCode' description: managerRatingCode required: true ObjectiveCycleGuidedDto: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ObjectiveCycleGuidedDto' description: objectiveCycleGuidedDto required: true ReviewCycleCreateRequest: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewCycleCreateRequest' description: reviewCycleCreateRequest required: true InsightsRequest: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/InsightsRequest' description: insightsRequest required: true updateContributingReviewersUsingPUTUpdatedcontributingreviewers: content: application/json: schema: type: array items: type: string description: updatedContributingReviewers required: true CreateAutomationRequest: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateAutomationRequest' description: request required: true addImageUsingPOSTBody: content: application/json;charset=UTF-8: schema: type: object additionalProperties: type: string description: body required: true FeedbackCycleGuidedDto: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/FeedbackCycleGuidedDto' description: feedbackCycleGuided required: true editFeedbackCycleAdminsUsingPOSTUserids: content: application/json;charset=UTF-8: schema: type: array items: type: string description: userIds required: true UserIdHolderArray2: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UserIdHolder' description: userIds required: true bulkNudgeUsingPOSTIds: content: application/json;charset=UTF-8: schema: type: array items: type: string description: ids required: true CreateFileAttachmentDto: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateFileAttachmentDto' description: attachmentDto required: true CreateLinkAttachmentDto: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/CreateLinkAttachmentDto' description: attachmentDto required: true MessageDTO: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MessageDTO' description: dto required: true ReviewExportPdfOptions: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ReviewExportPdfOptions' description: exportPdfOptions required: true SampleContentManagementDto: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/SampleContentManagementDto' description: sampleContentManagementDto required: true UserImportConfigurationDTO: content: application/json: schema: $ref: '#/components/schemas/UserImportConfigurationDTO' description: userImportConfigurationDTO required: true importUsersCsvUsingPOSTData: content: application/json;charset=UTF-8: schema: type: array items: type: string description: data UserInvitationDTOArray: content: application/json;charset=UTF-8: schema: type: array items: $ref: '#/components/schemas/UserInvitationDTO' description: invitations required: true schemas: ActionItemDTO: type: object title: ActionItemDTO AdminLink: type: object title: AdminLink AnswerDto: type: object title: AnswerDto AnytimeFeedbackDefaultDto: type: object title: AnytimeFeedbackDefaultDto AnytimeFeedbackRequestDto: type: object title: AnytimeFeedbackRequestDto AnytimeFeedbackResponseDto: type: object title: AnytimeFeedbackResponseDto AnytimeFeedbackStatsDto: type: object title: AnytimeFeedbackStatsDto ArchiveStatusDto: type: object title: ArchiveStatusDto Assessment: type: object title: Assessment AssessmentAnswerDto: type: object title: AssessmentAnswerDto AssessmentDto: type: object title: AssessmentDto AttachmentCreateCommand: type: object title: AttachmentCreateCommand AttachmentDto: type: object title: AttachmentDto AuditRecordDto: type: object title: AuditRecordDto AuditRecordMediumDto: type: object title: AuditRecordMediumDto AuditRecordMiniDto: type: object title: AuditRecordMiniDto AuditRecordQuery: type: object title: AuditRecordQuery AutomationDto: type: object title: AutomationDto AutomationsSettings: type: object title: AutomationsSettings AvailableColumn: type: object title: AvailableColumn BadgeDTO: type: object title: BadgeDTO BadgePrototypeDTO: type: object title: BadgePrototypeDTO BadgePrototypeOrder: type: object title: BadgePrototypeOrder BouncedEmail: type: object title: BouncedEmail BouncedEmailAggregate: type: object title: BouncedEmailAggregate BrowserView: type: object title: BrowserView BulkTimelineExtensionDto: type: object title: BulkTimelineExtensionDto CalendarConfigurationDto: type: object title: CalendarConfigurationDto CalendarDTO: type: object title: CalendarDTO CalendarEventDTO: type: object title: CalendarEventDTO CalendarEventDto: type: object title: CalendarEventDto CalendarSettingsDto: type: object title: CalendarSettingsDto CalendarSettingsUpdateRequest: type: object title: CalendarSettingsUpdateRequest CheckboxAnswerDto: title: CheckboxAnswerDto allOf: - $ref: '#/components/schemas/AnswerDto' - type: object title: CheckboxAnswerDto ClippyView: type: object title: ClippyView CommentCountView: type: object title: CommentCountView CommentView: type: object title: CommentView CompanyAnalyticsDto: type: object title: CompanyAnalyticsDto CompanyDateTimeSettingsDto: type: object title: CompanyDateTimeSettingsDto CompanyDesignSettings: type: object title: CompanyDesignSettings CompanyDesignSettingsDTO: type: object title: CompanyDesignSettingsDTO CompanyDetailsDto: type: object title: CompanyDetailsDto CompanyPaymentDto: type: object title: CompanyPaymentDto CompanyUserStatsDto: type: object title: CompanyUserStatsDto CreateAssessmentCommand: type: object title: CreateAssessmentCommand CreateAttachmentCommand: type: object title: CreateAttachmentCommand CreateAutomationRequest: type: object title: CreateAutomationRequest CreateFeedbackRequestsBulkResult: type: object title: CreateFeedbackRequestsBulkResult CreateFileAttachmentDto: type: object title: CreateFileAttachmentDto CreateLinkAttachmentDto: type: object title: CreateLinkAttachmentDto CreateMeetingRequest: type: object title: CreateMeetingRequest CreateNoteCommand: type: object title: CreateNoteCommand CreateOwnAssessmentCommand: type: object title: CreateOwnAssessmentCommand CreateReaction: type: object title: CreateReaction CreateTalkingPointCommand: type: object title: CreateTalkingPointCommand CreateTalkingPointCommandList: type: object title: CreateTalkingPointCommandList CreateUserAttachmentDto: type: object title: CreateUserAttachmentDto CurrentUserDto: type: object title: CurrentUserDto CustomizationsDto: type: object title: CustomizationsDto CycleDTO: type: object title: CycleDTO CycleFeedbackResponseDto: type: object title: CycleFeedbackResponseDto Download: type: object title: Download DownloadableFileDto: type: object title: DownloadableFileDto Draft: type: object title: Draft DraftDto: type: object title: DraftDto DropdownAnswerDto: title: DropdownAnswerDto allOf: - $ref: '#/components/schemas/AnswerDto' - type: object title: DropdownAnswerDto EditNoteCommand: type: object title: EditNoteCommand EditPositionCommand: type: object title: EditPositionCommand EditTalkingPointCommand: type: object title: EditTalkingPointCommand EmailConfigurationDto: type: object title: EmailConfigurationDto EmailEventResult: type: object title: EmailEventResult EmailTemplateDto: type: object title: EmailTemplateDto EmailTemplateMiniDto: type: object title: EmailTemplateMiniDto EmailTemplateModificationInfo: type: object title: EmailTemplateModificationInfo EmailTemplatePreview: type: object title: EmailTemplatePreview Event: type: object title: Event ExportPdfOptions: type: object title: ExportPdfOptions FeedbackCycleGuidedDto: type: object title: FeedbackCycleGuidedDto FeedbackCycleListDto: type: object title: FeedbackCycleListDto FeedbackCycleStatisticsDto: type: object title: FeedbackCycleStatisticsDto FeedbackDto: type: object title: FeedbackDto FeedbackParticipantListDto: type: object title: FeedbackParticipantListDto FeedbackParticipantMini: type: object title: FeedbackParticipantMini FeedbackParticipantProvideDto: type: object title: FeedbackParticipantProvideDto FeedbackParticipationByUserDto: type: object title: FeedbackParticipationByUserDto FeedbackReasonDto: type: object title: FeedbackReasonDto FeedbackRequestDto: type: object title: FeedbackRequestDto FeedbackRequestRating: type: object title: FeedbackRequestRating FeedbackTemplateDto: type: object title: FeedbackTemplateDto FeedbackTemplateOrderDto: type: object title: FeedbackTemplateOrderDto FreeTextAnswerDto: title: FreeTextAnswerDto allOf: - $ref: '#/components/schemas/AnswerDto' - type: object title: FreeTextAnswerDto ImageData: type: object title: ImageData ImageInfo: type: object title: ImageInfo InsightsDto: type: object title: InsightsDto InsightsRequest: type: object title: InsightsRequest IsVerified: type: object title: IsVerified LeaveProbabilityDto: type: object title: LeaveProbabilityDto LikertScaleRatingAnswerDto: title: LikertScaleRatingAnswerDto allOf: - $ref: '#/components/schemas/AnswerDto' - type: object title: LikertScaleRatingAnswerDto MainReviewerDto: type: object title: MainReviewerDto ManagerRatingChanges: type: object title: ManagerRatingChanges ManagerRatingCode: type: object title: ManagerRatingCode MeResponse: type: object title: MeResponse MediumUser: type: object title: MediumUser MeetingActionCreate: type: object title: MeetingActionCreate MeetingActionDto: type: object title: MeetingActionDto MeetingActionUpdate: type: object title: MeetingActionUpdate MeetingCalendarConfiguration: type: object title: MeetingCalendarConfiguration MeetingCompanyVisibilitySettingsDto: type: object title: MeetingCompanyVisibilitySettingsDto MeetingDto: type: object title: MeetingDto MeetingFromTemplateRequest: type: object title: MeetingFromTemplateRequest MeetingMetadataDto: type: object title: MeetingMetadataDto MeetingNoteDto: type: object title: MeetingNoteDto MeetingPatchRequest: type: object title: MeetingPatchRequest MeetingRelevantDto: type: object title: MeetingRelevantDto MeetingSpaceDto: type: object title: MeetingSpaceDto MeetingSpaceMiniDto: type: object title: MeetingSpaceMiniDto MeetingSpaceNudgeRequest: type: object title: MeetingSpaceNudgeRequest MeetingSpaceNudgesRecordDto: type: object title: MeetingSpaceNudgesRecordDto MeetingSpacesSharedCount: type: object title: MeetingSpacesSharedCount MeetingTemplateDetails: type: object title: MeetingTemplateDetails MeetingTemplateDto: type: object title: MeetingTemplateDto MeetingTemplateUsageRequest: type: object title: MeetingTemplateUsageRequest MergeCompanyDto: type: object title: MergeCompanyDto MessageDTO: type: object title: MessageDTO MessageDto: type: object title: MessageDto MessagePreviewWithStatus: type: object title: MessagePreviewWithStatus MessageRelevantView: type: object title: MessageRelevantView MessageSettingsDto: type: object title: MessageSettingsDto MiniBadge: type: object title: MiniBadge MiniBadgePrototype: type: object title: MiniBadgePrototype MiniCommentView: type: object title: MiniCommentView MiniFeedbackRequest: type: object title: MiniFeedbackRequest MiniUser: type: object title: MiniUser NewUnsolicitedFeedbackDto: type: object title: NewUnsolicitedFeedbackDto NotificationLogCountDto: type: object title: NotificationLogCountDto NotificationLogDto: type: object title: NotificationLogDto NudgeRequests: type: object title: NudgeRequests ObjectiveCategory: type: object title: ObjectiveCategory ObjectiveCommentEditTextDTO: type: object title: ObjectiveCommentEditTextDTO ObjectiveCycleDto: type: object title: ObjectiveCycleDto ObjectiveCycleGuidedDto: type: object title: ObjectiveCycleGuidedDto ObjectiveDTO: type: object title: ObjectiveDTO ObjectivePreviewDTO: type: object title: ObjectivePreviewDTO ObjectivePreviewWithStatus: type: object title: ObjectivePreviewWithStatus ObjectiveRating: type: object title: ObjectiveRating ObjectiveSummaryDto: type: object title: ObjectiveSummaryDto ObjectiveView: type: object title: ObjectiveView ObserverUserDto: type: object title: ObserverUserDto OptionsDto: type: object title: OptionsDto PersonalAccessTokenDto: type: object title: PersonalAccessTokenDto PersonalAccessTokenRequest: type: object title: PersonalAccessTokenRequest PraiseCreateCommand: type: object title: PraiseCreateCommand PraiseDto: type: object title: PraiseDto PraiseEditCommand: type: object title: PraiseEditCommand PraiseWallConfigDto: type: object title: PraiseWallConfigDto PraiseWallTokenDto: type: object title: PraiseWallTokenDto PromptResponse: type: object title: PromptResponse QuestionnaireDto: type: object title: QuestionnaireDto Reaction: type: object title: Reaction RedirectView: type: object title: RedirectView ReportSubscription: type: object title: ReportSubscription RequestFeedbackSummary: type: object title: RequestFeedbackSummary RetentionAnalyticsSettingsDto: type: object title: RetentionAnalyticsSettingsDto ReviewCycle: type: object title: ReviewCycle ReviewCycleCreateRequest: type: object title: ReviewCycleCreateRequest ReviewCycleDto: type: object title: ReviewCycleDto ReviewCycleGuidedDto: type: object title: ReviewCycleGuidedDto ReviewCycleListDto: type: object title: ReviewCycleListDto ReviewCycleStatsDto: type: object title: ReviewCycleStatsDto ReviewDto: type: object title: ReviewDto ReviewExportPdfOptions: type: object title: ReviewExportPdfOptions ReviewForRevieweeDto: type: object title: ReviewForRevieweeDto ReviewGraphDto: type: object title: ReviewGraphDto ReviewListDto: type: object title: ReviewListDto ReviewMini: type: object title: ReviewMini ReviewQuestionnaire: type: object title: ReviewQuestionnaire ReviewSignDto: type: object title: ReviewSignDto ReviewersBulkUpdateDto: type: object title: ReviewersBulkUpdateDto ReviewersDto: type: object title: ReviewersDto SampleContentManagementDto: type: object title: SampleContentManagementDto SettingDto: type: object title: SettingDto SimulationDto: type: object title: SimulationDto SimulationOverviewDto: type: object title: SimulationOverviewDto SlackChannelDto: type: object title: SlackChannelDto SlackConfigurationState: type: object title: SlackConfigurationState SlackIntegrationStatusDto: type: object title: SlackIntegrationStatusDto SliderAnswerDto: title: SliderAnswerDto allOf: - $ref: '#/components/schemas/AnswerDto' - type: object title: SliderAnswerDto StoppedStatusDto: type: object title: StoppedStatusDto SummaryAssistantRequest: type: object title: SummaryAssistantRequest SummaryResponse: type: object title: SummaryResponse SurveyAnswersDto: type: object title: SurveyAnswersDto SurveyDatesDto: type: object title: SurveyDatesDto SurveyDto: type: object title: SurveyDto SurveyResponseAggregationDto: type: object title: SurveyResponseAggregationDto SurveySubmissionDto: type: object title: SurveySubmissionDto SurveyTemplateDto: type: object title: SurveyTemplateDto SynchronizationIntervalHolder: type: object title: SynchronizationIntervalHolder TalkingPointDto: type: object title: TalkingPointDto TimelineExtensionDto: type: object title: TimelineExtensionDto UnifiedFeedbackDetailsDto: type: object title: UnifiedFeedbackDetailsDto UnifiedFeedbackDto: type: object title: UnifiedFeedbackDto UpdateMeetingCalendarConfigurationRequest: type: object title: UpdateMeetingCalendarConfigurationRequest User: type: object title: User UserIdHolder: type: object title: UserIdHolder UserImportConfigurationDTO: type: object title: UserImportConfigurationDTO UserImportPreview: type: object title: UserImportPreview UserInvitationDTO: type: object title: UserInvitationDTO UserListDto: type: object title: UserListDto UserMessageStatisticsDto: type: object title: UserMessageStatisticsDto UserOnboardingInvitationDTO: type: object title: UserOnboardingInvitationDTO UserProfileDto: type: object title: UserProfileDto UserRelationship: type: object title: UserRelationship UserRolesDto: type: object title: UserRolesDto UserSessionStatusDTO: type: object title: UserSessionStatusDTO UserSettingsDto: type: object title: UserSettingsDto UserStatsDTO: type: object title: UserStatsDTO UserUpdate: type: object title: UserUpdate VerificationAttempt: type: object title: VerificationAttempt ViewersDto: type: object title: ViewersDto WicketUser: type: object title: WicketUser WritingAssistantRequest: type: object title: WritingAssistantRequest YourCycleAndReviewsDto: type: object title: YourCycleAndReviewsDto YourSurveyDto: type: object title: YourSurveyDto YourSurveysDto: type: object title: YourSurveysDto GenericObject: type: object description: Generic object type CursorResultList_AuditRecordMediumDto_: type: object title: CursorResultList«AuditRecordMediumDto» DtoEntity_QuestionnaireDto_ReviewQuestionnaire_: type: object title: DtoEntity«QuestionnaireDto,ReviewQuestionnaire» Iterable_ActionItemDTO_: type: object title: Iterable«ActionItemDTO» Iterable_AdminLink_: type: object title: Iterable«AdminLink» Iterable_CalendarEventDTO_: type: object title: Iterable«CalendarEventDTO» Iterable_CycleDTO_: type: object title: Iterable«CycleDTO» Iterable_DownloadableFileDto_: type: object title: Iterable«DownloadableFileDto» Iterable_Event_: type: object title: Iterable«Event» Iterable_Map_string_object_: type: object title: Iterable«Map«string,object»» Iterable_MediumUser_: type: object title: Iterable«MediumUser» Iterable_MiniBadgePrototype_: type: object title: Iterable«MiniBadgePrototype» Iterable_MiniBadge_: type: object title: Iterable«MiniBadge» Iterable_PraiseDto_: type: object title: Iterable«PraiseDto» Iterable_ReviewCycleListDto_: type: object title: Iterable«ReviewCycleListDto» Iterable_ReviewGraphDto_: type: object title: Iterable«ReviewGraphDto» Iterable_SettingDto_: type: object title: Iterable«SettingDto» Iterable_UserListDto_: type: object title: Iterable«UserListDto» Iterable_UserMessageStatisticsDto_: type: object title: Iterable«UserMessageStatisticsDto» Iterable_UserProfileDto_: type: object title: Iterable«UserProfileDto» Iterable_WicketUser_: type: object title: Iterable«WicketUser» Iterable_string_: type: object title: Iterable«string» Key_User_: type: object title: Key«User» Stream_ReviewDto_: type: object title: Stream«ReviewDto» securitySchemes: BearerAuth: type: http scheme: bearer description: Personal access token generated from user profile settings security: - BearerAuth: []