# Models ## The ErrorMessage object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ErrorMessage":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"customMessage":{"type":"string"}}}}}} ``` ## The MultiValueMap object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MultiValueMap":{"type":"object","additionalProperties":{"type":"array","items":{}},"properties":{"all":{"type":"object","additionalProperties":{},"writeOnly":true},"empty":{"type":"boolean"}}}}}} ``` ## The Employee object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Employee":{"type":"object","description":"The details of the employee you want to invite to Happyforce","properties":{"name":{"type":"string","description":"Name of the employee"},"email":{"type":"string","description":"Email of the employee"},"externalId":{"type":"string","description":"External id of the employee"},"hierarchyId":{"type":"string","description":"Area id where this employee belongs"},"profile":{"type":"array","description":"Employee profile data, used for later segmentation","items":{"$ref":"#/components/schemas/EmployeeProfile"},"uniqueItems":true},"groupIds":{"type":"array","description":"List of groups to which this user belongs","items":{"type":"string"},"uniqueItems":true},"role":{"type":"string","description":"Role of the employee in the company","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managedHierarchies":{"type":"array","description":"List of hierarchies that this employee manages","items":{"type":"string"},"uniqueItems":true}}},"EmployeeProfile":{"type":"object","description":"Entity representing the profile of one of your employees","properties":{"id":{"type":"string","description":"Id of the segmentation property"},"date":{"type":"string","format":"date-time","description":"Date for date type segments"},"valueId":{"type":"string","description":"Value id, for list type segments"}}}}}} ``` ## The EmployeeProfile object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeProfile":{"type":"object","description":"Entity representing the profile of one of your employees","properties":{"id":{"type":"string","description":"Id of the segmentation property"},"date":{"type":"string","format":"date-time","description":"Date for date type segments"},"valueId":{"type":"string","description":"Value id, for list type segments"}}}}}} ``` ## The ExternalAuthRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ExternalAuthRequestDTO":{"type":"object","properties":{"params":{"type":"object","additionalProperties":{"type":"string"}}}}}}} ``` ## The ExternalAuthResponseDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ExternalAuthResponseDTO":{"type":"object","properties":{"redirectURI":{"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["SUCCESS","FAILURE","SUCCESS_REDIRECT"]}}}}}} ``` ## The PeriodTimeSheetType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]}}}} ``` ## The TimesheetUpdateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetUpdateRequestDTO":{"type":"object","description":"Timesheet update data","properties":{"startTime":{"type":"string","format":"date-time","description":"Start date and time of the work period in UTC"},"endTime":{"type":"string","format":"date-time","description":"End date and time of the work period in UTC"},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Type of period: ACTIVE, VACATION, BANK_HOLIDAY, SICK_LEAVE, or DAY_OFF"},"changeReason":{"type":"string","description":"Reason for updating this timesheet record","minLength":1},"timeZone":{"type":"string","description":"IANA timezone ID for this update (e.g. Europe/Madrid). Stored on the timesheet document; start/end times above are still stored as UTC.","minLength":1}},"required":["changeReason","timeZone"]},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]}}}} ``` ## The PersonTimesheetBreakDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}}}}} ``` ## The PersonTimesheetChangeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonTimesheetChangeDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType"},"changeReason":{"type":"string"},"changedBy":{"type":"string"},"changedAt":{"type":"string","format":"date-time"}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]}}}} ``` ## The PersonTimesheetDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonTimesheetDTO":{"type":"object","description":"DTO representing a person's timesheet entry","properties":{"id":{"type":"string","description":"Timesheet entry ID"},"personId":{"type":"string","description":"Person ID"},"startTime":{"type":"string","format":"date-time","description":"Start time of the timesheet entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the timesheet entry"},"isActive":{"type":"boolean","description":"Whether the timesheet entry is currently active"},"isEditable":{"type":"boolean","description":"Whether the timesheet entry can be edited"},"breaks":{"type":"array","description":"List of break times during this timesheet entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Type of timesheet period"},"timeZone":{"type":"string","description":"IANA timezone ID stored for this entry when provided by the client"},"changeHistory":{"type":"array","description":"Historical modifications applied to this timesheet entry","items":{"$ref":"#/components/schemas/PersonTimesheetChangeDTO"}}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"PersonTimesheetChangeDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType"},"changeReason":{"type":"string"},"changedBy":{"type":"string"},"changedAt":{"type":"string","format":"date-time"}}}}}} ``` ## The ConversationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationDTO":{"allOf":[{"$ref":"#/components/schemas/ConversationHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"name":{"type":"string"},"commentId":{"type":"string"},"updated":{"type":"boolean"},"updatedOn":{"type":"string","format":"date-time"},"title":{"type":"string","deprecated":true},"hierarchyName":{"type":"string","deprecated":true},"imagePath":{"type":"string"},"owned":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"messages":{"type":"array","description":"Messages in this conversation","items":{"$ref":"#/components/schemas/ConversationMessageDTO"}}}}],"description":"Full conversation: header fields plus list of messages."},"ConversationHeaderDTO":{"type":"object","description":"Conversation header: id, type, name, comment id, updated, dates, owner, signature, and messages.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"name":{"type":"string"},"commentId":{"type":"string"},"updated":{"type":"boolean"},"updatedOn":{"type":"string","format":"date-time"},"title":{"type":"string","deprecated":true},"hierarchyName":{"type":"string","deprecated":true},"imagePath":{"type":"string"},"owned":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ConversationMessageDTO"}}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"ConversationMessageDTO":{"type":"object","description":"Single message in a conversation: date, text, user type, seen, owned, anonymous, signature.","properties":{"date":{"type":"string","format":"date-time","description":"Message date and time"},"message":{"type":"string","description":"Message text"},"userType":{"$ref":"#/components/schemas/UserType","description":"Type of user who sent the message"},"seen":{"type":"boolean","description":"Whether the message has been seen"},"owned":{"type":"boolean","description":"Whether the message is from the current user"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature when not anonymous"},"anonymous":{"type":"boolean"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The ConversationHeaderDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationHeaderDTO":{"type":"object","description":"Conversation header: id, type, name, comment id, updated, dates, owner, signature, and messages.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"name":{"type":"string"},"commentId":{"type":"string"},"updated":{"type":"boolean"},"updatedOn":{"type":"string","format":"date-time"},"title":{"type":"string","deprecated":true},"hierarchyName":{"type":"string","deprecated":true},"imagePath":{"type":"string"},"owned":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ConversationMessageDTO"}}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"ConversationMessageDTO":{"type":"object","description":"Single message in a conversation: date, text, user type, seen, owned, anonymous, signature.","properties":{"date":{"type":"string","format":"date-time","description":"Message date and time"},"message":{"type":"string","description":"Message text"},"userType":{"$ref":"#/components/schemas/UserType","description":"Type of user who sent the message"},"seen":{"type":"boolean","description":"Whether the message has been seen"},"owned":{"type":"boolean","description":"Whether the message is from the current user"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature when not anonymous"},"anonymous":{"type":"boolean"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The ConversationMessageDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationMessageDTO":{"type":"object","description":"Single message in a conversation: date, text, user type, seen, owned, anonymous, signature.","properties":{"date":{"type":"string","format":"date-time","description":"Message date and time"},"message":{"type":"string","description":"Message text"},"userType":{"$ref":"#/components/schemas/UserType","description":"Type of user who sent the message"},"seen":{"type":"boolean","description":"Whether the message has been seen"},"owned":{"type":"boolean","description":"Whether the message is from the current user"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature when not anonymous"},"anonymous":{"type":"boolean"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}}}}} ``` ## The SignatureDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}}}}} ``` ## The UserType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The UserNotificationSetting object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}}} ``` ## The UserSelfProfileUpdateDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserSelfProfileUpdateDTO":{"type":"object","properties":{"name":{"type":"string"},"password":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}}} ``` ## The LoginResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"LoginResponse":{"type":"object","properties":{"sessionId":{"type":"string"},"companyUser":{"$ref":"#/components/schemas/UserDTO"}}},"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}}} ``` ## The UserDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}}} ``` ## The CharacteristicType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The EmployeeCharacteristicValueBase object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The EmployeeCharacteristicValueBoolean object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The EmployeeCharacteristicValueDate object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The EmployeeCharacteristicValueList object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The UserComparisonFilterDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserComparisonFilterDTO":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The CompanyTermsAndConditionsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyTermsAndConditionsDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"detail":{"$ref":"#/components/schemas/MultiLanguage"},"content":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/TermsAndConditionsStatus"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"TermsAndConditionsStatus":{"type":"string","description":"Status of terms and conditions (ACTIVE or ARCHIVED)","enum":["ACTIVE","ARCHIVED"]}}}} ``` ## The MultiLanguage object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The TermsAndConditionsStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TermsAndConditionsStatus":{"type":"string","description":"Status of terms and conditions (ACTIVE or ARCHIVED)","enum":["ACTIVE","ARCHIVED"]}}}} ``` ## The AbstractSurveyQuestion object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The ActivationCalendarRule object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The ActivationRecurrentRule object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The ActivationRule object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The ActivationRuleType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The ActivationSingleRule object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The ContinuousActivationRule object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The OpenSurveyQuestion object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The OptionsSurveyQuestion object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The QuestionType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]}}}} ``` ## The QuestionValue object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The QuestionVoteMode object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]}}}} ``` ## The ScaleSurveyQuestion object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The SurveyBlockDTOAbstractSurveyQuestion object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyBlockDTOAbstractSurveyQuestion":{"type":"object","description":"A survey block containing a list of questions","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}}} ``` ## The SurveyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyDTO":{"type":"object","description":"The details of the survey to be created","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"managerAccessEnabled":{"type":"boolean"},"notAnonymous":{"type":"boolean"},"canUpdate":{"type":"boolean"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"schedulePlan":{"$ref":"#/components/schemas/SurveySchedulePlanDTO"},"rounds":{"type":"array","items":{"$ref":"#/components/schemas/SurveyRoundDTO"}},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockDTOAbstractSurveyQuestion"},"minItems":1},"status":{"$ref":"#/components/schemas/SurveyStatus"},"hasReports":{"type":"boolean"}},"required":["blocks","title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveySchedulePlanDTO":{"type":"object","description":"The details of the schedule to be updated","properties":{"roundTitle":{"$ref":"#/components/schemas/MultiLanguage"},"appSurvey":{"type":"boolean"},"mailSurvey":{"type":"boolean"},"communicationTitle":{"$ref":"#/components/schemas/MultiLanguage"},"communicationDescription":{"$ref":"#/components/schemas/MultiLanguage"},"activationRule":{"$ref":"#/components/schemas/ActivationRule"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"paused":{"type":"boolean"},"archived":{"type":"boolean"},"mandatory":{"type":"boolean"},"status":{"$ref":"#/components/schemas/SurveyStatus"}},"required":["activationRule"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SurveyStatus":{"type":"string","description":"Status of a survey or questionnaire","enum":["PAUSED","EXPIRED","FUTURE","NOW","ARCHIVED","DRAFT"]},"SurveyRoundDTO":{"type":"object","description":"Survey Round Data Transfer Object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"SurveyBlockDTOAbstractSurveyQuestion":{"type":"object","description":"A survey block containing a list of questions","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}}}},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}}} ``` ## The SurveyRoundDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyRoundDTO":{"type":"object","description":"Survey Round Data Transfer Object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The SurveySchedulePlanDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveySchedulePlanDTO":{"type":"object","description":"The details of the schedule to be updated","properties":{"roundTitle":{"$ref":"#/components/schemas/MultiLanguage"},"appSurvey":{"type":"boolean"},"mailSurvey":{"type":"boolean"},"communicationTitle":{"$ref":"#/components/schemas/MultiLanguage"},"communicationDescription":{"$ref":"#/components/schemas/MultiLanguage"},"activationRule":{"$ref":"#/components/schemas/ActivationRule"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"paused":{"type":"boolean"},"archived":{"type":"boolean"},"mandatory":{"type":"boolean"},"status":{"$ref":"#/components/schemas/SurveyStatus"}},"required":["activationRule"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SurveyStatus":{"type":"string","description":"Status of a survey or questionnaire","enum":["PAUSED","EXPIRED","FUTURE","NOW","ARCHIVED","DRAFT"]}}}} ``` ## The SurveyStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyStatus":{"type":"string","description":"Status of a survey or questionnaire","enum":["PAUSED","EXPIRED","FUTURE","NOW","ARCHIVED","DRAFT"]}}}} ``` ## The ShiftUpdateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ShiftUpdateRequestDTO":{"type":"object","description":"Shift update data","properties":{"startTime":{"type":"string","description":"Start time of the shift"},"endTime":{"type":"string","description":"End time of the shift"},"weekDays":{"type":"array","description":"Days of the week when the shift applies. Values: 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday","items":{"type":"integer","format":"int32"}}}}}}} ``` ## The ScoreDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The ScoreFactorDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The ScoreQuestionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The ScoreStatuses object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]}}}} ``` ## The QuestionActivationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionActivationDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}}} ``` ## The QuestionActivationRuleDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionActivationRuleDTO":{"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"cronExpression":{"type":"string"},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]}}}} ``` ## The QuestionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionDTO":{"type":"object","description":"The details of the question to be created","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"primary":{"type":"boolean"},"createdOn":{"type":"string","format":"date-time"},"activationDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"resultValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"notifyByPush":{"type":"boolean"},"notifyByMail":{"type":"boolean"},"notified":{"type":"boolean"},"privated":{"type":"boolean"},"nonAnonymous":{"type":"boolean"},"requireNotEmpty":{"type":"boolean","deprecated":true},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"feedbackEnabled":{"type":"boolean"},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/QuestionStatus"},"activationRule":{"$ref":"#/components/schemas/QuestionActivationRuleDTO"},"activations":{"type":"array","items":{"$ref":"#/components/schemas/QuestionActivationDTO"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionStatus":{"type":"string","description":"Status of a question in a survey or questionnaire","enum":["ANY","ACTIVE","PENDING","EXPIRED","PAUSED","ARCHIVED"]},"QuestionActivationRuleDTO":{"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"cronExpression":{"type":"string"},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]},"QuestionActivationDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}}} ``` ## The QuestionStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionStatus":{"type":"string","description":"Status of a question in a survey or questionnaire","enum":["ANY","ACTIVE","PENDING","EXPIRED","PAUSED","ARCHIVED"]}}}} ``` ## The PersonDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"hierarchyId":{"type":"string"},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"type":"string","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}}} ``` ## The MilestoneDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MilestoneDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"hierarchyId":{"type":"string"},"createdBy":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/MilestoneType"},"is_private":{"type":"boolean"}}},"MilestoneType":{"type":"string","description":"Types of milestone","enum":["OTHER","ANNOUNCEMENT","TOPIC"]}}}} ``` ## The MilestoneType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MilestoneType":{"type":"string","description":"Types of milestone","enum":["OTHER","ANNOUNCEMENT","TOPIC"]}}}} ``` ## The CompanyHierarchyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyHierarchyDTO":{"type":"object","properties":{"id":{"type":"string"},"parentId":{"type":"string"},"name":{"type":"string"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CompanyHierarchyDTO"}},"siloId":{"type":"string"},"expectedEmployees":{"type":"integer","format":"int32"},"activeEmployees":{"type":"integer","format":"int32"}}}}}} ``` ## The HierarchySiloDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HierarchySiloDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"startHierarchyId":{"type":"string"},"overrideName":{"type":"string"},"siloedStats":{"type":"boolean"},"siloedComments":{"type":"boolean"},"name":{"type":"string"},"createdOn":{"type":"string","format":"date-time"}}}}}} ``` ## The AbstractFeedbackContainerDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractFeedbackContainerDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updateOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"draft":{"type":"boolean"},"archived":{"type":"boolean"},"type":{"$ref":"#/components/schemas/FeedbackContainerType"},"status":{"$ref":"#/components/schemas/FeedbackContainerStatus"},"numComments":{"type":"integer","format":"int32"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"FeedbackContainerStatus":{"type":"string","enum":["ONGOING","EXPIRED","SCHEDULED","ARCHIVED","DRAFT"]}}}} ``` ## The FeedbackContainerStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackContainerStatus":{"type":"string","enum":["ONGOING","EXPIRED","SCHEDULED","ARCHIVED","DRAFT"]}}}} ``` ## The FeedbackContainerType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]}}}} ``` ## The FeedbackIdeaInitiativeContainerDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackIdeaInitiativeContainerDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractFeedbackContainerDTO"},{"type":"object","properties":{"description":{"$ref":"#/components/schemas/MultiLanguage"},"owner":{"type":"string"},"sendNotification":{"type":"boolean"},"nonAnonymous":{"type":"boolean"}}},{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IdeaInitiativeContainerStatus","description":"Current status: ONGOING or NEAR_END"},"description":{"type":"string","description":"Description of the idea/initiative"},"owner":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature (owner) of the container"},"nonAnonymous":{"type":"boolean","description":"Whether the container allows non-anonymous participation"}}}]},"AbstractFeedbackContainerDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updateOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"draft":{"type":"boolean"},"archived":{"type":"boolean"},"type":{"$ref":"#/components/schemas/FeedbackContainerType"},"status":{"$ref":"#/components/schemas/FeedbackContainerStatus"},"numComments":{"type":"integer","format":"int32"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"FeedbackContainerStatus":{"type":"string","enum":["ONGOING","EXPIRED","SCHEDULED","ARCHIVED","DRAFT"]},"IdeaInitiativeContainerStatus":{"type":"string","description":"Status of the idea/initiative container: ONGOING, NEAR_END","enum":["ONGOING","NEAR_END"]},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}}}}} ``` ## The FeedbackStatusPhase object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackStatusPhase":{"type":"string","description":"FeedbackStatusPhase.","enum":["NO_PHASE","ONGOING","DISCARDED","ACCEPTED"]}}}} ``` ## The FeedbackStatusType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackStatusType":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"createdBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"phase":{"$ref":"#/components/schemas/FeedbackStatusPhase"},"archived":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowDislike":{"type":"boolean"},"allowLike":{"type":"boolean"},"notifyOnChange":{"type":"boolean"}},"required":["companyId","description","feedbackType","label","phase"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackStatusPhase":{"type":"string","description":"FeedbackStatusPhase.","enum":["NO_PHASE","ONGOING","DISCARDED","ACCEPTED"]}}}} ``` ## The FeedbackType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The CompanyCommentInappropriateRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCommentInappropriateRequest":{"type":"object","properties":{"reason":{"type":"string"},"reasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriate":{"type":"boolean"},"referee":{"type":"boolean"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]}}}} ``` ## The InappropriateReasonType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]}}}} ``` ## The AnnouncementFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]}}}} ``` ## The Cluster object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}}}}} ``` ## The CommentAttachmentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}}}}} ``` ## The CommentContainerDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The CommentRefereed object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}}}}} ``` ## The CommentRefereedDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}}}}} ``` ## The CommentReplyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}}}}} ``` ## The CommentStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}}}}} ``` ## The CommentTopic object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}}}}} ``` ## The EmployeeInnappropiateFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]}}}} ``` ## The EmployeeSentiment object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}}}}} ``` ## The HR\_POSSITIVENES\_CLASSIFICATION object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]}}}} ``` ## The InappropriateSourceType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]}}}} ``` ## The StandardCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The EmployeeGroupDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeGroupDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"employeeCount":{"type":"integer","format":"int64"},"groupFlags":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeGroupFlag"},"uniqueItems":true},"exitPolicies":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeGroupExitPolicy"}},"allowedHierarchies":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"EmployeeGroupFlag":{"type":"string","description":"Employee group flag","enum":["NO_PRIMARY_VOTE","ONLY_GROUP_QUESTIONS_VOTE"]},"EmployeeGroupExitPolicy":{"type":"object","properties":{"policyType":{"$ref":"#/components/schemas/EmployeeGroupExitPolicyType"},"exitAction":{"$ref":"#/components/schemas/EmployeeGroupExitAction"},"days":{"type":"integer","format":"int32"}},"required":["exitAction","policyType"]},"EmployeeGroupExitPolicyType":{"type":"string","description":"Employee group exit policy type","enum":["NONE","ALL_QUESTIONS","ELAPSED_DAYS"]},"EmployeeGroupExitAction":{"type":"object","properties":{"actionType":{"$ref":"#/components/schemas/EmployeeGroupExitActionType"},"targetGroup":{"type":"string"}}},"EmployeeGroupExitActionType":{"type":"string","description":"Employee group exit action types","enum":["REMOVE_GROUP","DELETE_EMPLOYEE","MOVE_TO_GROUP","NONE"]}}}} ``` ## The EmployeeGroupExitAction object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeGroupExitAction":{"type":"object","properties":{"actionType":{"$ref":"#/components/schemas/EmployeeGroupExitActionType"},"targetGroup":{"type":"string"}}},"EmployeeGroupExitActionType":{"type":"string","description":"Employee group exit action types","enum":["REMOVE_GROUP","DELETE_EMPLOYEE","MOVE_TO_GROUP","NONE"]}}}} ``` ## The EmployeeGroupExitActionType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeGroupExitActionType":{"type":"string","description":"Employee group exit action types","enum":["REMOVE_GROUP","DELETE_EMPLOYEE","MOVE_TO_GROUP","NONE"]}}}} ``` ## The EmployeeGroupExitPolicy object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeGroupExitPolicy":{"type":"object","properties":{"policyType":{"$ref":"#/components/schemas/EmployeeGroupExitPolicyType"},"exitAction":{"$ref":"#/components/schemas/EmployeeGroupExitAction"},"days":{"type":"integer","format":"int32"}},"required":["exitAction","policyType"]},"EmployeeGroupExitPolicyType":{"type":"string","description":"Employee group exit policy type","enum":["NONE","ALL_QUESTIONS","ELAPSED_DAYS"]},"EmployeeGroupExitAction":{"type":"object","properties":{"actionType":{"$ref":"#/components/schemas/EmployeeGroupExitActionType"},"targetGroup":{"type":"string"}}},"EmployeeGroupExitActionType":{"type":"string","description":"Employee group exit action types","enum":["REMOVE_GROUP","DELETE_EMPLOYEE","MOVE_TO_GROUP","NONE"]}}}} ``` ## The EmployeeGroupExitPolicyType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeGroupExitPolicyType":{"type":"string","description":"Employee group exit policy type","enum":["NONE","ALL_QUESTIONS","ELAPSED_DAYS"]}}}} ``` ## The EmployeeGroupFlag object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeGroupFlag":{"type":"string","description":"Employee group flag","enum":["NO_PRIMARY_VOTE","ONLY_GROUP_QUESTIONS_VOTE"]}}}} ``` ## The CompanyCultureValueUpdateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCultureValueUpdateRequestDTO":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"customIconContent":{"type":"string"},"iconURL":{"type":"string"},"archived":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The CompanyCultureValueDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCultureValueDTO":{"type":"object","properties":{"id":{"type":"string"},"coreId":{"type":"string"},"companyId":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"iconURL":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"archived":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The BaseCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The ClassificationFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The CommentTargetDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The ENPSFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The EmployeeClassificationType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]}}}} ``` ## The FeedbackTargetType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The QuestionFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The RecognitionCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The RecognitionValueDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The ScoreFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The SomethingIsWrongCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The SurveyFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The CompanySegmentDateRangeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentDateRangeDTO":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"integer","format":"int32"},"fromType":{"$ref":"#/components/schemas/DateGroupingTypes"},"to":{"type":"integer","format":"int32"},"toType":{"$ref":"#/components/schemas/DateGroupingTypes"},"name":{"type":"string"},"employeeCount":{"type":"integer","format":"int32"}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]}}}} ``` ## The CompanySegmentListItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentListItemDTO":{"type":"object","properties":{"id":{"type":"string"},"value":{"$ref":"#/components/schemas/MultiLanguage"},"position":{"type":"integer","format":"int32"},"employeeCount":{"type":"integer","format":"int32"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The DateGroupingTypes object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]}}}} ``` ## The SegmentBaseDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SegmentBaseDTO":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/SegmentListDTO","DATE":"#/components/schemas/SegmentDateDTO"}},"properties":{"id":{"type":"string"},"description":{"type":"string"},"question":{"$ref":"#/components/schemas/MultiLanguage"},"privated":{"type":"boolean"},"isCore":{"type":"boolean"},"employeeCount":{"type":"integer","format":"int32"},"core":{"type":"boolean"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["description","questionType"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The SegmentDateDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SegmentDateDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/SegmentBaseDTO"},{"type":"object","properties":{"ranges":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentDateRangeDTO"},"uniqueItems":true},"deletedRanges":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentDateRangeDTO"},"uniqueItems":true}}}],"description":"Date-based company segment implementation","required":["questionType"]},"SegmentBaseDTO":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/SegmentListDTO","DATE":"#/components/schemas/SegmentDateDTO"}},"properties":{"id":{"type":"string"},"description":{"type":"string"},"question":{"$ref":"#/components/schemas/MultiLanguage"},"privated":{"type":"boolean"},"isCore":{"type":"boolean"},"employeeCount":{"type":"integer","format":"int32"},"core":{"type":"boolean"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["description","questionType"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"CompanySegmentDateRangeDTO":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"integer","format":"int32"},"fromType":{"$ref":"#/components/schemas/DateGroupingTypes"},"to":{"type":"integer","format":"int32"},"toType":{"$ref":"#/components/schemas/DateGroupingTypes"},"name":{"type":"string"},"employeeCount":{"type":"integer","format":"int32"}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]}}}} ``` ## The SegmentListDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SegmentListDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/SegmentBaseDTO"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentListItemDTO"}},"deletedValues":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentListItemDTO"}}}}],"description":"List-based company segment implementation","required":["questionType"]},"SegmentBaseDTO":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/SegmentListDTO","DATE":"#/components/schemas/SegmentDateDTO"}},"properties":{"id":{"type":"string"},"description":{"type":"string"},"question":{"$ref":"#/components/schemas/MultiLanguage"},"privated":{"type":"boolean"},"isCore":{"type":"boolean"},"employeeCount":{"type":"integer","format":"int32"},"core":{"type":"boolean"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["description","questionType"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"CompanySegmentListItemDTO":{"type":"object","properties":{"id":{"type":"string"},"value":{"$ref":"#/components/schemas/MultiLanguage"},"position":{"type":"integer","format":"int32"},"employeeCount":{"type":"integer","format":"int32"}}}}}} ``` ## The AbstractAnnouncementCreateUpdateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractAnnouncementCreateUpdateRequestDTO":{"type":"object","discriminator":{"propertyName":"sectionId"},"properties":{"sectionId":{"type":"string"}}}}}} ``` ## The LifeEventAnnouncementCreateUpdateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"LifeEventAnnouncementCreateUpdateRequestDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractAnnouncementCreateUpdateRequestDTO"},{"type":"object","properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"}}}]},"AbstractAnnouncementCreateUpdateRequestDTO":{"type":"object","discriminator":{"propertyName":"sectionId"},"properties":{"sectionId":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementExternalDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}}} ``` ## The CompanyFile object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}}} ``` ## The AnnouncementCommentReplySectionConfig object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementCommentReplySectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"searchEnabled":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementDefaultSectionConfig object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementDefaultSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"searchEnabled":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementLifeEventsSectionConfig object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementLifeEventsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"eventTypeConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeTemplateConfiguration"}}}}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"searchEnabled":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"EventTypeTemplateConfiguration":{"type":"object","properties":{"eventType":{"type":"string","enum":["BIRTH_ANNIVERSARY","BIRTHDAY","WORK_ANNIVERSARY","START_DATE"]},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"enabled":{"type":"boolean"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}}}}} ``` ## The AnnouncementSectionConfigBase object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"searchEnabled":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementUnreadSectionConfig object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementUnreadSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"elapsedDaysLessThan":{"type":"integer","format":"int32"}}}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"searchEnabled":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementsConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementsConfigurationDTO":{"type":"object","description":"Wrapper DTO for sending and receiving the list of announcement section configurations","properties":{"sections":{"description":"List of section configuration elements","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentReplySectionConfig"},{"$ref":"#/components/schemas/AnnouncementDefaultSectionConfig"},{"$ref":"#/components/schemas/AnnouncementLifeEventsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementUnreadSectionConfig"}]}},"required":["sections"]},"AnnouncementCommentReplySectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"searchEnabled":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"AnnouncementDefaultSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementLifeEventsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"eventTypeConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeTemplateConfiguration"}}}}],"required":["title"]},"EventTypeTemplateConfiguration":{"type":"object","properties":{"eventType":{"type":"string","enum":["BIRTH_ANNIVERSARY","BIRTHDAY","WORK_ANNIVERSARY","START_DATE"]},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"enabled":{"type":"boolean"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}},"AnnouncementUnreadSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"elapsedDaysLessThan":{"type":"integer","format":"int32"}}}],"required":["title"]}}}} ``` ## The EventTypeTemplateConfiguration object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EventTypeTemplateConfiguration":{"type":"object","properties":{"eventType":{"type":"string","enum":["BIRTH_ANNIVERSARY","BIRTHDAY","WORK_ANNIVERSARY","START_DATE"]},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"enabled":{"type":"boolean"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementCategoryDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}}}}} ``` ## The SurveyBlock object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyBlock":{"type":"object","properties":{"id":{"type":"string"},"order":{"type":"integer","format":"int32"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"minItems":1}},"required":["questions","title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}}} ``` ## The SurveyTemplateDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyTemplateDTO":{"type":"object","properties":{"id":{"type":"string"},"categoryId":{"type":"string"},"active":{"type":"boolean"},"restrictedToCompanies":{"type":"array","items":{"type":"string"},"uniqueItems":true},"restrictedToIndustries":{"type":"array","items":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"catalogTitle":{"$ref":"#/components/schemas/MultiLanguage"},"catalogDescription":{"$ref":"#/components/schemas/MultiLanguage"},"imagePath":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlock"}},"usedIn":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveyBlock":{"type":"object","properties":{"id":{"type":"string"},"order":{"type":"integer","format":"int32"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"minItems":1}},"required":["questions","title"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}}} ``` ## The SurveyTemplateCategoryDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyTemplateCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"color":{"type":"string"},"iconPath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The EmployeeVote object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeVote":{"type":"object","properties":{"questionId":{"type":"string"},"selectedValue":{"type":"integer","format":"int32"},"selectedValues":{"type":"array","items":{"type":"integer","format":"int32"},"uniqueItems":true},"message":{"type":"string"},"date":{"type":"string","format":"date-time"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"additionalFields":{"type":"object","additionalProperties":{}},"privated":{"type":"boolean"},"notAnonymous":{"type":"boolean"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The ExtraContentType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ExtraContentType":{"type":"string","description":"Type of extra content (quote, birthday, work anniversary, etc.)","enum":["HAS_QUOTE","HAS_BIRTHDAY","HAS_WORK_ANNIVERSARY","cookie","NONE","VOTE_STORE"]}}}} ``` ## The VoteResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"VoteResult":{"type":"object","description":"Result of a vote: extra content to show after voting (e.g. quote, celebration).","properties":{"afterVote":{"$ref":"#/components/schemas/ExtraContentType","description":"Type of extra content to display after the vote"}}},"ExtraContentType":{"type":"string","description":"Type of extra content (quote, birthday, work anniversary, etc.)","enum":["HAS_QUOTE","HAS_BIRTHDAY","HAS_WORK_ANNIVERSARY","cookie","NONE","VOTE_STORE"]}}}} ``` ## The FeedbackVerificationResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackVerificationResultDTO":{"type":"object","description":"Result of feedback verification/moderation: result type, moderation action, and optional message/suggestion.","properties":{"result":{"$ref":"#/components/schemas/VerificationResultType","description":"Verification result"},"moderationType":{"$ref":"#/components/schemas/ModerationType","description":"Moderation type applied"},"message":{"type":"string","description":"Optional message (e.g. reason for block)"},"suggestion":{"type":"string","description":"Optional suggestion for the user (e.g. when moderation type is SUGGESTION)"}}},"VerificationResultType":{"type":"string","description":"Verification outcome: VALID, INPROPER_IMAGE, INPROPER_TEXT, OTHER","enum":["VALID","INPROPER_IMAGE","INPROPER_TEXT","OTHER"]},"ModerationType":{"type":"string","description":"Moderation action: SUGGESTION (suggest change) or BLOCK","enum":["SUGGESTION","BLOCK"]}}}} ``` ## The ModerationType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ModerationType":{"type":"string","description":"Moderation action: SUGGESTION (suggest change) or BLOCK","enum":["SUGGESTION","BLOCK"]}}}} ``` ## The VerificationResultType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"VerificationResultType":{"type":"string","description":"Verification outcome: VALID, INPROPER_IMAGE, INPROPER_TEXT, OTHER","enum":["VALID","INPROPER_IMAGE","INPROPER_TEXT","OTHER"]}}}} ``` ## The EmployeeMailUnsubscribeRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeMailUnsubscribeRequest":{"type":"object","properties":{"token":{"type":"string"},"comment":{"type":"string"}}}}}} ``` ## The TimesheetDateTimeRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetDateTimeRequestDTO":{"type":"object","description":"Request body for timesheet start/end/break operations with a single date-time in ISO-8601 format","properties":{"dateTime":{"type":"string","description":"Date and time in ISO-8601 format (e.g. 2024-01-15T09:00:00Z)"},"timeZone":{"type":"string","description":"IANA timezone ID for this operation (e.g. Europe/Madrid). Stored on the timesheet document; dateTime is still interpreted as a UTC instant.","minLength":1}},"required":["dateTime","timeZone"]}}}} ``` ## The TermsAcceptanceRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TermsAcceptanceRequest":{"type":"object","properties":{"termsIds":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The AbstractEmployeeRegistrationRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractEmployeeRegistrationRequest":{"type":"object","properties":{"devicePlatform":{"$ref":"#/components/schemas/DevicePlatform"}}},"DevicePlatform":{"type":"string","description":"Platform or channel where the client runs (iOS, Android, Web, Slack, etc.)","enum":["IOS","IPADOS","ANDROID","WEB","WINDOWS","SLACK","MSTEAMS","MAIL","TELEGRAM","UNKNOWN"]}}}} ``` ## The DevicePlatform object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DevicePlatform":{"type":"string","description":"Platform or channel where the client runs (iOS, Android, Web, Slack, etc.)","enum":["IOS","IPADOS","ANDROID","WEB","WINDOWS","SLACK","MSTEAMS","MAIL","TELEGRAM","UNKNOWN"]}}}} ``` ## The EmployeeCompanyConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCompanyConfigurationDTO":{"type":"object","properties":{"alertDays":{"type":"array","items":{"type":"integer","format":"int32"}},"alertHour":{"type":"integer","format":"int32"},"alertMinute":{"type":"integer","format":"int32"},"enabledEmployeeFeatures":{"type":"integer","format":"int32"}}}}}} ``` ## The EmployeeRegistrationResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeRegistrationResponse":{"type":"object","properties":{"sessionToken":{"type":"string"},"companyConfig":{"$ref":"#/components/schemas/EmployeeCompanyConfigurationDTO"}}},"EmployeeCompanyConfigurationDTO":{"type":"object","properties":{"alertDays":{"type":"array","items":{"type":"integer","format":"int32"}},"alertHour":{"type":"integer","format":"int32"},"alertMinute":{"type":"integer","format":"int32"},"enabledEmployeeFeatures":{"type":"integer","format":"int32"}}}}}} ``` ## The EmployeeNotificationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeNotificationDTO":{"type":"object","description":"Employee notification: id, title, image, date, seen, target type, and target id.","properties":{"id":{"type":"string","description":"Notification identifier"},"title":{"type":"string","description":"Notification title"},"imagePath":{"type":"string","description":"URL or path to the notification image"},"date":{"type":"string","format":"date-time","description":"Date and time of the notification"},"seen":{"type":"boolean","description":"Whether the notification has been seen"},"targetType":{"$ref":"#/components/schemas/NotificationTargetType","description":"Type of target this notification refers to"},"targetId":{"type":"string","description":"ID of the target (comment, conversation, announcement, etc.)"}}},"NotificationTargetType":{"type":"string","description":"Type of target: COMMENT, CONVERSATION, ANNOUNCEMENT, QUESTION, SUGGESTION, PERSONAL_REPORT, NONE","enum":["COMMENT","CONVERSATION","ANNOUNCEMENT","QUESTION","SUGGESTION","PERSONAL_REPORT","NONE"]}}}} ``` ## The NotificationTargetType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"NotificationTargetType":{"type":"string","description":"Type of target: COMMENT, CONVERSATION, ANNOUNCEMENT, QUESTION, SUGGESTION, PERSONAL_REPORT, NONE","enum":["COMMENT","CONVERSATION","ANNOUNCEMENT","QUESTION","SUGGESTION","PERSONAL_REPORT","NONE"]}}}} ``` ## The EmployeeNotificationCountDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeNotificationCountDTO":{"type":"object","description":"Total count of notifications for the employee.","properties":{"count":{"type":"integer","format":"int32","description":"Number of notifications"}}}}}} ``` ## The ReportReaction object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ReportReaction":{"type":"string","description":"Reaction to a personal report (like or dislike)","enum":["like","dislike"]}}}} ``` ## The MePersonalReportDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MePersonalReportDTO":{"allOf":[{"$ref":"#/components/schemas/MePersonalReportHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"},"report":{"type":"string"}}}],"description":"Full personal report: header fields plus report content (HTML or text)."},"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}}} ``` ## The MePersonalReportHeaderDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MePersonalReportHeaderDTO":{"type":"object","description":"Personal report header: id, title, date, liked, disliked, seen. Generated from engagement pulse, HI, etc. for a given month.","properties":{"id":{"type":"string"},"title":{"type":"string"},"date":{"type":"string","format":"date-time"},"liked":{"type":"boolean"},"disliked":{"type":"boolean"},"seen":{"type":"boolean"}}}}}} ``` ## The EmployeeLoginRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeLoginRequest":{"type":"object","properties":{"timeZone":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"appVersion":{"type":"string"}}}}}} ``` ## The EmployeeLoginResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeLoginResponse":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"companyName":{"type":"string"},"companyTimeZone":{"type":"string"},"appStyle":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"configCompleted":{"type":"boolean"},"requireVote":{"type":"boolean"},"pendingAnnouncements":{"type":"boolean"},"pendingFeedback":{"type":"boolean"},"requireFirstTimeCommentFilter":{"type":"boolean"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"debug":{"type":"boolean"},"canResetProfile":{"type":"boolean"},"canManage":{"type":"boolean"},"canBlockUsers":{"type":"boolean"},"hasHFMe":{"type":"boolean","deprecated":true},"canHFMe":{"type":"boolean"},"canRegisterTime":{"type":"boolean"},"hfMeActivated":{"type":"boolean"},"canUseHero":{"type":"boolean"},"canManageHierarchy":{"type":"boolean"},"externalId":{"type":"string"},"votingFlow":{"type":"string","enum":["QUESTIONS","ANNOUNCEMENTS"]}}}}}} ``` ## The EmployeeAutoInviteRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeAutoInviteRequest":{"type":"object","properties":{"autoInviteToken":{"type":"string"}}}}}} ``` ## The AbstractFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractFeedbackDTO":{"type":"object","description":"Base class for feedback post messages","discriminator":{"propertyName":"type","mapping":{"CONGRATULATION":"#/components/schemas/StandardFeedbackDTO","SUGGESTION":"#/components/schemas/SuggestionFeedbackDTO","INFORMATION":"#/components/schemas/StandardFeedbackDTO","RECOGNITION":"#/components/schemas/RecognitionFeedbackDTO","CRITICISM":"#/components/schemas/SomethingIsWrongFeedbackDTO"}},"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of the feedback","enum":["CONGRATULATION, SUGGESTION, INFORMATION, RECOGNITION, CRITICISM"]},"date":{"type":"string","format":"date-time","description":"Date of the Feedback. If not posted, Server will add the reception one"},"privated":{"type":"boolean","description":"Should this feedback be hidden an only visible for managers?. Check Feedback Types endpoint to see the different modes"},"notAnonymous":{"type":"boolean","description":"Should this feedback be signed?"},"message":{"type":"string","description":"Core message of the feedback"},"verificationToken":{"type":"string","description":"If the feedback type requires verification, a result token must be attached before publishing"},"attachments":{"type":"array","description":"Attachements of the feedback, like images, etc","items":{"$ref":"#/components/schemas/FeedbackAttachementDTO"}},"additionalFields":{"type":"object","additionalProperties":{}}},"required":["message","notAnonymous","privated","type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackAttachementDTO":{"type":"object","description":"Attachment for feedback (image, etc.): type, mime type, base64 or file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string","description":"MIME type of the file"},"base64":{"type":"string","description":"Base64-encoded content (when uploading)"},"fileURL":{"type":"string","description":"URL of the file (when already stored)"}}}}}} ``` ## The FeedbackAttachementDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackAttachementDTO":{"type":"object","description":"Attachment for feedback (image, etc.): type, mime type, base64 or file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string","description":"MIME type of the file"},"base64":{"type":"string","description":"Base64-encoded content (when uploading)"},"fileURL":{"type":"string","description":"URL of the file (when already stored)"}}}}}} ``` ## The FeedbackTargetDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackTargetDTO":{"type":"object","description":"To who is targeted this feedback?","properties":{"name":{"type":"string","description":"To who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET"},"description":{"type":"string","description":"Description of the target: Area, Manager name, or Employee Name. Just for FREE_TARGET, LIST_FREE_TARGET"},"id":{"type":"string","description":"The ID to who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET feedback types"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Which target type is this? is directed to someone or to a team"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The RecognitionFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionFeedbackDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractFeedbackDTO"},{"type":"object","properties":{"valueId":{"type":"string","description":"Id of the value for the recognition"},"target":{"$ref":"#/components/schemas/FeedbackTargetDTO","description":"To who is targeted the recognition"}}}],"description":"Recognition request POST message","required":["message","notAnonymous","privated","target","type","valueId"]},"AbstractFeedbackDTO":{"type":"object","description":"Base class for feedback post messages","discriminator":{"propertyName":"type","mapping":{"CONGRATULATION":"#/components/schemas/StandardFeedbackDTO","SUGGESTION":"#/components/schemas/SuggestionFeedbackDTO","INFORMATION":"#/components/schemas/StandardFeedbackDTO","RECOGNITION":"#/components/schemas/RecognitionFeedbackDTO","CRITICISM":"#/components/schemas/SomethingIsWrongFeedbackDTO"}},"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of the feedback","enum":["CONGRATULATION, SUGGESTION, INFORMATION, RECOGNITION, CRITICISM"]},"date":{"type":"string","format":"date-time","description":"Date of the Feedback. If not posted, Server will add the reception one"},"privated":{"type":"boolean","description":"Should this feedback be hidden an only visible for managers?. Check Feedback Types endpoint to see the different modes"},"notAnonymous":{"type":"boolean","description":"Should this feedback be signed?"},"message":{"type":"string","description":"Core message of the feedback"},"verificationToken":{"type":"string","description":"If the feedback type requires verification, a result token must be attached before publishing"},"attachments":{"type":"array","description":"Attachements of the feedback, like images, etc","items":{"$ref":"#/components/schemas/FeedbackAttachementDTO"}},"additionalFields":{"type":"object","additionalProperties":{}}},"required":["message","notAnonymous","privated","type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackAttachementDTO":{"type":"object","description":"Attachment for feedback (image, etc.): type, mime type, base64 or file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string","description":"MIME type of the file"},"base64":{"type":"string","description":"Base64-encoded content (when uploading)"},"fileURL":{"type":"string","description":"URL of the file (when already stored)"}}},"FeedbackTargetDTO":{"type":"object","description":"To who is targeted this feedback?","properties":{"name":{"type":"string","description":"To who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET"},"description":{"type":"string","description":"Description of the target: Area, Manager name, or Employee Name. Just for FREE_TARGET, LIST_FREE_TARGET"},"id":{"type":"string","description":"The ID to who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET feedback types"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Which target type is this? is directed to someone or to a team"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The SomethingIsWrongFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SomethingIsWrongFeedbackDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractFeedbackDTO"},{"type":"object","properties":{"makesMeFeel":{"type":"string","description":"Feedback Wrap makes me field value. Expected to not be empty"},"howToSolve":{"type":"string","description":"Feedback Wrap How To Solve. Expected to not be empty"}}}],"description":"Something is Wrong Feedback Post message","required":["howToSolve","makesMeFeel","message","notAnonymous","privated","type"]},"AbstractFeedbackDTO":{"type":"object","description":"Base class for feedback post messages","discriminator":{"propertyName":"type","mapping":{"CONGRATULATION":"#/components/schemas/StandardFeedbackDTO","SUGGESTION":"#/components/schemas/SuggestionFeedbackDTO","INFORMATION":"#/components/schemas/StandardFeedbackDTO","RECOGNITION":"#/components/schemas/RecognitionFeedbackDTO","CRITICISM":"#/components/schemas/SomethingIsWrongFeedbackDTO"}},"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of the feedback","enum":["CONGRATULATION, SUGGESTION, INFORMATION, RECOGNITION, CRITICISM"]},"date":{"type":"string","format":"date-time","description":"Date of the Feedback. If not posted, Server will add the reception one"},"privated":{"type":"boolean","description":"Should this feedback be hidden an only visible for managers?. Check Feedback Types endpoint to see the different modes"},"notAnonymous":{"type":"boolean","description":"Should this feedback be signed?"},"message":{"type":"string","description":"Core message of the feedback"},"verificationToken":{"type":"string","description":"If the feedback type requires verification, a result token must be attached before publishing"},"attachments":{"type":"array","description":"Attachements of the feedback, like images, etc","items":{"$ref":"#/components/schemas/FeedbackAttachementDTO"}},"additionalFields":{"type":"object","additionalProperties":{}}},"required":["message","notAnonymous","privated","type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackAttachementDTO":{"type":"object","description":"Attachment for feedback (image, etc.): type, mime type, base64 or file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string","description":"MIME type of the file"},"base64":{"type":"string","description":"Base64-encoded content (when uploading)"},"fileURL":{"type":"string","description":"URL of the file (when already stored)"}}}}}} ``` ## The StandardFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"StandardFeedbackDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractFeedbackDTO"}],"description":"Standard message used for Congratulation, Information and any other Type","required":["message","notAnonymous","privated","type"]},"AbstractFeedbackDTO":{"type":"object","description":"Base class for feedback post messages","discriminator":{"propertyName":"type","mapping":{"CONGRATULATION":"#/components/schemas/StandardFeedbackDTO","SUGGESTION":"#/components/schemas/SuggestionFeedbackDTO","INFORMATION":"#/components/schemas/StandardFeedbackDTO","RECOGNITION":"#/components/schemas/RecognitionFeedbackDTO","CRITICISM":"#/components/schemas/SomethingIsWrongFeedbackDTO"}},"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of the feedback","enum":["CONGRATULATION, SUGGESTION, INFORMATION, RECOGNITION, CRITICISM"]},"date":{"type":"string","format":"date-time","description":"Date of the Feedback. If not posted, Server will add the reception one"},"privated":{"type":"boolean","description":"Should this feedback be hidden an only visible for managers?. Check Feedback Types endpoint to see the different modes"},"notAnonymous":{"type":"boolean","description":"Should this feedback be signed?"},"message":{"type":"string","description":"Core message of the feedback"},"verificationToken":{"type":"string","description":"If the feedback type requires verification, a result token must be attached before publishing"},"attachments":{"type":"array","description":"Attachements of the feedback, like images, etc","items":{"$ref":"#/components/schemas/FeedbackAttachementDTO"}},"additionalFields":{"type":"object","additionalProperties":{}}},"required":["message","notAnonymous","privated","type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackAttachementDTO":{"type":"object","description":"Attachment for feedback (image, etc.): type, mime type, base64 or file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string","description":"MIME type of the file"},"base64":{"type":"string","description":"Base64-encoded content (when uploading)"},"fileURL":{"type":"string","description":"URL of the file (when already stored)"}}}}}} ``` ## The SuggestionFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SuggestionFeedbackDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractFeedbackDTO"},{"type":"object","properties":{"containerId":{"type":"string","description":"Initiative id where to post this suggestion"}}}],"description":"Suggestion Feedback Post message","required":["containerId","message","notAnonymous","privated","type"]},"AbstractFeedbackDTO":{"type":"object","description":"Base class for feedback post messages","discriminator":{"propertyName":"type","mapping":{"CONGRATULATION":"#/components/schemas/StandardFeedbackDTO","SUGGESTION":"#/components/schemas/SuggestionFeedbackDTO","INFORMATION":"#/components/schemas/StandardFeedbackDTO","RECOGNITION":"#/components/schemas/RecognitionFeedbackDTO","CRITICISM":"#/components/schemas/SomethingIsWrongFeedbackDTO"}},"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of the feedback","enum":["CONGRATULATION, SUGGESTION, INFORMATION, RECOGNITION, CRITICISM"]},"date":{"type":"string","format":"date-time","description":"Date of the Feedback. If not posted, Server will add the reception one"},"privated":{"type":"boolean","description":"Should this feedback be hidden an only visible for managers?. Check Feedback Types endpoint to see the different modes"},"notAnonymous":{"type":"boolean","description":"Should this feedback be signed?"},"message":{"type":"string","description":"Core message of the feedback"},"verificationToken":{"type":"string","description":"If the feedback type requires verification, a result token must be attached before publishing"},"attachments":{"type":"array","description":"Attachements of the feedback, like images, etc","items":{"$ref":"#/components/schemas/FeedbackAttachementDTO"}},"additionalFields":{"type":"object","additionalProperties":{}}},"required":["message","notAnonymous","privated","type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackAttachementDTO":{"type":"object","description":"Attachment for feedback (image, etc.): type, mime type, base64 or file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string","description":"MIME type of the file"},"base64":{"type":"string","description":"Base64-encoded content (when uploading)"},"fileURL":{"type":"string","description":"URL of the file (when already stored)"}}}}}} ``` ## The EmployeeParticipationProfileConfigureRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeParticipationProfileConfigureRequest":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The PersonalConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonalConfigurationDTO":{"type":"object","description":"Personal configuration for the current user: e.g. whether Me section is activated.","properties":{"meActivated":{"type":"boolean","description":"Whether the Me / personal area is activated"}}}}}} ``` ## The EmployeeCommentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCommentRequestDTO":{"type":"object","description":"Request body to post a new employee comment (question or container context).","properties":{"questionId":{"type":"string","description":"Question ID when commenting in a question context"},"containerId":{"type":"string","description":"Feedback container ID when commenting in a container context"},"message":{"type":"string","description":"Comment text"},"date":{"type":"string","format":"date-time","description":"Optional date (server uses reception time if omitted)"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. SUGGESTION, RECOGNITION)"},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields"},"privated":{"type":"boolean","description":"Whether the comment is private (visible only to managers)"},"notAnonymous":{"type":"boolean","description":"Whether the comment is signed (not anonymous)"}},"required":["feedbackType","message"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The ContentAttachment object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ContentAttachment":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string"},"base64":{"type":"string"},"fileURL":{"type":"string"}}}}}} ``` ## The EmployeeCommentReplyRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCommentReplyRequestDTO":{"type":"object","description":"Request body to post a reply to an employee comment.","properties":{"message":{"type":"string","description":"Reply text"},"messageType":{"type":"integer","format":"int32","description":"Optional message type identifier"},"date":{"type":"string","format":"date-time","description":"Optional date (server uses reception time if omitted)"},"notAnonymous":{"type":"boolean","description":"Whether the reply is signed (not anonymous)"},"attachments":{"type":"array","description":"Optional attachments (e.g. images)","items":{"$ref":"#/components/schemas/ContentAttachment"}}},"required":["message"]},"ContentAttachment":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string"},"base64":{"type":"string"},"fileURL":{"type":"string"}}}}}} ``` ## The AbstractCommentContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The AnnouncementCommentContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementCommentContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"announcementId":{"type":"string","description":"ID of the announcement this comment belongs to"}}}],"description":"Comment context when the comment is on an announcement."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The CommentFeedbackTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentFeedbackTypeDTO":{"type":"object","deprecated":true,"description":"Deprecated. Feedback type with image URL. Use feedback-type-specific configuration instead.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. RECOGNITION, SUGGESTION)"},"imageURL":{"type":"string","description":"URL of the image/icon for this feedback type"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The ENPSContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the ENPS question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Selected or displayed question value"}}}],"description":"Comment context when the comment is in an ENPS (eNPS) question context."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The EmployeeCommentAttachmentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCommentAttachmentDTO":{"type":"object","description":"Attachment linked to a comment (e.g. image) with type and file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string","description":"URL of the attached file"}}}}}} ``` ## The EmployeeCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"questionId":{"type":"string","description":"Question ID when the comment is in a question context"},"announcementNumber":{"type":"string","deprecated":true,"description":"Deprecated. Announcement number reference."},"conversationId":{"type":"string","description":"Conversation ID if this comment started or belongs to a conversation"},"replied":{"type":"boolean","description":"Whether this comment has been replied to"},"allowReply":{"type":"boolean","description":"Whether replies are allowed for this comment"},"requiresReplyVerification":{"type":"boolean","description":"Whether a reply must pass verification/moderation before being published"},"replySignatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode required for replies (e.g. ANONYMOUS, MANDATORY)"},"allowNotAnonymousReply":{"type":"boolean","deprecated":true,"description":"Deprecated. Replaced by replySignatureMode and other flags."},"allowStartConversation":{"type":"boolean","description":"Whether the user can start a conversation from this comment"},"allowedReplyAttachmentTypes":{"type":"array","description":"Attachment types allowed when replying (e.g. IMAGE)","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentReplyDTO"}},"target":{"$ref":"#/components/schemas/FeedbackTargetDTO","description":"Target (e.g. hierarchy or group) this comment is associated with"},"status":{"$ref":"#/components/schemas/FeedbackCycleStatusDTO","description":"Status of the feedback cycle this comment belongs to"},"context":{"description":"Context of the comment (e.g. SURVEY, QUESTION, ANNOUNCEMENT) with type-specific data","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentContextDTO"},{"$ref":"#/components/schemas/ENPSContextDTO"},{"$ref":"#/components/schemas/QuestionContextDTO"},{"$ref":"#/components/schemas/ScoreContextDTO"},{"$ref":"#/components/schemas/SurveyContextDTO"}]}}}],"description":"Top-level employee comment. Extends base comment with question/conversation ids, reply settings, target, status, and context."},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"FeedbackContainerPreviewDTO":{"type":"object","description":"Lightweight preview of a feedback container (id, type, title, image).","properties":{"id":{"type":"string","description":"Unique identifier of the container"},"type":{"$ref":"#/components/schemas/FeedbackContainerType","description":"Container type (e.g. IDEA_INITIATIVE)"},"title":{"type":"string","description":"Title of the container"},"imageUrl":{"type":"string","description":"URL of the container image"}}},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"CommentFeedbackTypeDTO":{"type":"object","deprecated":true,"description":"Deprecated. Feedback type with image URL. Use feedback-type-specific configuration instead.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. RECOGNITION, SUGGESTION)"},"imageURL":{"type":"string","description":"URL of the image/icon for this feedback type"}}},"EmployeeCommentAttachmentDTO":{"type":"object","description":"Attachment linked to a comment (e.g. image) with type and file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string","description":"URL of the attached file"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"EmployeeCommentReplyDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"highlightScore":{"type":"integer","format":"int32","description":"Score used to highlight or order this reply"}}}],"description":"Reply to an employee comment. Extends base comment with highlight score for ordering/display."},"FeedbackTargetDTO":{"type":"object","description":"To who is targeted this feedback?","properties":{"name":{"type":"string","description":"To who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET"},"description":{"type":"string","description":"Description of the target: Area, Manager name, or Employee Name. Just for FREE_TARGET, LIST_FREE_TARGET"},"id":{"type":"string","description":"The ID to who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET feedback types"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Which target type is this? is directed to someone or to a team"}}},"FeedbackCycleStatusDTO":{"type":"object","description":"Status of a feedback cycle: color, label, and description (e.g. approved, in review).","properties":{"color":{"type":"string","description":"Color code for the status (e.g. for UI)"},"label":{"type":"string","description":"Short label for the status"},"description":{"type":"string","description":"Description of the status"}}},"AnnouncementCommentContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"announcementId":{"type":"string","description":"ID of the announcement this comment belongs to"}}}],"description":"Comment context when the comment is on an announcement."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"ENPSContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the ENPS question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Selected or displayed question value"}}}],"description":"Comment context when the comment is in an ENPS (eNPS) question context."},"QuestionContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is on a question (e.g. HI, check-in)."},"ScoreContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"scoreName":{"type":"string","description":"Name of the score"},"factorName":{"type":"string","description":"Name of the factor"},"questionTitle":{"type":"string","description":"Title of the question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value for the score"}}}],"description":"Comment context when the comment is in a score (factor/question) context."},"SurveyContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"roundTitle":{"type":"string","description":"Title of the survey round"},"questionTitle":{"type":"string","description":"Title of the survey question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is in a survey (round title, question title, question values)."}}}} ``` ## The EmployeeCommentReplyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCommentReplyDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"highlightScore":{"type":"integer","format":"int32","description":"Score used to highlight or order this reply"}}}],"description":"Reply to an employee comment. Extends base comment with highlight score for ordering/display."},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"FeedbackContainerPreviewDTO":{"type":"object","description":"Lightweight preview of a feedback container (id, type, title, image).","properties":{"id":{"type":"string","description":"Unique identifier of the container"},"type":{"$ref":"#/components/schemas/FeedbackContainerType","description":"Container type (e.g. IDEA_INITIATIVE)"},"title":{"type":"string","description":"Title of the container"},"imageUrl":{"type":"string","description":"URL of the container image"}}},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"CommentFeedbackTypeDTO":{"type":"object","deprecated":true,"description":"Deprecated. Feedback type with image URL. Use feedback-type-specific configuration instead.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. RECOGNITION, SUGGESTION)"},"imageURL":{"type":"string","description":"URL of the image/icon for this feedback type"}}},"EmployeeCommentAttachmentDTO":{"type":"object","description":"Attachment linked to a comment (e.g. image) with type and file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string","description":"URL of the attached file"}}}}}} ``` ## The EmployeeHierarchyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}}}}} ``` ## The FeedbackContainerPreviewDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackContainerPreviewDTO":{"type":"object","description":"Lightweight preview of a feedback container (id, type, title, image).","properties":{"id":{"type":"string","description":"Unique identifier of the container"},"type":{"$ref":"#/components/schemas/FeedbackContainerType","description":"Container type (e.g. IDEA_INITIATIVE)"},"title":{"type":"string","description":"Title of the container"},"imageUrl":{"type":"string","description":"URL of the container image"}}},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]}}}} ``` ## The FeedbackCycleStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackCycleStatusDTO":{"type":"object","description":"Status of a feedback cycle: color, label, and description (e.g. approved, in review).","properties":{"color":{"type":"string","description":"Color code for the status (e.g. for UI)"},"label":{"type":"string","description":"Short label for the status"},"description":{"type":"string","description":"Description of the status"}}}}}} ``` ## The QuestionContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is on a question (e.g. HI, check-in)."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The QuestionValueDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The ScoreContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"scoreName":{"type":"string","description":"Name of the score"},"factorName":{"type":"string","description":"Name of the factor"},"questionTitle":{"type":"string","description":"Title of the question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value for the score"}}}],"description":"Comment context when the comment is in a score (factor/question) context."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The SignatureMode object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}}} ``` ## The SurveyContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"roundTitle":{"type":"string","description":"Title of the survey round"},"questionTitle":{"type":"string","description":"Title of the survey question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is in a survey (round title, question title, question values)."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The EmployeeCommentInappropiateRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCommentInappropiateRequest":{"type":"object","properties":{"reason":{"type":"string"},"reasonType":{"$ref":"#/components/schemas/InappropriateReasonType"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]}}}} ``` ## The EmployeeCheckUserRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCheckUserRequest":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"key":{"type":"string"}}}}}} ``` ## The EmployeeCheckUserResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeCheckUserResponse":{"type":"object","properties":{"valid":{"type":"boolean"},"accountLocked":{"type":"boolean"},"companyBlocked":{"type":"boolean"},"userType":{"$ref":"#/components/schemas/UserType"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The AnnouncementForEmployeeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementForEmployeeDTO":{"allOf":[{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"},{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"message":{"type":"string","description":"Full announcement message body (HTML or plain text)"}}}],"description":"Full announcement for employee view: header fields plus message body."},"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}}} ``` ## The AnnouncementHeaderForEmployeeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}}} ``` ## The CompanyFileDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}}}}} ``` ## The AnnouncementCommentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementCommentRequestDTO":{"type":"object","description":"Request body to post a comment on an announcement.","properties":{"message":{"type":"string","description":"Comment text"},"signed":{"type":"boolean","description":"Whether the comment is signed (not anonymous)"},"attachments":{"type":"array","description":"Optional attachments (e.g. images)","items":{"$ref":"#/components/schemas/ContentAttachment"}}},"required":["message"]},"ContentAttachment":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"mimeType":{"type":"string"},"base64":{"type":"string"},"fileURL":{"type":"string"}}}}}} ``` ## The CompanyAccountStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}}} ``` ## The CompanyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}}} ``` ## The BreakTimeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"BreakTimeDTO":{"type":"object","description":"DTO representing a break period during a work shift","properties":{"startTime":{"type":"string","format":"date-time","description":"Start date and time of the break in UTC"},"endTime":{"type":"string","format":"date-time","description":"End date and time of the break in UTC"}},"required":["endTime","startTime"]}}}} ``` ## The TimesheetCreateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetCreateRequestDTO":{"type":"object","description":"Timesheet creation data","properties":{"startTime":{"type":"string","format":"date-time","description":"Start date and time of the work period in UTC"},"endTime":{"type":"string","format":"date-time","description":"End date and time of the work period in UTC"},"breaks":{"type":"array","description":"List of break periods during the work shift","items":{"$ref":"#/components/schemas/BreakTimeDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Type of period: ACTIVE, VACATION, BANK_HOLIDAY, SICK_LEAVE, or DAY_OFF"},"timeZone":{"type":"string","description":"IANA timezone ID for the client sending this request (e.g. Europe/Madrid). Stored on the timesheet document.","minLength":1}},"required":["periodType","startTime","timeZone"]},"BreakTimeDTO":{"type":"object","description":"DTO representing a break period during a work shift","properties":{"startTime":{"type":"string","format":"date-time","description":"Start date and time of the break in UTC"},"endTime":{"type":"string","format":"date-time","description":"End date and time of the break in UTC"}},"required":["endTime","startTime"]},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]}}}} ``` ## The TimesheetEmployeeBatchCreateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetEmployeeBatchCreateRequestDTO":{"type":"object","description":"Request DTO for creating multiple timesheet records for a specific employee","properties":{"employeeId":{"type":"string","description":"Employee ID"},"createRequests":{"type":"array","description":"List of timesheet creation data for this employee (e.g. one entry per day)","items":{"$ref":"#/components/schemas/TimesheetCreateRequestDTO"}}}},"TimesheetCreateRequestDTO":{"type":"object","description":"Timesheet creation data","properties":{"startTime":{"type":"string","format":"date-time","description":"Start date and time of the work period in UTC"},"endTime":{"type":"string","format":"date-time","description":"End date and time of the work period in UTC"},"breaks":{"type":"array","description":"List of break periods during the work shift","items":{"$ref":"#/components/schemas/BreakTimeDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Type of period: ACTIVE, VACATION, BANK_HOLIDAY, SICK_LEAVE, or DAY_OFF"},"timeZone":{"type":"string","description":"IANA timezone ID for the client sending this request (e.g. Europe/Madrid). Stored on the timesheet document.","minLength":1}},"required":["periodType","startTime","timeZone"]},"BreakTimeDTO":{"type":"object","description":"DTO representing a break period during a work shift","properties":{"startTime":{"type":"string","format":"date-time","description":"Start date and time of the break in UTC"},"endTime":{"type":"string","format":"date-time","description":"End date and time of the break in UTC"}},"required":["endTime","startTime"]},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]}}}} ``` ## The SurveyRemindRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyRemindRequestDTO":{"type":"object","description":"The details of the reminder to be created","properties":{"message":{"$ref":"#/components/schemas/MultiLanguage"},"header":{"$ref":"#/components/schemas/MultiLanguage"},"appReminder":{"type":"boolean"},"mailReminder":{"type":"boolean"}},"required":["header","message"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The SAML2SSOConfigRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SAML2SSOConfigRequest":{"type":"object","properties":{"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"idpMetadataUrl":{"type":"string"},"idpMetadataXml":{"type":"string"},"spEntityId":{"type":"string"},"nameIdFormat":{"type":"string"},"mandatory":{"type":"boolean"}}}}}} ``` ## The SSOConfigResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SSOConfigResponse":{"type":"object","properties":{"protocol":{"type":"string","enum":["SAML2","OIDC"]},"enabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"registrationId":{"type":"string"},"ssoInitiationUrl":{"type":"string"},"spMetadataUrl":{"type":"string"}}}}}} ``` ## The OIDCSSOConfigRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"OIDCSSOConfigRequest":{"type":"object","properties":{"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"issuerUri":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"authorizationUri":{"type":"string"},"tokenUri":{"type":"string"},"jwkSetUri":{"type":"string"},"userInfoUri":{"type":"string"},"userNameAttribute":{"type":"string"},"mandatory":{"type":"boolean"}}}}}} ``` ## The ShiftCreateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ShiftCreateRequestDTO":{"type":"object","description":"Shift creation data","properties":{"startTime":{"type":"string","description":"Start time of the shift"},"endTime":{"type":"string","description":"End time of the shift"},"weekDays":{"type":"array","description":"Days of the week when the shift applies. Values: 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday","items":{"type":"integer","format":"int32"}}},"required":["endTime","startTime","weekDays"]}}}} ``` ## The ShiftDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ShiftDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"employeeId":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"},"weekDays":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}} ``` ## The AccountRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AccountRequest":{"type":"object","properties":{"email":{"type":"string"},"expiredToken":{"type":"string"}}}}}} ``` ## The GroupingType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]}}}} ``` ## The UserRegistrationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserRegistrationRequestDTO":{"type":"object","properties":{"name":{"type":"string"},"companyName":{"type":"string"},"email":{"type":"string"},"language":{"type":"string"}}}}}} ``` ## The UserRegistrationResponseDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserRegistrationResponseDTO":{"type":"object","properties":{"accountCreated":{"type":"boolean"}}}}}} ``` ## The SendInvitationPreviewDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SendInvitationPreviewDTO":{"type":"object","properties":{"content":{"type":"string"}}}}}} ``` ## The EmployeeSendReminderRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeSendReminderRequest":{"type":"object","properties":{"subject":{"type":"string"},"content":{"type":"string"},"signWithUserName":{"type":"boolean"},"sendSample":{"type":"boolean"}}}}}} ``` ## The AbstractHRISConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}}}}} ``` ## The BambooHRISConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"BambooHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"subdomain":{"type":"string"},"userName":{"type":"string"}}}]},"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}}}}} ``` ## The MergeHRISConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MergeHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"subdomain":{"type":"string"},"userName":{"type":"string"}}}]},"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}}}}} ``` ## The PersonioHRISConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonioHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"}}}]},"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}}}}} ``` ## The WoltersKluwerHRISConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"WoltersKluwerHRISConfigurationDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractHRISConfigurationDTO"},{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"},"redirectUrl":{"type":"string"}}}]},"AbstractHRISConfigurationDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string","enum":["MERGE","BAMBOOHR","WOLTERSKLUWER","PERSONIO","UNKNOWN"]},"status":{"type":"string","enum":["PENDING_EXTERNAL_APROVAL","INITIAL_SYNC","PENDING_CONFIGURATION","CONNECTED","FAILED"]},"lastSyncDate":{"type":"string","format":"date-time"}}}}}} ``` ## The AttachmentResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AttachmentResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}}} ``` ## The CommentsReportType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentsReportType":{"type":"string","description":"CommentsReportType","enum":["LIST","FIRST_REPLY_TIMES","RECOGNITIONS"]}}}} ``` ## The FeedbackConfiguration object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackConfiguration":{"type":"object","properties":{"companyId":{"type":"string"},"feedbackConfiguration":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FeedbackTypeConfiguration"}},"recognitionValues":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/FeedbackRecognitionValue"}},"recognitionMode":{"type":"string","enum":["MANAGER","MANAGER_EMPLOYEES"]},"recognitionEnabled":{"type":"boolean","deprecated":true},"recognitionSignatureMode":{"$ref":"#/components/schemas/SignatureMode","deprecated":true},"recognitionManagerSignatureMode":{"$ref":"#/components/schemas/SignatureMode","deprecated":true},"recognitionEmployeeSignatureMode":{"$ref":"#/components/schemas/SignatureMode","deprecated":true},"recognitionTargetMode":{"$ref":"#/components/schemas/FeedbackTargetMode","deprecated":true},"maxCommentLength":{"type":"integer","format":"int32"},"maxRecognitionsPerDay":{"type":"integer","format":"int32","deprecated":true},"feedbackMode":{"$ref":"#/components/schemas/FeedbackMode"},"feedbackLevelMode":{"$ref":"#/components/schemas/FeedbackLevelMode"},"allowNonAnonymousReplies":{"type":"boolean","deprecated":true},"allowManagerNonAnonymousReplies":{"type":"boolean"},"allowEmployeeNonAnonymousReplies":{"type":"boolean"},"commentsReplyMode":{"type":"string","enum":["NO_REPLY","COMMENT_OR_REPLY","COMMENT_AND_REPLY","COMMENT_AND_MULTIPLE_REPLY","COMMENT_AND_ONLY_MANAGERS_REPLY"]},"reactToSignedCommentsEnabled":{"type":"boolean"},"closedReason":{"type":"string"},"verificationRequired":{"type":"boolean"},"allowAttachments":{"type":"boolean"}}},"FeedbackTypeConfiguration":{"type":"object","properties":{"enabled":{"type":"boolean"},"privacyMode":{"$ref":"#/components/schemas/FeedbackPrivacyMode"},"signatureMode":{"$ref":"#/components/schemas/SignatureMode","deprecated":true},"managerSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"employeeSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"targetMode":{"$ref":"#/components/schemas/FeedbackTargetMode"},"requireReview":{"type":"boolean"},"sharedAmmountComments":{"type":"boolean"},"maxCommentsPerDay":{"type":"integer","format":"int32"}}},"FeedbackPrivacyMode":{"type":"string","enum":["OPEN","OPTIONAL","MANDATORY"]},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"FeedbackTargetMode":{"type":"string","description":"FeedbackTargetMode.","enum":["NO_TARGET","FREE_TARGET","LIST_TARGET","LIST_FREE_TARGET"]},"FeedbackRecognitionValue":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"iconId":{"type":"integer","format":"int32"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"archived":{"type":"boolean"}}},"FeedbackMode":{"type":"string","enum":["ON_VOTE","AFTER_VOTE","ON_AND_AFTER_VOTE","NO_FEEDBACK","INLINE"]},"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]}}}} ``` ## The FeedbackLevelMode object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]}}}} ``` ## The FeedbackMode object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackMode":{"type":"string","enum":["ON_VOTE","AFTER_VOTE","ON_AND_AFTER_VOTE","NO_FEEDBACK","INLINE"]}}}} ``` ## The FeedbackPrivacyMode object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackPrivacyMode":{"type":"string","enum":["OPEN","OPTIONAL","MANDATORY"]}}}} ``` ## The FeedbackRecognitionValue object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackRecognitionValue":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"iconId":{"type":"integer","format":"int32"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"archived":{"type":"boolean"}}}}}} ``` ## The FeedbackTargetMode object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackTargetMode":{"type":"string","description":"FeedbackTargetMode.","enum":["NO_TARGET","FREE_TARGET","LIST_TARGET","LIST_FREE_TARGET"]}}}} ``` ## The FeedbackTypeConfiguration object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackTypeConfiguration":{"type":"object","properties":{"enabled":{"type":"boolean"},"privacyMode":{"$ref":"#/components/schemas/FeedbackPrivacyMode"},"signatureMode":{"$ref":"#/components/schemas/SignatureMode","deprecated":true},"managerSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"employeeSignatureMode":{"$ref":"#/components/schemas/SignatureMode"},"targetMode":{"$ref":"#/components/schemas/FeedbackTargetMode"},"requireReview":{"type":"boolean"},"sharedAmmountComments":{"type":"boolean"},"maxCommentsPerDay":{"type":"integer","format":"int32"}}},"FeedbackPrivacyMode":{"type":"string","enum":["OPEN","OPTIONAL","MANDATORY"]},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"FeedbackTargetMode":{"type":"string","description":"FeedbackTargetMode.","enum":["NO_TARGET","FREE_TARGET","LIST_TARGET","LIST_FREE_TARGET"]}}}} ``` ## The ENPSConfigureRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSConfigureRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"fullPeriod":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The CompanyCultureValueCreateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCultureValueCreateRequestDTO":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"customIconContent":{"type":"string"},"iconURL":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The CompanyCultureValuesTranslationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCultureValuesTranslationRequestDTO":{"type":"object","properties":{"toLanguage":{"type":"string"}}}}}} ``` ## The ConversationStartersRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationStartersRequestDTO":{"type":"object","properties":{"personKey":{"type":"string"},"commentId":{"type":"string"},"statusDate":{"type":"string","format":"date"},"originType":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]}}}}}} ``` ## The ConversationStarterDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationStarterDTO":{"type":"object","properties":{"starter":{"type":"string"},"reason":{"type":"string"}}}}}} ``` ## The ConversationInitRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationInitRequestDTO":{"type":"object","properties":{"personKey":{"type":"string"},"commentId":{"type":"string"},"originType":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"statusDate":{"type":"string","format":"date-time"},"message":{"type":"string"}}}}}} ``` ## The ContentGenerationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ContentGenerationRequestDTO":{"type":"object","properties":{"instruction":{"type":"string"},"selectedContent":{"type":"string"},"baseContent":{"type":"string"},"outputFormat":{"type":"string"}}}}}} ``` ## The CompanyConfig object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyConfig":{"type":"object","properties":{"alertDays":{"type":"array","items":{"type":"integer","format":"int32"}},"alertHour":{"type":"integer","format":"int32"},"alertMinute":{"type":"integer","format":"int32"},"voteReminderDays":{"type":"array","items":{"type":"integer","format":"int32"}},"voteReminderTimeConfig":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EngagementActionTimeConfig"}},"inappropiateThreshold":{"type":"integer","format":"int32"},"hiCalculationMode":{"type":"string","enum":["CLASSIC","POSITIVENESS","AVERAGES"]},"elapsedDaysSinceLastVote":{"type":"integer","format":"int32"},"minActiveEmployees":{"type":"integer","format":"int32"},"apiKey":{"type":"string"},"validDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"domainPatternExclusions":{"type":"array","items":{"type":"string"},"uniqueItems":true},"renameManagerComentsHierarchy":{"type":"boolean"},"defaultLanguage":{"type":"string"},"supportedLanguages":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentalAnalyticsEnabled":{"type":"boolean"},"personalityAnalyticsEnabled":{"type":"boolean"},"timezone":{"type":"string"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]},"source":{"type":"string","enum":["SELF_SERVICE","SALE","PARTNER_SALE"]},"plan":{"type":"string","enum":["TEST","TRIAL","SUBSCRIPTION"]},"blockReason":{"type":"string"},"blockedDate":{"type":"string","format":"date-time"},"blockerId":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"resetProfileMode":{"type":"string","enum":["NEVER","EACH_30_DAYS","ALWAYS"]},"expireActivationCodes":{"type":"boolean"},"disabledEgagementNonActivatedMails":{"type":"boolean"},"disabledEmailManagersRanking":{"type":"boolean"},"monthlyReportOnlyForAdmins":{"type":"boolean","deprecated":true},"rolesForMonthlyReport":{"type":"array","items":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"uniqueItems":true},"disableEngagementMails":{"type":"boolean"},"assetsOverrides":{"$ref":"#/components/schemas/CompanyConfigAssets"},"includeInBenchmark":{"type":"boolean"},"industryType":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"jobEnvironment":{"type":"string","enum":["OFFICE","NON_DESKTOP","GEEK"]},"requireVoteToSeeResults":{"type":"boolean"},"overrideDepartmentWithCompanyName":{"type":"boolean"},"mailVoteFrequency":{"type":"string","enum":["DISABLED","EACH_WEEK","EACH_TWO_WEEKS"]},"overrideVoteImageWithFeedbackType":{"type":"boolean"},"appStyle":{"type":"string"},"enableClassificationFollowups":{"type":"boolean"},"enableAutoInvite":{"type":"boolean"},"autoInviteToken":{"type":"string"},"statsTransparencyMode":{"type":"string","enum":["MANAGERS","ALL"]},"announcementNotificationDays":{"type":"array","items":{"type":"integer","format":"int32"}},"announcementNotificationStartHour":{"type":"integer","format":"int32"},"announcementNotificationEndHour":{"type":"integer","format":"int32"},"questionNotificationDays":{"type":"array","items":{"type":"integer","format":"int32"}},"questionNotificationStartHour":{"type":"integer","format":"int32"},"questionNotificationEndHour":{"type":"integer","format":"int32"},"fakeEmployeeStats":{"type":"boolean"},"allowBlockUsers":{"type":"boolean"},"moodNotesOnHiEnabled":{"type":"boolean"},"timeRegistrationEnabled":{"type":"boolean"},"heroRequiredRole":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"loginByAccessLinkOnly":{"type":"boolean","deprecated":true},"allowedLoginMethods":{"type":"array","items":{"type":"string","enum":["USER_PASSWORD","USER_ACCESS_LINK","GOOGLE_AUTH","MICROSOFT_AUTH","HP_AUTH","SSO_SAML2","SSO_OIDC"]},"uniqueItems":true},"ssoConfiguration":{"$ref":"#/components/schemas/CompanySSOConfiguration"},"votingFlow":{"type":"string","enum":["QUESTIONS","ANNOUNCEMENTS"]},"context":{"type":"string","deprecated":true},"lifeEventsReminderEnabled":{"type":"boolean"},"employeeHierarchyConfiguredByAdmins":{"type":"boolean"},"rataModeEnabled":{"type":"boolean"},"silentManagers":{"type":"boolean"},"silentManagersAllowedEmails":{"type":"array","items":{"type":"string"},"uniqueItems":true},"hfmeEnabled":{"type":"boolean"},"hfheroEnabled":{"type":"boolean"},"active":{"type":"boolean"},"blocked":{"type":"boolean"},"paused":{"type":"boolean"}}},"EngagementActionTimeConfig":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]},"CompanyConfigAssets":{"type":"object","properties":{"productName":{"type":"string"},"productMailLogo":{"type":"string"},"productIosStoreURL":{"type":"string"},"productIpadosStoreURL":{"type":"string"},"productAndroidStoreURL":{"type":"string"},"productSlackInstallURL":{"type":"string"},"productMSTeamsInstallURL":{"type":"string"},"productWebClientURL":{"type":"string"},"productAppsURL":{"type":"string"},"unsubEmailURL":{"type":"string"},"notificationsApplicationId":{"type":"string"}},"required":["productAndroidStoreURL","productAppsURL","productIosStoreURL","productIpadosStoreURL","productMSTeamsInstallURL","productMailLogo","productName","productSlackInstallURL","productWebClientURL","unsubEmailURL"]},"CompanySSOConfiguration":{"type":"object","properties":{"protocol":{"type":"string","enum":["SAML2","OIDC"]},"registrationId":{"type":"string"},"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"enabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"idpMetadataUrl":{"type":"string"},"idpMetadataXml":{"type":"string"},"spEntityId":{"type":"string"},"nameIdFormat":{"type":"string"},"issuerUri":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"authorizationUri":{"type":"string"},"tokenUri":{"type":"string"},"jwkSetUri":{"type":"string"},"userInfoUri":{"type":"string"},"userNameAttribute":{"type":"string"}}}}}} ``` ## The CompanyConfigAssets object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyConfigAssets":{"type":"object","properties":{"productName":{"type":"string"},"productMailLogo":{"type":"string"},"productIosStoreURL":{"type":"string"},"productIpadosStoreURL":{"type":"string"},"productAndroidStoreURL":{"type":"string"},"productSlackInstallURL":{"type":"string"},"productMSTeamsInstallURL":{"type":"string"},"productWebClientURL":{"type":"string"},"productAppsURL":{"type":"string"},"unsubEmailURL":{"type":"string"},"notificationsApplicationId":{"type":"string"}},"required":["productAndroidStoreURL","productAppsURL","productIosStoreURL","productIpadosStoreURL","productMSTeamsInstallURL","productMailLogo","productName","productSlackInstallURL","productWebClientURL","unsubEmailURL"]}}}} ``` ## The CompanySSOConfiguration object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySSOConfiguration":{"type":"object","properties":{"protocol":{"type":"string","enum":["SAML2","OIDC"]},"registrationId":{"type":"string"},"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"enabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"idpMetadataUrl":{"type":"string"},"idpMetadataXml":{"type":"string"},"spEntityId":{"type":"string"},"nameIdFormat":{"type":"string"},"issuerUri":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"authorizationUri":{"type":"string"},"tokenUri":{"type":"string"},"jwkSetUri":{"type":"string"},"userInfoUri":{"type":"string"},"userNameAttribute":{"type":"string"}}}}}} ``` ## The EngagementActionTimeConfig object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EngagementActionTimeConfig":{"type":"object","properties":{"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"}}}}}} ``` ## The SilentManagersConfigurationRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SilentManagersConfigurationRequest":{"type":"object","properties":{"silentManagers":{"type":"boolean"},"allowedManagersEmails":{"type":"array","items":{"type":"string"},"uniqueItems":true}}}}}} ``` ## The CompanySetupRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySetupRequestDTO":{"type":"object","properties":{"industryType":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"feedbackLevelMode":{"$ref":"#/components/schemas/FeedbackLevelMode"},"companyName":{"type":"string"},"defaultLanguage":{"type":"string"},"timezone":{"type":"string"},"domains":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]}}}} ``` ## The CompanyCustomizationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCustomizationDTO":{"type":"object","properties":{"employeeInvitation":{"$ref":"#/components/schemas/MultiLanguage"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The CompanyCommentReplyRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCommentReplyRequest":{"type":"object","properties":{"message":{"type":"string"},"messageType":{"type":"integer","format":"int32"},"signed":{"type":"boolean"}}}}}} ``` ## The CompanySegmentBase object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentBase":{"type":"object","discriminator":{"propertyName":"questionType"},"properties":{"segmentKey":{"$ref":"#/components/schemas/CompanySegmentKey"},"description":{"type":"string"},"question":{"$ref":"#/components/schemas/MultiLanguage"},"createdOn":{"type":"string","format":"date-time"},"updatedOn":{"type":"string","format":"date-time"},"coreId":{"type":"string"},"privated":{"type":"boolean"},"originalId":{"type":"string","deprecated":true},"questionType":{"$ref":"#/components/schemas/CharacteristicType"},"allActiveOptionIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"CompanySegmentKey":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The CompanySegmentDate object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentDate":{"allOf":[{"$ref":"#/components/schemas/CompanySegmentBase"},{"type":"object","properties":{"ranges":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentDateRange"},"uniqueItems":true},"deletedRanges":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentDateRange"},"uniqueItems":true}}}]},"CompanySegmentBase":{"type":"object","discriminator":{"propertyName":"questionType"},"properties":{"segmentKey":{"$ref":"#/components/schemas/CompanySegmentKey"},"description":{"type":"string"},"question":{"$ref":"#/components/schemas/MultiLanguage"},"createdOn":{"type":"string","format":"date-time"},"updatedOn":{"type":"string","format":"date-time"},"coreId":{"type":"string"},"privated":{"type":"boolean"},"originalId":{"type":"string","deprecated":true},"questionType":{"$ref":"#/components/schemas/CharacteristicType"},"allActiveOptionIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"CompanySegmentKey":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"CompanySegmentDateRange":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"integer","format":"int32"},"fromType":{"$ref":"#/components/schemas/DateGroupingTypes"},"to":{"type":"integer","format":"int32"},"toType":{"$ref":"#/components/schemas/DateGroupingTypes"},"name":{"type":"string"}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]}}}} ``` ## The CompanySegmentDateRange object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentDateRange":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"integer","format":"int32"},"fromType":{"$ref":"#/components/schemas/DateGroupingTypes"},"to":{"type":"integer","format":"int32"},"toType":{"$ref":"#/components/schemas/DateGroupingTypes"},"name":{"type":"string"}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]}}}} ``` ## The CompanySegmentKey object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentKey":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"}}}}}} ``` ## The CompanySegmentList object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentList":{"allOf":[{"$ref":"#/components/schemas/CompanySegmentBase"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentListItem"}},"deletedValues":{"type":"array","items":{"$ref":"#/components/schemas/CompanySegmentListItem"}}}}]},"CompanySegmentBase":{"type":"object","discriminator":{"propertyName":"questionType"},"properties":{"segmentKey":{"$ref":"#/components/schemas/CompanySegmentKey"},"description":{"type":"string"},"question":{"$ref":"#/components/schemas/MultiLanguage"},"createdOn":{"type":"string","format":"date-time"},"updatedOn":{"type":"string","format":"date-time"},"coreId":{"type":"string"},"privated":{"type":"boolean"},"originalId":{"type":"string","deprecated":true},"questionType":{"$ref":"#/components/schemas/CharacteristicType"},"allActiveOptionIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"CompanySegmentKey":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"CompanySegmentListItem":{"type":"object","properties":{"id":{"type":"string"},"value":{"$ref":"#/components/schemas/MultiLanguage"},"position":{"type":"integer","format":"int32"}}}}}} ``` ## The CompanySegmentListItem object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanySegmentListItem":{"type":"object","properties":{"id":{"type":"string"},"value":{"$ref":"#/components/schemas/MultiLanguage"},"position":{"type":"integer","format":"int32"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The AnnouncementTranslateRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementTranslateRequestDTO":{"type":"object","properties":{"sectionId":{"type":"string"},"languageCode":{"type":"string"},"title":{"type":"string"},"content":{"type":"string"},"resume":{"type":"string"}}}}}} ``` ## The AnnouncementTranslationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementTranslationDTO":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"content":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The RegistrationRequest object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RegistrationRequest":{"type":"object","properties":{"redirect_uris":{"type":"array","items":{"type":"string"}},"grant_types":{"type":"array","items":{"type":"string"}},"scope":{"type":"string"},"client_name":{"type":"string"}}}}}} ``` ## The PaginableGenericListResultTimesheetPublic object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultTimesheetPublic":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetPublic"}}}},"TimesheetPublic":{"type":"object","description":"Single public timesheet entry","properties":{"email":{"type":"string","description":"Employee email for this entry, when resolved"},"externalId":{"type":"string","description":"Employee external id when configured in Happyforce"},"timeZone":{"type":"string","description":"IANA timezone ID stored on this timesheet entry when provided by the client"},"id":{"type":"string","description":"Timesheet entry ID"},"startTime":{"type":"string","format":"date-time","description":"Start time of the entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the entry"},"active":{"type":"boolean","description":"Whether the entry is active"},"breaks":{"type":"array","description":"Break intervals inside the entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type"},"changeHistory":{"type":"array","description":"Historical modifications applied to this timesheet","items":{"$ref":"#/components/schemas/TimesheetChangeHistory"}}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"TimesheetChangeHistory":{"type":"object","description":"Historical change entry for a timesheet","properties":{"startTime":{"type":"string","format":"date-time","description":"Start time registered in this historical version"},"endTime":{"type":"string","format":"date-time","description":"End time registered in this historical version"},"breaks":{"type":"array","description":"Break intervals registered in this historical version","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type for this historical version"},"changeReason":{"type":"string","description":"Reason that explains this change"},"changedBy":{"$ref":"#/components/schemas/TimesheetChangedBy","description":"User that applied this change (email and external id when available)"},"changedAt":{"type":"string","format":"date-time","description":"Timestamp when this change was applied"}}},"TimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The TimesheetChangeHistory object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetChangeHistory":{"type":"object","description":"Historical change entry for a timesheet","properties":{"startTime":{"type":"string","format":"date-time","description":"Start time registered in this historical version"},"endTime":{"type":"string","format":"date-time","description":"End time registered in this historical version"},"breaks":{"type":"array","description":"Break intervals registered in this historical version","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type for this historical version"},"changeReason":{"type":"string","description":"Reason that explains this change"},"changedBy":{"$ref":"#/components/schemas/TimesheetChangedBy","description":"User that applied this change (email and external id when available)"},"changedAt":{"type":"string","format":"date-time","description":"Timestamp when this change was applied"}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"TimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The TimesheetChangedBy object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The TimesheetPublic object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetPublic":{"type":"object","description":"Single public timesheet entry","properties":{"email":{"type":"string","description":"Employee email for this entry, when resolved"},"externalId":{"type":"string","description":"Employee external id when configured in Happyforce"},"timeZone":{"type":"string","description":"IANA timezone ID stored on this timesheet entry when provided by the client"},"id":{"type":"string","description":"Timesheet entry ID"},"startTime":{"type":"string","format":"date-time","description":"Start time of the entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the entry"},"active":{"type":"boolean","description":"Whether the entry is active"},"breaks":{"type":"array","description":"Break intervals inside the entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type"},"changeHistory":{"type":"array","description":"Historical modifications applied to this timesheet","items":{"$ref":"#/components/schemas/TimesheetChangeHistory"}}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"TimesheetChangeHistory":{"type":"object","description":"Historical change entry for a timesheet","properties":{"startTime":{"type":"string","format":"date-time","description":"Start time registered in this historical version"},"endTime":{"type":"string","format":"date-time","description":"End time registered in this historical version"},"breaks":{"type":"array","description":"Break intervals registered in this historical version","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type for this historical version"},"changeReason":{"type":"string","description":"Reason that explains this change"},"changedBy":{"$ref":"#/components/schemas/TimesheetChangedBy","description":"User that applied this change (email and external id when available)"},"changedAt":{"type":"string","format":"date-time","description":"Timestamp when this change was applied"}}},"TimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The DeletedTimesheetChangeHistory object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DeletedTimesheetChangeHistory":{"type":"object","description":"Historical change entry before deletion","properties":{"startTime":{"type":"string","format":"date-time","description":"Start time registered in this historical version"},"endTime":{"type":"string","format":"date-time","description":"End time registered in this historical version"},"breaks":{"type":"array","description":"Break intervals registered in this historical version","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type for this historical version"},"changeReason":{"type":"string","description":"Reason that explains this change"},"changedBy":{"$ref":"#/components/schemas/DeletedTimesheetChangedBy","description":"User that applied this change (email and external id when available)"},"changedAt":{"type":"string","format":"date-time","description":"Timestamp when this change was applied"}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"DeletedTimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The DeletedTimesheetChangedBy object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DeletedTimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The DeletedTimesheetPublic object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DeletedTimesheetPublic":{"type":"object","description":"Single public deleted timesheet entry","properties":{"email":{"type":"string","description":"Employee email for this entry, when resolved"},"externalId":{"type":"string","description":"Employee external id when configured in Happyforce"},"timeZone":{"type":"string","description":"IANA timezone ID stored on this timesheet entry when provided by the client"},"id":{"type":"string","description":"Deleted timesheet record ID"},"originalTimesheetId":{"type":"string","description":"Original timesheet ID before deletion"},"startTime":{"type":"string","format":"date-time","description":"Start time of the original entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the original entry"},"breaks":{"type":"array","description":"Break intervals inside the original entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type"},"changeHistory":{"type":"array","description":"Historical modifications applied before deletion","items":{"$ref":"#/components/schemas/DeletedTimesheetChangeHistory"}},"deletedAt":{"type":"string","format":"date-time","description":"Deletion timestamp"},"deletedBy":{"type":"string","description":"User ID that deleted the timesheet"},"deletedReason":{"type":"string","description":"Reason for deleting the timesheet"}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"DeletedTimesheetChangeHistory":{"type":"object","description":"Historical change entry before deletion","properties":{"startTime":{"type":"string","format":"date-time","description":"Start time registered in this historical version"},"endTime":{"type":"string","format":"date-time","description":"End time registered in this historical version"},"breaks":{"type":"array","description":"Break intervals registered in this historical version","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type for this historical version"},"changeReason":{"type":"string","description":"Reason that explains this change"},"changedBy":{"$ref":"#/components/schemas/DeletedTimesheetChangedBy","description":"User that applied this change (email and external id when available)"},"changedAt":{"type":"string","format":"date-time","description":"Timestamp when this change was applied"}}},"DeletedTimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The PaginableGenericListResultDeletedTimesheetPublic object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultDeletedTimesheetPublic":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeletedTimesheetPublic"}}}},"DeletedTimesheetPublic":{"type":"object","description":"Single public deleted timesheet entry","properties":{"email":{"type":"string","description":"Employee email for this entry, when resolved"},"externalId":{"type":"string","description":"Employee external id when configured in Happyforce"},"timeZone":{"type":"string","description":"IANA timezone ID stored on this timesheet entry when provided by the client"},"id":{"type":"string","description":"Deleted timesheet record ID"},"originalTimesheetId":{"type":"string","description":"Original timesheet ID before deletion"},"startTime":{"type":"string","format":"date-time","description":"Start time of the original entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the original entry"},"breaks":{"type":"array","description":"Break intervals inside the original entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type"},"changeHistory":{"type":"array","description":"Historical modifications applied before deletion","items":{"$ref":"#/components/schemas/DeletedTimesheetChangeHistory"}},"deletedAt":{"type":"string","format":"date-time","description":"Deletion timestamp"},"deletedBy":{"type":"string","description":"User ID that deleted the timesheet"},"deletedReason":{"type":"string","description":"Reason for deleting the timesheet"}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"DeletedTimesheetChangeHistory":{"type":"object","description":"Historical change entry before deletion","properties":{"startTime":{"type":"string","format":"date-time","description":"Start time registered in this historical version"},"endTime":{"type":"string","format":"date-time","description":"End time registered in this historical version"},"breaks":{"type":"array","description":"Break intervals registered in this historical version","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Timesheet period type for this historical version"},"changeReason":{"type":"string","description":"Reason that explains this change"},"changedBy":{"$ref":"#/components/schemas/DeletedTimesheetChangedBy","description":"User that applied this change (email and external id when available)"},"changedAt":{"type":"string","format":"date-time","description":"Timestamp when this change was applied"}}},"DeletedTimesheetChangedBy":{"type":"object","description":"User reference for a timesheet change","properties":{"email":{"type":"string","description":"User email when available"},"externalId":{"type":"string","description":"User external id when configured in Happyforce"}}}}}} ``` ## The DataQuality object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The ScoreFactorStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreFactorStats":{"type":"object","description":"Self contained model that contains the results for a given score factor","properties":{"factorId":{"type":"string","description":"Id of the factor, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for this factor"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"},"questions":{"type":"array","description":"Questions used to compute the factor result","items":{"$ref":"#/components/schemas/ScoreQuestionStats"},"uniqueItems":true}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ScoreQuestionStats":{"type":"object","description":"Self contained model that contains the metadata for a given score question result","properties":{"questionId":{"type":"string","description":"Id of the question, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for the question"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"}}}}}} ``` ## The ScoreQuestionStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreQuestionStats":{"type":"object","description":"Self contained model that contains the metadata for a given score question result","properties":{"questionId":{"type":"string","description":"Id of the question, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for the question"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ScoreStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStats":{"type":"object","description":"Contains a Score stats during a period for a given period. It contains on the root of the object the last result, and on the dateResults field, the results for a given period","properties":{"scoreId":{"type":"string","description":"Id of the score"},"from":{"type":"string","format":"date-time","description":"Date from where the stats of this results start"},"to":{"type":"string","format":"date-time","description":"Date from where the stats of this results ends"},"result":{"type":"number","format":"double","description":"Result for the given score"},"std":{"type":"number","format":"double","description":"Standard deviation of score results"},"variance":{"type":"number","format":"double","description":"Variance of score results"},"p10":{"type":"number","format":"double","description":"10th percentile of score results"},"p25":{"type":"number","format":"double","description":"25th percentile of score results"},"p50":{"type":"number","format":"double","description":"50th percentile of score results"},"p75":{"type":"number","format":"double","description":"75th percentile of score results"},"p90":{"type":"number","format":"double","description":"90th percentile of score results"},"iqr":{"type":"number","format":"double","description":"Interquartile range of score results"},"cv":{"type":"number","format":"double","description":"Coefficient of variation of score results"},"outliersLow":{"type":"integer","format":"int32","description":"Number of low-end outliers in score results"},"outliersHigh":{"type":"integer","format":"int32","description":"Number of high-end outliers in score results"},"multimodal":{"type":"boolean","description":"Whether distribution appears multimodal"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"expectedParticipants":{"type":"integer","format":"int32","description":"The expected participants"},"dateResults":{"type":"array","description":"Results by date for the given score. (for each iteration requested)","items":{"$ref":"#/components/schemas/ScoreStatsDateResult"}},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"factors":{"type":"array","description":"Individual results for each factor composing the score","items":{"$ref":"#/components/schemas/ScoreFactorStats"}},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the score"}}},"ScoreStatsDateResult":{"type":"object","description":"Self contained model that contains the results for a given score","properties":{"date":{"type":"string","format":"date-time","description":"Date of beginning of the measurement on this result. Usually the period is one month"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"expectedParticipants":{"type":"integer","format":"int32","description":"The expected participants"},"result":{"type":"number","format":"double","description":"Result for the given score on that period"},"std":{"type":"number","format":"double","description":"Standard deviation of score results"},"variance":{"type":"number","format":"double","description":"Variance of score results"},"p10":{"type":"number","format":"double","description":"10th percentile of score results"},"p25":{"type":"number","format":"double","description":"25th percentile of score results"},"p50":{"type":"number","format":"double","description":"50th percentile of score results"},"p75":{"type":"number","format":"double","description":"75th percentile of score results"},"p90":{"type":"number","format":"double","description":"90th percentile of score results"},"iqr":{"type":"number","format":"double","description":"Interquartile range of score results"},"cv":{"type":"number","format":"double","description":"Coefficient of variation of score results"},"outliersLow":{"type":"integer","format":"int32","description":"Number of low-end outliers in score results"},"outliersHigh":{"type":"integer","format":"int32","description":"Number of high-end outliers in score results"},"multimodal":{"type":"boolean","description":"Whether distribution appears multimodal"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"factors":{"type":"array","description":"Individual results for each factor composing the score","items":{"$ref":"#/components/schemas/ScoreFactorStats"},"uniqueItems":true},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the score"}}},"ScoreFactorStats":{"type":"object","description":"Self contained model that contains the results for a given score factor","properties":{"factorId":{"type":"string","description":"Id of the factor, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for this factor"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"},"questions":{"type":"array","description":"Questions used to compute the factor result","items":{"$ref":"#/components/schemas/ScoreQuestionStats"},"uniqueItems":true}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ScoreQuestionStats":{"type":"object","description":"Self contained model that contains the metadata for a given score question result","properties":{"questionId":{"type":"string","description":"Id of the question, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for the question"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"}}}}}} ``` ## The ScoreStatsDateResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStatsDateResult":{"type":"object","description":"Self contained model that contains the results for a given score","properties":{"date":{"type":"string","format":"date-time","description":"Date of beginning of the measurement on this result. Usually the period is one month"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"expectedParticipants":{"type":"integer","format":"int32","description":"The expected participants"},"result":{"type":"number","format":"double","description":"Result for the given score on that period"},"std":{"type":"number","format":"double","description":"Standard deviation of score results"},"variance":{"type":"number","format":"double","description":"Variance of score results"},"p10":{"type":"number","format":"double","description":"10th percentile of score results"},"p25":{"type":"number","format":"double","description":"25th percentile of score results"},"p50":{"type":"number","format":"double","description":"50th percentile of score results"},"p75":{"type":"number","format":"double","description":"75th percentile of score results"},"p90":{"type":"number","format":"double","description":"90th percentile of score results"},"iqr":{"type":"number","format":"double","description":"Interquartile range of score results"},"cv":{"type":"number","format":"double","description":"Coefficient of variation of score results"},"outliersLow":{"type":"integer","format":"int32","description":"Number of low-end outliers in score results"},"outliersHigh":{"type":"integer","format":"int32","description":"Number of high-end outliers in score results"},"multimodal":{"type":"boolean","description":"Whether distribution appears multimodal"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"factors":{"type":"array","description":"Individual results for each factor composing the score","items":{"$ref":"#/components/schemas/ScoreFactorStats"},"uniqueItems":true},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the score"}}},"ScoreFactorStats":{"type":"object","description":"Self contained model that contains the results for a given score factor","properties":{"factorId":{"type":"string","description":"Id of the factor, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for this factor"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"},"questions":{"type":"array","description":"Questions used to compute the factor result","items":{"$ref":"#/components/schemas/ScoreQuestionStats"},"uniqueItems":true}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ScoreQuestionStats":{"type":"object","description":"Self contained model that contains the metadata for a given score question result","properties":{"questionId":{"type":"string","description":"Id of the question, so it can be matched on the metadata API"},"result":{"type":"number","format":"double","description":"Result for the question"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"How the votes of each participants are distributed"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the factor"}}}}}} ``` ## The ValuationType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The Participation Stats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Participation Stats":{"type":"object","description":"\tContains a the participation stats for a given period.\n","properties":{"from":{"type":"string","format":"date-time","description":"Date from where the stats of this results start"},"to":{"type":"string","format":"date-time","description":"Date to where the stats of this results ends"},"participants":{"type":"integer","format":"int32","description":"Number of unique participants during the period"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the participation stats"},"newParticipants":{"type":"integer","format":"int64","description":"Number of unique participants during the period, that were not present in the previous period"},"lostParticipants":{"type":"integer","format":"int64","description":"Number of unique participants during the previous period, that are not present in the current period"},"dateResults":{"type":"array","description":"Results by date for participants","items":{"$ref":"#/components/schemas/ParticipationDateResultDTO"}}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ParticipationDateResultDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the stats"},"participants":{"type":"integer","format":"int64","description":"Number of participants on this date"}}}}}} ``` ## The ParticipationDateResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ParticipationDateResultDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the stats"},"participants":{"type":"integer","format":"int64","description":"Number of participants on this date"}}}}}} ``` ## The HIStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIStats":{"type":"object","description":"Self contained model that contains the HI stats for a certain period","properties":{"title":{"type":"string","description":"Title of the HI question"},"values":{"type":"array","description":"Allowed values for the HI question","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Votes received per type during this period"},"participants":{"type":"integer","format":"int32","description":"Number of unique participants on the period"},"expectedParticipants":{"type":"integer","format":"int32","description":"Number of expected participants on the period"},"periodIndex":{"type":"number","format":"double","description":"HI of the given period"},"dateResults":{"type":"array","description":"HI by date given period","items":{"$ref":"#/components/schemas/HIStatsDate"}}}},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"HIStatsDate":{"type":"object","description":"HI stats for a given date","properties":{"date":{"type":"string","format":"date-time"},"index":{"type":"number","format":"double"},"participants":{"type":"integer","format":"int32"}}}}}} ``` ## The HIStatsDate object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIStatsDate":{"type":"object","description":"HI stats for a given date","properties":{"date":{"type":"string","format":"date-time"},"index":{"type":"number","format":"double"},"participants":{"type":"integer","format":"int32"}}}}}} ``` ## The ENPSStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSStats":{"type":"object","description":"Contains the ENPS stats during a period for a given. It contains on the root of the object the last result, and on the dateResults field, the results for a given period","properties":{"from":{"type":"string","format":"date-time","description":"Date from where the stats of this results start"},"to":{"type":"string","format":"date-time","description":"Date to where the stats of this results ends"},"result":{"type":"number","format":"double","description":"Result for the eNPS"},"averageResult":{"type":"number","format":"double","description":"Result for the eNPS in average mode"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"expectedParticipants":{"type":"integer","format":"int32","description":"The expected participants"},"dateResults":{"type":"array","description":"Results by date for the given score. (for each iteration requested)","items":{"$ref":"#/components/schemas/ENPSStatsDateResult"}},"dectractors":{"type":"integer","format":"int32","description":"Number of detractors"},"neutral":{"type":"integer","format":"int32","description":"Number of neutral"},"promoters":{"type":"integer","format":"int32","description":"Number of promoters"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the score"}}},"ENPSStatsDateResult":{"type":"object","description":"Self contained model that contains the metadata for the eNPS","properties":{"date":{"type":"string","format":"date-time","description":"Date of beginning of the measurement on this result. Usually the period is one month"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"expectedParticipants":{"type":"integer","format":"int32","description":"The expected participants"},"result":{"type":"number","format":"double","description":"Result for the eNPS on that period"},"averageResult":{"type":"number","format":"double","description":"Result for the eNPS in average mode"},"dectractors":{"type":"integer","format":"int32","description":"Number of detractors"},"neutral":{"type":"integer","format":"int32","description":"Number of neutral"},"promoters":{"type":"integer","format":"int32","description":"Number of promoters"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the eNPS"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ENPSStatsDateResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSStatsDateResult":{"type":"object","description":"Self contained model that contains the metadata for the eNPS","properties":{"date":{"type":"string","format":"date-time","description":"Date of beginning of the measurement on this result. Usually the period is one month"},"participants":{"type":"integer","format":"int32","description":"The unique participants"},"expectedParticipants":{"type":"integer","format":"int32","description":"The expected participants"},"result":{"type":"number","format":"double","description":"Result for the eNPS on that period"},"averageResult":{"type":"number","format":"double","description":"Result for the eNPS in average mode"},"dectractors":{"type":"integer","format":"int32","description":"Number of detractors"},"neutral":{"type":"integer","format":"int32","description":"Number of neutral"},"promoters":{"type":"integer","format":"int32","description":"Number of promoters"},"quality":{"$ref":"#/components/schemas/DataQuality","description":"Quality of the measurement, based on the participation"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the eNPS"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The Activation Stats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Activation Stats":{"type":"object","description":"\tContains a the activations stats for a given period.\n\tIt contains information about the number of invited and activated users and the accumulated values.\n\tby date.\n","properties":{"from":{"type":"string","format":"date-time","description":"Date from where the stats of this results start"},"to":{"type":"string","format":"date-time","description":"Date from where the stats of this results ends"},"totalInvited":{"type":"integer","format":"int64","description":"The number of invited employees during the period"},"totalActivated":{"type":"integer","format":"int64","description":"The number of activated employees during the period"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation of the activation stats"},"dateResults":{"type":"array","description":"Results by date for activations & invitations","items":{"$ref":"#/components/schemas/ActivationStatsDateResultPublicDTO"}}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ActivationStatsDateResultPublicDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the stats"},"invited":{"type":"integer","format":"int64","description":"Number of invited employees on this date"},"invitedAccumulated":{"type":"integer","format":"int64","description":"Accumulated number of invited employees until this date"},"activated":{"type":"integer","format":"int64","description":"Number of activated employees on this date"},"activatedAccumulated":{"type":"integer","format":"int64","description":"Accumulated number of activated employees until this date"}}}}}} ``` ## The ActivationStatsDateResultPublicDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationStatsDateResultPublicDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the stats"},"invited":{"type":"integer","format":"int64","description":"Number of invited employees on this date"},"invitedAccumulated":{"type":"integer","format":"int64","description":"Accumulated number of invited employees until this date"},"activated":{"type":"integer","format":"int64","description":"Number of activated employees on this date"},"activatedAccumulated":{"type":"integer","format":"int64","description":"Accumulated number of activated employees until this date"}}}}}} ``` ## The Score object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Score":{"type":"object","description":"Self contained model that contains the metadata for a given score","properties":{"id":{"type":"string","description":"Id of the score"},"status":{"$ref":"#/components/schemas/ScoreStatuses","description":"Which is the status for a given score"},"name":{"type":"string","description":"Title of the score"},"description":{"type":"string","description":"Description of the score"},"factors":{"type":"array","description":"Factors that compose this score","items":{"$ref":"#/components/schemas/ScoreFactor"},"uniqueItems":true}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactor":{"type":"object","description":"Self contained model that contains the metadata for a given factor","properties":{"id":{"type":"string","description":"Id of the factor"},"name":{"type":"string","description":"Title of the factor"},"description":{"type":"string","description":"Description of the factor"},"questions":{"type":"array","description":"Questions that compose this factor","items":{"$ref":"#/components/schemas/ScoreQuestion"},"uniqueItems":true}}},"ScoreQuestion":{"type":"object","description":"Self contained model that contains the metadata for a given question","properties":{"id":{"type":"string","description":"Id of the question"},"title":{"type":"string","description":"Title of the question"}}}}}} ``` ## The ScoreFactor object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreFactor":{"type":"object","description":"Self contained model that contains the metadata for a given factor","properties":{"id":{"type":"string","description":"Id of the factor"},"name":{"type":"string","description":"Title of the factor"},"description":{"type":"string","description":"Description of the factor"},"questions":{"type":"array","description":"Questions that compose this factor","items":{"$ref":"#/components/schemas/ScoreQuestion"},"uniqueItems":true}}},"ScoreQuestion":{"type":"object","description":"Self contained model that contains the metadata for a given question","properties":{"id":{"type":"string","description":"Id of the question"},"title":{"type":"string","description":"Title of the question"}}}}}} ``` ## The ScoreQuestion object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreQuestion":{"type":"object","description":"Self contained model that contains the metadata for a given question","properties":{"id":{"type":"string","description":"Id of the question"},"title":{"type":"string","description":"Title of the question"}}}}}} ``` ## The Area object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Area":{"type":"object","description":"Entity representing the information for a given area or department on your account","properties":{"id":{"type":"string","description":"Id of the area"},"name":{"type":"string","description":"Name of the area"},"children":{"type":"array","description":"sub areas under this one","items":{"description":"Entity representing the information for a given area or department on your account"},"uniqueItems":true}}}}}} ``` ## The Group object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Group":{"type":"object","description":"Entity representing the information for a given group on your account. A group is a way of tagging an employee, for later segmentation","properties":{"id":{"type":"string","description":"Id of the group"},"name":{"type":"string","description":"Name of the group"}}}}}} ``` ## The Profile object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"Profile":{"type":"object","description":"Entity representing the information for a given employee","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/CharacteristicType"},"name":{"type":"string"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/ProfileValue"},"uniqueItems":true}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"ProfileValue":{"type":"object","description":"For a given LIST type profile property, details of one of the values","properties":{"id":{"type":"string","description":"Id of the value property"},"label":{"type":"string","description":"Label of the value property"}}}}}} ``` ## The ProfileValue object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ProfileValue":{"type":"object","description":"For a given LIST type profile property, details of one of the values","properties":{"id":{"type":"string","description":"Id of the value property"},"label":{"type":"string","description":"Label of the value property"}}}}}} ``` ## The AbstractInternalFeedback object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractInternalFeedback":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyName":{"type":"string"},"signature":{"$ref":"#/components/schemas/SignerDTO"},"target":{"$ref":"#/components/schemas/TargetDTO"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"replies":{"type":"integer","format":"int32"},"inappropriates":{"type":"integer","format":"int32"},"flaggedInapropriate":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"primaryImage":{"type":"string"},"privated":{"type":"boolean"},"canLike":{"type":"boolean"},"canDislike":{"type":"boolean"},"canReply":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ExternalFeedbackAttachmentDTO"}},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"}}},"SignerDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"TargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"ExternalFeedbackAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The ExternalFeedbackAttachmentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ExternalFeedbackAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}}}}} ``` ## The SignerDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SignerDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The TargetDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The AppVersionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AppVersionDTO":{"type":"object","description":"App version update information","properties":{"minimumAppVersion":{"type":"string","description":"Minimum required app version for the platform"},"forceUpdate":{"type":"boolean","description":"Whether the update is forced"},"defaultLanguage":{"type":"string","description":"Default language code"},"message":{"type":"object","additionalProperties":{"type":"string"},"description":"Update message localized by language"},"storeURL":{"type":"string","description":"Store URL for the platform (App Store, Play Store, etc.)"}}}}}} ``` ## The BaseStatsResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"BaseStatsResultDTO":{"type":"object","description":"Base stats result: date range, total comments, total votes, hierarchy name.","properties":{"from":{"type":"string","format":"date-time","description":"Start date of the period"},"to":{"type":"string","format":"date-time","description":"End date of the period"},"totalComments":{"type":"integer","format":"int64","description":"Total number of comments"},"totalVotes":{"type":"integer","format":"int64","description":"Total number of votes"},"hierarchyName":{"type":"string","description":"Name of the hierarchy (area) this result applies to"},"companyEmployeeQuestion":{"$ref":"#/components/schemas/QuestionInfoDTO"},"questionType":{"type":"string"}}},"QuestionInfoDTO":{"type":"object","description":"Question info (summary): id, title, type, values, date range, representation, feedback mode, max comment length, feedback types.","properties":{"id":{"type":"string","description":"Question identifier"},"title":{"type":"string","description":"Question title"},"questionType":{"$ref":"#/components/schemas/QuestionType","description":"Question type (e.g. HI, CHECK_IN)"},"values":{"type":"array","description":"Available values/options","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"from":{"type":"string","format":"date-time","description":"Start date of the question period"},"to":{"type":"string","format":"date-time","description":"End date of the question period"},"representation":{"type":"string","description":"How the question is represented (e.g. scale, list)","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"feedbackMode":{"$ref":"#/components/schemas/FeedbackMode","description":"Feedback mode for comments"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length"},"feedbackTypes":{"type":"array","description":"Feedback types available for this question","items":{"$ref":"#/components/schemas/QuestionFeedbackDTO"},"uniqueItems":true}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"FeedbackMode":{"type":"string","enum":["ON_VOTE","AFTER_VOTE","ON_AND_AFTER_VOTE","NO_FEEDBACK","INLINE"]},"QuestionFeedbackDTO":{"type":"object","description":"Feedback type configuration for a question: type, privacy, signature, max length, target, image.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. SUGGESTION, RECOGNITION)"},"privateEnabled":{"type":"boolean","description":"Whether private comments are enabled"},"nonAnonymousEnabled":{"type":"boolean","description":"Whether non-anonymous (signed) comments are enabled"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length (default 3000)"},"targeted":{"type":"boolean","description":"Whether comments can be targeted (e.g. to a person or area)"},"imageURL":{"type":"string","description":"URL of the image for this feedback type"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The QuestionFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionFeedbackDTO":{"type":"object","description":"Feedback type configuration for a question: type, privacy, signature, max length, target, image.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. SUGGESTION, RECOGNITION)"},"privateEnabled":{"type":"boolean","description":"Whether private comments are enabled"},"nonAnonymousEnabled":{"type":"boolean","description":"Whether non-anonymous (signed) comments are enabled"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length (default 3000)"},"targeted":{"type":"boolean","description":"Whether comments can be targeted (e.g. to a person or area)"},"imageURL":{"type":"string","description":"URL of the image for this feedback type"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The QuestionInfoDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionInfoDTO":{"type":"object","description":"Question info (summary): id, title, type, values, date range, representation, feedback mode, max comment length, feedback types.","properties":{"id":{"type":"string","description":"Question identifier"},"title":{"type":"string","description":"Question title"},"questionType":{"$ref":"#/components/schemas/QuestionType","description":"Question type (e.g. HI, CHECK_IN)"},"values":{"type":"array","description":"Available values/options","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"from":{"type":"string","format":"date-time","description":"Start date of the question period"},"to":{"type":"string","format":"date-time","description":"End date of the question period"},"representation":{"type":"string","description":"How the question is represented (e.g. scale, list)","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"feedbackMode":{"$ref":"#/components/schemas/FeedbackMode","description":"Feedback mode for comments"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length"},"feedbackTypes":{"type":"array","description":"Feedback types available for this question","items":{"$ref":"#/components/schemas/QuestionFeedbackDTO"},"uniqueItems":true}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"FeedbackMode":{"type":"string","enum":["ON_VOTE","AFTER_VOTE","ON_AND_AFTER_VOTE","NO_FEEDBACK","INLINE"]},"QuestionFeedbackDTO":{"type":"object","description":"Feedback type configuration for a question: type, privacy, signature, max length, target, image.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. SUGGESTION, RECOGNITION)"},"privateEnabled":{"type":"boolean","description":"Whether private comments are enabled"},"nonAnonymousEnabled":{"type":"boolean","description":"Whether non-anonymous (signed) comments are enabled"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length (default 3000)"},"targeted":{"type":"boolean","description":"Whether comments can be targeted (e.g. to a person or area)"},"imageURL":{"type":"string","description":"URL of the image for this feedback type"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The PaginableGenericListResultPersonTimesheetDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultPersonTimesheetDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimesheetDTO"}}}},"PersonTimesheetDTO":{"type":"object","description":"DTO representing a person's timesheet entry","properties":{"id":{"type":"string","description":"Timesheet entry ID"},"personId":{"type":"string","description":"Person ID"},"startTime":{"type":"string","format":"date-time","description":"Start time of the timesheet entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the timesheet entry"},"isActive":{"type":"boolean","description":"Whether the timesheet entry is currently active"},"isEditable":{"type":"boolean","description":"Whether the timesheet entry can be edited"},"breaks":{"type":"array","description":"List of break times during this timesheet entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Type of timesheet period"},"timeZone":{"type":"string","description":"IANA timezone ID stored for this entry when provided by the client"},"changeHistory":{"type":"array","description":"Historical modifications applied to this timesheet entry","items":{"$ref":"#/components/schemas/PersonTimesheetChangeDTO"}}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"PersonTimesheetChangeDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType"},"changeReason":{"type":"string"},"changedBy":{"type":"string"},"changedAt":{"type":"string","format":"date-time"}}}}}} ``` ## The PeriodTimesheetDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PeriodTimesheetDTO":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"byPersonTimeSheet":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimesheetDTO"}}},"totalCount":{"type":"integer","format":"int64"}}},"PersonTimesheetDTO":{"type":"object","description":"DTO representing a person's timesheet entry","properties":{"id":{"type":"string","description":"Timesheet entry ID"},"personId":{"type":"string","description":"Person ID"},"startTime":{"type":"string","format":"date-time","description":"Start time of the timesheet entry"},"endTime":{"type":"string","format":"date-time","description":"End time of the timesheet entry"},"isActive":{"type":"boolean","description":"Whether the timesheet entry is currently active"},"isEditable":{"type":"boolean","description":"Whether the timesheet entry can be edited"},"breaks":{"type":"array","description":"List of break times during this timesheet entry","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType","description":"Type of timesheet period"},"timeZone":{"type":"string","description":"IANA timezone ID stored for this entry when provided by the client"},"changeHistory":{"type":"array","description":"Historical modifications applied to this timesheet entry","items":{"$ref":"#/components/schemas/PersonTimesheetChangeDTO"}}}},"PersonTimesheetBreakDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"PeriodTimeSheetType":{"type":"string","description":"Type of timesheet period (active, vacation, bank holiday, sick leave, day off)","enum":["ACTIVE","VACATION","BANK_HOLIDAY","SICK_LEAVE","DAY_OFF"]},"PersonTimesheetChangeDTO":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimesheetBreakDTO"}},"periodType":{"$ref":"#/components/schemas/PeriodTimeSheetType"},"changeReason":{"type":"string"},"changedBy":{"type":"string"},"changedAt":{"type":"string","format":"date-time"}}}}}} ``` ## The EmployeeTermsAndConditionsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeTermsAndConditionsDTO":{"type":"object","description":"Terms and conditions: id, title, detail, and full content.","properties":{"id":{"type":"string","description":"Terms document identifier"},"title":{"type":"string","description":"Title"},"detail":{"type":"string","description":"Short detail or summary"},"content":{"type":"string","description":"Full content (e.g. HTML)"}}}}}} ``` ## The SurveyPendingStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyPendingStatusDTO":{"type":"object","description":"Pending survey/round status: ids, title, description, dates, question counts, time, signature mode, mandatory.","properties":{"roundId":{"type":"string","description":"Survey round identifier"},"surveyId":{"type":"string","description":"Survey identifier"},"title":{"type":"string","description":"Title"},"description":{"type":"string","description":"Description"},"imagePath":{"type":"string","description":"URL or path to the image"},"endDate":{"type":"string","format":"date-time","description":"End date"},"totalQuestions":{"type":"integer","format":"int32","description":"Total number of questions"},"pendingQuestions":{"type":"integer","format":"int32","description":"Number of pending questions"},"totalTime":{"type":"integer","format":"int32","description":"Total time (e.g. in minutes)"},"signatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode"},"mandatory":{"type":"boolean","description":"Whether the survey is mandatory"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}}} ``` ## The EmployeeStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeStatusResponse":{"type":"object","properties":{"configCompleted":{"type":"boolean"},"requireVote":{"type":"boolean"},"pendingAnnouncements":{"type":"boolean"},"pendingSurveys":{"type":"boolean"}}}}}} ``` ## The EmployeeTimeZoneInfo object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeTimeZoneInfo":{"type":"object","properties":{"timezone":{"type":"string"},"alertDays":{"type":"array","items":{"type":"integer","format":"int32"}},"alertHour":{"type":"integer","format":"int32"},"alertMinute":{"type":"integer","format":"int32"}}}}}} ``` ## The GlobalStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GlobalStatsDTO":{"type":"object","description":"An extension of a the base Hierarchy Stats, containing the evolution, scores, votes distribution and sub children","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"hi":{"type":"number","format":"double"},"hiVariation":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participation":{"type":"number","format":"double"},"votes":{"type":"integer","format":"int64"},"hiEvolution":{"type":"array","items":{"$ref":"#/components/schemas/HIDateResultDTO"}},"votesDistribution":{"type":"array","items":{"$ref":"#/components/schemas/VotesDistributionDTO"}},"scores":{"type":"array","items":{"$ref":"#/components/schemas/ScoreStatsDTO"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyStatsDTO"}},"ranking":{"type":"array","items":{"$ref":"#/components/schemas/HIAreaRankingResultDTO"}}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"HIDateResultDTO":{"type":"object","description":"Date based results of the HI","properties":{"date":{"type":"string","format":"date-time"},"hi":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"VotesDistributionDTO":{"type":"object","description":"How the votes are distributed","properties":{"value":{"$ref":"#/components/schemas/QuestionValueDTO"},"votesPercent":{"type":"number","format":"double"},"overallVotesPercent":{"type":"number","format":"double"}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"ScoreStatsDTO":{"type":"object","description":"Score stats: score, value, valuation, variation, date range.","properties":{"score":{"$ref":"#/components/schemas/ScoreDTO","description":"Score definition"},"value":{"type":"number","format":"double","description":"Current value"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation type"},"variation":{"type":"number","format":"double","description":"Variation"},"from":{"type":"string","format":"date-time","description":"Start date"},"to":{"type":"string","format":"date-time","description":"End date"}}},"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"HierarchyStatsDTO":{"type":"object","description":"Base Hierarchy / Segment stats DTO. It contains information about the HI, participation, votes, etc.","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"hi":{"type":"number","format":"double"},"hiVariation":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participation":{"type":"number","format":"double"},"votes":{"type":"integer","format":"int64"}}},"HIAreaRankingResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"hi":{"type":"number","format":"double"},"hiVariation":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participation":{"type":"number","format":"double"},"votes":{"type":"integer","format":"int64"},"position":{"type":"integer","format":"int32"}}}}}} ``` ## The HIAreaRankingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIAreaRankingResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"hi":{"type":"number","format":"double"},"hiVariation":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participation":{"type":"number","format":"double"},"votes":{"type":"integer","format":"int64"},"position":{"type":"integer","format":"int32"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The HIDateResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIDateResultDTO":{"type":"object","description":"Date based results of the HI","properties":{"date":{"type":"string","format":"date-time"},"hi":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The HierarchyStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HierarchyStatsDTO":{"type":"object","description":"Base Hierarchy / Segment stats DTO. It contains information about the HI, participation, votes, etc.","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"hi":{"type":"number","format":"double"},"hiVariation":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participation":{"type":"number","format":"double"},"votes":{"type":"integer","format":"int64"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ScoreStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStatsDTO":{"type":"object","description":"Score stats: score, value, valuation, variation, date range.","properties":{"score":{"$ref":"#/components/schemas/ScoreDTO","description":"Score definition"},"value":{"type":"number","format":"double","description":"Current value"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation type"},"variation":{"type":"number","format":"double","description":"Variation"},"from":{"type":"string","format":"date-time","description":"Start date"},"to":{"type":"string","format":"date-time","description":"End date"}}},"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The VotesDistributionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"VotesDistributionDTO":{"type":"object","description":"How the votes are distributed","properties":{"value":{"$ref":"#/components/schemas/QuestionValueDTO"},"votesPercent":{"type":"number","format":"double"},"overallVotesPercent":{"type":"number","format":"double"}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The ScoreDetailedStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreDetailedStatsDTO":{"allOf":[{"$ref":"#/components/schemas/ScoreStatsDTO"},{"type":"object","properties":{"score":{"$ref":"#/components/schemas/ScoreDTO","description":"Score definition"},"value":{"type":"number","format":"double","description":"Current value"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation type"},"variation":{"type":"number","format":"double","description":"Variation"},"from":{"type":"string","format":"date-time","description":"Start date"},"to":{"type":"string","format":"date-time","description":"End date"},"pendingQuestions":{"type":"integer","format":"int32","description":"Number of pending questions"},"factors":{"type":"array","description":"Results per factor","items":{"$ref":"#/components/schemas/ScoreFactorResultDTO"}},"lastValue":{"type":"number","format":"double","description":"Last submitted value"}}}],"description":"Detailed score stats: variation, pending questions, factor results, last value."},"ScoreStatsDTO":{"type":"object","description":"Score stats: score, value, valuation, variation, date range.","properties":{"score":{"$ref":"#/components/schemas/ScoreDTO","description":"Score definition"},"value":{"type":"number","format":"double","description":"Current value"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation type"},"variation":{"type":"number","format":"double","description":"Variation"},"from":{"type":"string","format":"date-time","description":"Start date"},"to":{"type":"string","format":"date-time","description":"End date"}}},"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ScoreFactorResultDTO":{"type":"object","description":"Score factor result: factor, value, valuation, variation.","properties":{"factor":{"$ref":"#/components/schemas/ScoreFactorDTO","description":"Score factor definition"},"value":{"type":"number","format":"double","description":"Value"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation type"},"variation":{"type":"number","format":"double","description":"Variation"}}}}}} ``` ## The ScoreFactorResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreFactorResultDTO":{"type":"object","description":"Score factor result: factor, value, valuation, variation.","properties":{"factor":{"$ref":"#/components/schemas/ScoreFactorDTO","description":"Score factor definition"},"value":{"type":"number","format":"double","description":"Value"},"valuation":{"$ref":"#/components/schemas/ValuationType","description":"Valuation type"},"variation":{"type":"number","format":"double","description":"Variation"}}},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The PaginableGenericListResultBaseStatsResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultBaseStatsResultDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BaseStatsResultDTO"}}}},"BaseStatsResultDTO":{"type":"object","description":"Base stats result: date range, total comments, total votes, hierarchy name.","properties":{"from":{"type":"string","format":"date-time","description":"Start date of the period"},"to":{"type":"string","format":"date-time","description":"End date of the period"},"totalComments":{"type":"integer","format":"int64","description":"Total number of comments"},"totalVotes":{"type":"integer","format":"int64","description":"Total number of votes"},"hierarchyName":{"type":"string","description":"Name of the hierarchy (area) this result applies to"},"companyEmployeeQuestion":{"$ref":"#/components/schemas/QuestionInfoDTO"},"questionType":{"type":"string"}}},"QuestionInfoDTO":{"type":"object","description":"Question info (summary): id, title, type, values, date range, representation, feedback mode, max comment length, feedback types.","properties":{"id":{"type":"string","description":"Question identifier"},"title":{"type":"string","description":"Question title"},"questionType":{"$ref":"#/components/schemas/QuestionType","description":"Question type (e.g. HI, CHECK_IN)"},"values":{"type":"array","description":"Available values/options","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"from":{"type":"string","format":"date-time","description":"Start date of the question period"},"to":{"type":"string","format":"date-time","description":"End date of the question period"},"representation":{"type":"string","description":"How the question is represented (e.g. scale, list)","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"feedbackMode":{"$ref":"#/components/schemas/FeedbackMode","description":"Feedback mode for comments"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length"},"feedbackTypes":{"type":"array","description":"Feedback types available for this question","items":{"$ref":"#/components/schemas/QuestionFeedbackDTO"},"uniqueItems":true}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"FeedbackMode":{"type":"string","enum":["ON_VOTE","AFTER_VOTE","ON_AND_AFTER_VOTE","NO_FEEDBACK","INLINE"]},"QuestionFeedbackDTO":{"type":"object","description":"Feedback type configuration for a question: type, privacy, signature, max length, target, image.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. SUGGESTION, RECOGNITION)"},"privateEnabled":{"type":"boolean","description":"Whether private comments are enabled"},"nonAnonymousEnabled":{"type":"boolean","description":"Whether non-anonymous (signed) comments are enabled"},"maxCommentLength":{"type":"integer","format":"int32","description":"Maximum comment length (default 3000)"},"targeted":{"type":"boolean","description":"Whether comments can be targeted (e.g. to a person or area)"},"imageURL":{"type":"string","description":"URL of the image for this feedback type"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The HIHierarchyStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIHierarchyStatsDTO":{"type":"object","description":"HI stats per hierarchy: hierarchy, index rating, variation, valuation, votes.","properties":{"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO"},"indexRating":{"type":"number","format":"double"},"indexVariation":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"votes":{"type":"integer","format":"int64"}}},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The PaginableGenericListResultEmployeeNotificationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultEmployeeNotificationDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeNotificationDTO"}}}},"EmployeeNotificationDTO":{"type":"object","description":"Employee notification: id, title, image, date, seen, target type, and target id.","properties":{"id":{"type":"string","description":"Notification identifier"},"title":{"type":"string","description":"Notification title"},"imagePath":{"type":"string","description":"URL or path to the notification image"},"date":{"type":"string","format":"date-time","description":"Date and time of the notification"},"seen":{"type":"boolean","description":"Whether the notification has been seen"},"targetType":{"$ref":"#/components/schemas/NotificationTargetType","description":"Type of target this notification refers to"},"targetId":{"type":"string","description":"ID of the target (comment, conversation, announcement, etc.)"}}},"NotificationTargetType":{"type":"string","description":"Type of target: COMMENT, CONVERSATION, ANNOUNCEMENT, QUESTION, SUGGESTION, PERSONAL_REPORT, NONE","enum":["COMMENT","CONVERSATION","ANNOUNCEMENT","QUESTION","SUGGESTION","PERSONAL_REPORT","NONE"]}}}} ``` ## The MeEngagementDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeEngagementDTO":{"type":"object","description":"Engagement values for the current user: personal, team, and company values and valuations.","properties":{"personalValue":{"type":"number","format":"double"},"personalValuation":{"$ref":"#/components/schemas/ValuationType"},"teamValue":{"type":"number","format":"double"},"teamValuation":{"$ref":"#/components/schemas/ValuationType"},"teamName":{"type":"string"},"companyValue":{"type":"number","format":"double"},"companyName":{"type":"string"},"companyValuation":{"$ref":"#/components/schemas/ValuationType"},"maxValue":{"type":"number","format":"double"},"totalQuestionsCount":{"type":"integer","format":"int32"},"currentQuestionsCount":{"type":"integer","format":"int32"},"outdatedQuestionsCount":{"type":"integer","format":"int32"},"ageQuality":{"$ref":"#/components/schemas/DataQuality"},"amountQuality":{"$ref":"#/components/schemas/DataQuality"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The MeOverviewDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeOverviewDTO":{"type":"object","description":"Overview for the current user: flags for votes, engagement, HI details, personal report; minimum votes; deprecated HI/distribution fields.","properties":{"hasEnoughVotes":{"type":"boolean"},"hasEngagement":{"type":"boolean"},"hasHiDetails":{"type":"boolean"},"hasPersonalReport":{"type":"boolean"},"minimumVotes":{"type":"integer","format":"int32"},"hi":{"type":"number","format":"double","deprecated":true},"periodDays":{"type":"integer","format":"int32","deprecated":true},"totalVotes":{"type":"integer","format":"int32","deprecated":true},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32","deprecated":true},"deprecated":true},"votesByDate":{"type":"object","additionalProperties":{"type":"integer","format":"int32","deprecated":true},"deprecated":true},"questionValues":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"engagementResume":{"$ref":"#/components/schemas/MeEngagementDTO","deprecated":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"MeEngagementDTO":{"type":"object","description":"Engagement values for the current user: personal, team, and company values and valuations.","properties":{"personalValue":{"type":"number","format":"double"},"personalValuation":{"$ref":"#/components/schemas/ValuationType"},"teamValue":{"type":"number","format":"double"},"teamValuation":{"$ref":"#/components/schemas/ValuationType"},"teamName":{"type":"string"},"companyValue":{"type":"number","format":"double"},"companyName":{"type":"string"},"companyValuation":{"$ref":"#/components/schemas/ValuationType"},"maxValue":{"type":"number","format":"double"},"totalQuestionsCount":{"type":"integer","format":"int32"},"currentQuestionsCount":{"type":"integer","format":"int32"},"outdatedQuestionsCount":{"type":"integer","format":"int32"},"ageQuality":{"$ref":"#/components/schemas/DataQuality"},"amountQuality":{"$ref":"#/components/schemas/DataQuality"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The MeStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeStatusDTO":{"type":"object","description":"Current user status: whether there is an unseen personal report.","properties":{"unSeenPersonalReport":{"type":"boolean","description":"Whether the user has an unseen personal report"}}}}}} ``` ## The MePersonalReportStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MePersonalReportStatusDTO":{"type":"object","description":"Personal report status: enabled, has current report, pending/completed actions for next report.","properties":{"enabled":{"type":"boolean","description":"Whether personal reports are enabled for the user"},"hasCurrentPersonalReport":{"type":"boolean","description":"Whether the user has a report for the current month"},"pendingForNextReport":{"type":"integer","format":"int32","description":"Number of actions (e.g. score questions) pending for the next report"},"completedForNextReport":{"type":"integer","format":"int32","description":"Number of actions completed for the next report"}}}}}} ``` ## The MeHIStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeHIStatusDTO":{"type":"object","description":"HI status for the current user: HI value, period, total votes, distribution, votes by date, question values, valuation.","properties":{"hi":{"type":"number","format":"double"},"periodDays":{"type":"integer","format":"int32"},"totalVotes":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"votesByDate":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questionValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The MeHIVotesDistributionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeHIVotesDistributionDTO":{"type":"object","description":"HI votes distribution for the current user: distribution map, question values, total votes, period days.","properties":{"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questionValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"totalVotes":{"type":"integer","format":"int32"},"periodDays":{"type":"integer","format":"int32"}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The MeHICalendarDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeHICalendarDTO":{"type":"object","description":"HI calendar for the current user: date range, votes by date, total votes, HI value, dates with notes, question values.","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"hasEnoughVotes":{"type":"boolean"},"totalVotes":{"type":"integer","format":"int32"},"hi":{"type":"number","format":"double"},"votesByDate":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"hasNoteOnDates":{"type":"array","items":{"type":"string","format":"date"}},"questionValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The PaginableGenericListResultMeHICalendarDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultMeHICalendarDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/MeHICalendarDTO"}}}},"MeHICalendarDTO":{"type":"object","description":"HI calendar for the current user: date range, votes by date, total votes, HI value, dates with notes, question values.","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"hasEnoughVotes":{"type":"boolean"},"totalVotes":{"type":"integer","format":"int32"},"hi":{"type":"number","format":"double"},"votesByDate":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"hasNoteOnDates":{"type":"array","items":{"type":"string","format":"date"}},"questionValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}}}}} ``` ## The MeHICalendarNoteDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"MeHICalendarNoteDTO":{"type":"object","description":"Note for a date in the HI calendar.","properties":{"note":{"type":"string","description":"Note text"}}}}}} ``` ## The CompanyInfoDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyInfoDTO":{"type":"object","description":"Company info: name and image path.","properties":{"companyName":{"type":"string","description":"Company name"},"companyImagePath":{"type":"string","description":"URL or path to the company image"}}}}}} ``` ## The InfoMessageDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InfoMessageDTO":{"type":"object","description":"Informational message with type (e.g. HTML) and content.","properties":{"type":{"$ref":"#/components/schemas/InfoMessageType","description":"Message type"},"content":{"type":"string","description":"Message content (e.g. HTML string)"}}},"InfoMessageType":{"type":"string","description":"Type of info message: HTML","enum":["HTML"]}}}} ``` ## The InfoMessageType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InfoMessageType":{"type":"string","description":"Type of info message: HTML","enum":["HTML"]}}}} ``` ## The PaginableGenericListResultInfoMessageDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultInfoMessageDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InfoMessageDTO"}}}},"InfoMessageDTO":{"type":"object","description":"Informational message with type (e.g. HTML) and content.","properties":{"type":{"$ref":"#/components/schemas/InfoMessageType","description":"Message type"},"content":{"type":"string","description":"Message content (e.g. HTML string)"}}},"InfoMessageType":{"type":"string","description":"Type of info message: HTML","enum":["HTML"]}}}} ``` ## The AbstractFeedbackTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractFeedbackTypeDTO":{"type":"object","description":"Base configuration for a feedback type (e.g. RECOGNITION, SUGGESTION). Defines privacy, signature, target mode, attachments, verification, and limits.","properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type identifier (e.g. RECOGNITION, SUGGESTION, CRITICISM)"},"privateMode":{"$ref":"#/components/schemas/FeedbackPrivacyMode","description":"Privacy mode for this feedback type"},"signatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode: ANONYMOUS, OPTIONAL, MANDATORY, etc."},"targetMode":{"$ref":"#/components/schemas/FeedbackTargetMode","description":"Target mode (e.g. free target, hierarchy)"},"allowedAttachementTypes":{"type":"array","description":"Allowed attachment types for comments of this feedback type","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresVerification":{"type":"boolean","description":"Whether comments of this type require verification before publishing"},"maxLength":{"type":"integer","format":"int32","description":"Maximum allowed length for the message"},"imageURL":{"type":"string","description":"URL of the image/icon representing this feedback type"},"feedbackLevelMode":{"$ref":"#/components/schemas/FeedbackLevelMode","description":"Feedback level mode configuration"},"availableCommentCount":{"type":"integer","format":"int64","description":"Number of comments still available for the user in this feedback type"},"defaultSignatureMode":{"$ref":"#/components/schemas/DefaultSignatureType","description":"Default signature mode for this feedback type. Indicates whether the anonymous toggle should default to SIGNED (non-anonymous) or ANONYMOUS"}},"required":["type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackPrivacyMode":{"type":"string","enum":["OPEN","OPTIONAL","MANDATORY"]},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"FeedbackTargetMode":{"type":"string","description":"FeedbackTargetMode.","enum":["NO_TARGET","FREE_TARGET","LIST_TARGET","LIST_FREE_TARGET"]},"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]},"DefaultSignatureType":{"type":"string","description":"Default signature mode for feedback types. SIGNED means the comment will be non-anonymous by default, ANONYMOUS means it will be anonymous by default.","enum":["SIGNED","ANONYMOUS"]}}}} ``` ## The DefaultSignatureType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DefaultSignatureType":{"type":"string","description":"Default signature mode for feedback types. SIGNED means the comment will be non-anonymous by default, ANONYMOUS means it will be anonymous by default.","enum":["SIGNED","ANONYMOUS"]}}}} ``` ## The RecognitionFeedbackTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionFeedbackTypeDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractFeedbackTypeDTO"},{"type":"object","properties":{"values":{"type":"array","description":"List of recognition values (badges, categories) available for this feedback type","items":{"$ref":"#/components/schemas/RecognitionValueDTO"}}}}],"description":"Configuration for RECOGNITION feedback type. Includes list of recognition values (e.g. badges) that can be selected.","required":["type"]},"AbstractFeedbackTypeDTO":{"type":"object","description":"Base configuration for a feedback type (e.g. RECOGNITION, SUGGESTION). Defines privacy, signature, target mode, attachments, verification, and limits.","properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type identifier (e.g. RECOGNITION, SUGGESTION, CRITICISM)"},"privateMode":{"$ref":"#/components/schemas/FeedbackPrivacyMode","description":"Privacy mode for this feedback type"},"signatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode: ANONYMOUS, OPTIONAL, MANDATORY, etc."},"targetMode":{"$ref":"#/components/schemas/FeedbackTargetMode","description":"Target mode (e.g. free target, hierarchy)"},"allowedAttachementTypes":{"type":"array","description":"Allowed attachment types for comments of this feedback type","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresVerification":{"type":"boolean","description":"Whether comments of this type require verification before publishing"},"maxLength":{"type":"integer","format":"int32","description":"Maximum allowed length for the message"},"imageURL":{"type":"string","description":"URL of the image/icon representing this feedback type"},"feedbackLevelMode":{"$ref":"#/components/schemas/FeedbackLevelMode","description":"Feedback level mode configuration"},"availableCommentCount":{"type":"integer","format":"int64","description":"Number of comments still available for the user in this feedback type"},"defaultSignatureMode":{"$ref":"#/components/schemas/DefaultSignatureType","description":"Default signature mode for this feedback type. Indicates whether the anonymous toggle should default to SIGNED (non-anonymous) or ANONYMOUS"}},"required":["type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackPrivacyMode":{"type":"string","enum":["OPEN","OPTIONAL","MANDATORY"]},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"FeedbackTargetMode":{"type":"string","description":"FeedbackTargetMode.","enum":["NO_TARGET","FREE_TARGET","LIST_TARGET","LIST_FREE_TARGET"]},"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]},"DefaultSignatureType":{"type":"string","description":"Default signature mode for feedback types. SIGNED means the comment will be non-anonymous by default, ANONYMOUS means it will be anonymous by default.","enum":["SIGNED","ANONYMOUS"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The StandardFeedbackTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"StandardFeedbackTypeDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractFeedbackTypeDTO"}],"description":"Configuration for standard feedback types (e.g. SUGGESTION, CONGRATULATION, CRITICISM).","required":["type"]},"AbstractFeedbackTypeDTO":{"type":"object","description":"Base configuration for a feedback type (e.g. RECOGNITION, SUGGESTION). Defines privacy, signature, target mode, attachments, verification, and limits.","properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type identifier (e.g. RECOGNITION, SUGGESTION, CRITICISM)"},"privateMode":{"$ref":"#/components/schemas/FeedbackPrivacyMode","description":"Privacy mode for this feedback type"},"signatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode: ANONYMOUS, OPTIONAL, MANDATORY, etc."},"targetMode":{"$ref":"#/components/schemas/FeedbackTargetMode","description":"Target mode (e.g. free target, hierarchy)"},"allowedAttachementTypes":{"type":"array","description":"Allowed attachment types for comments of this feedback type","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresVerification":{"type":"boolean","description":"Whether comments of this type require verification before publishing"},"maxLength":{"type":"integer","format":"int32","description":"Maximum allowed length for the message"},"imageURL":{"type":"string","description":"URL of the image/icon representing this feedback type"},"feedbackLevelMode":{"$ref":"#/components/schemas/FeedbackLevelMode","description":"Feedback level mode configuration"},"availableCommentCount":{"type":"integer","format":"int64","description":"Number of comments still available for the user in this feedback type"},"defaultSignatureMode":{"$ref":"#/components/schemas/DefaultSignatureType","description":"Default signature mode for this feedback type. Indicates whether the anonymous toggle should default to SIGNED (non-anonymous) or ANONYMOUS"}},"required":["type"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"FeedbackPrivacyMode":{"type":"string","enum":["OPEN","OPTIONAL","MANDATORY"]},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"FeedbackTargetMode":{"type":"string","description":"FeedbackTargetMode.","enum":["NO_TARGET","FREE_TARGET","LIST_TARGET","LIST_FREE_TARGET"]},"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]},"DefaultSignatureType":{"type":"string","description":"Default signature mode for feedback types. SIGNED means the comment will be non-anonymous by default, ANONYMOUS means it will be anonymous by default.","enum":["SIGNED","ANONYMOUS"]}}}} ``` ## The FeedbackTargetGroupDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackTargetGroupDTO":{"type":"object","description":"Group of feedback targets (e.g. hierarchy or list of people).","properties":{"id":{"type":"string","description":"Unique identifier of the target group"},"name":{"type":"string","description":"Display name of the group"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Target type (e.g. hierarchy, free target)"},"targets":{"type":"array","description":"List of targets in this group","items":{"$ref":"#/components/schemas/FeedbackTargetDTO"}}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"FeedbackTargetDTO":{"type":"object","description":"To who is targeted this feedback?","properties":{"name":{"type":"string","description":"To who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET"},"description":{"type":"string","description":"Description of the target: Area, Manager name, or Employee Name. Just for FREE_TARGET, LIST_FREE_TARGET"},"id":{"type":"string","description":"The ID to who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET feedback types"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Which target type is this? is directed to someone or to a team"}}}}}} ``` ## The FeedbackStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackStatusDTO":{"type":"object","description":"Count of unread comments: private and public.","properties":{"unreadPrivate":{"type":"integer","format":"int32","description":"Number of unread private comments"},"unreadPublic":{"type":"integer","format":"int32","description":"Number of unread public comments"}}}}}} ``` ## The QuestionCommentsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionCommentsDTO":{"type":"object","description":"Paginated list of comments for a question, with question info and range (from, to, total).","properties":{"question":{"$ref":"#/components/schemas/QuestionDTO","description":"The question these comments belong to"},"from":{"type":"integer","format":"int32","description":"Start index of the returned page"},"to":{"type":"integer","format":"int32","description":"End index of the returned page"},"total":{"type":"integer","format":"int64","description":"Total number of comments"},"comments":{"type":"array","description":"List of comments in this page","items":{"$ref":"#/components/schemas/EmployeeCommentDTO"}}}},"QuestionDTO":{"type":"object","description":"The details of the question to be created","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"primary":{"type":"boolean"},"createdOn":{"type":"string","format":"date-time"},"activationDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"resultValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"notifyByPush":{"type":"boolean"},"notifyByMail":{"type":"boolean"},"notified":{"type":"boolean"},"privated":{"type":"boolean"},"nonAnonymous":{"type":"boolean"},"requireNotEmpty":{"type":"boolean","deprecated":true},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"feedbackEnabled":{"type":"boolean"},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/QuestionStatus"},"activationRule":{"$ref":"#/components/schemas/QuestionActivationRuleDTO"},"activations":{"type":"array","items":{"$ref":"#/components/schemas/QuestionActivationDTO"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionStatus":{"type":"string","description":"Status of a question in a survey or questionnaire","enum":["ANY","ACTIVE","PENDING","EXPIRED","PAUSED","ARCHIVED"]},"QuestionActivationRuleDTO":{"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"cronExpression":{"type":"string"},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]},"QuestionActivationDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"EmployeeCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"questionId":{"type":"string","description":"Question ID when the comment is in a question context"},"announcementNumber":{"type":"string","deprecated":true,"description":"Deprecated. Announcement number reference."},"conversationId":{"type":"string","description":"Conversation ID if this comment started or belongs to a conversation"},"replied":{"type":"boolean","description":"Whether this comment has been replied to"},"allowReply":{"type":"boolean","description":"Whether replies are allowed for this comment"},"requiresReplyVerification":{"type":"boolean","description":"Whether a reply must pass verification/moderation before being published"},"replySignatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode required for replies (e.g. ANONYMOUS, MANDATORY)"},"allowNotAnonymousReply":{"type":"boolean","deprecated":true,"description":"Deprecated. Replaced by replySignatureMode and other flags."},"allowStartConversation":{"type":"boolean","description":"Whether the user can start a conversation from this comment"},"allowedReplyAttachmentTypes":{"type":"array","description":"Attachment types allowed when replying (e.g. IMAGE)","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentReplyDTO"}},"target":{"$ref":"#/components/schemas/FeedbackTargetDTO","description":"Target (e.g. hierarchy or group) this comment is associated with"},"status":{"$ref":"#/components/schemas/FeedbackCycleStatusDTO","description":"Status of the feedback cycle this comment belongs to"},"context":{"description":"Context of the comment (e.g. SURVEY, QUESTION, ANNOUNCEMENT) with type-specific data","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentContextDTO"},{"$ref":"#/components/schemas/ENPSContextDTO"},{"$ref":"#/components/schemas/QuestionContextDTO"},{"$ref":"#/components/schemas/ScoreContextDTO"},{"$ref":"#/components/schemas/SurveyContextDTO"}]}}}],"description":"Top-level employee comment. Extends base comment with question/conversation ids, reply settings, target, status, and context."},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"FeedbackContainerPreviewDTO":{"type":"object","description":"Lightweight preview of a feedback container (id, type, title, image).","properties":{"id":{"type":"string","description":"Unique identifier of the container"},"type":{"$ref":"#/components/schemas/FeedbackContainerType","description":"Container type (e.g. IDEA_INITIATIVE)"},"title":{"type":"string","description":"Title of the container"},"imageUrl":{"type":"string","description":"URL of the container image"}}},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"CommentFeedbackTypeDTO":{"type":"object","deprecated":true,"description":"Deprecated. Feedback type with image URL. Use feedback-type-specific configuration instead.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. RECOGNITION, SUGGESTION)"},"imageURL":{"type":"string","description":"URL of the image/icon for this feedback type"}}},"EmployeeCommentAttachmentDTO":{"type":"object","description":"Attachment linked to a comment (e.g. image) with type and file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string","description":"URL of the attached file"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"EmployeeCommentReplyDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"highlightScore":{"type":"integer","format":"int32","description":"Score used to highlight or order this reply"}}}],"description":"Reply to an employee comment. Extends base comment with highlight score for ordering/display."},"FeedbackTargetDTO":{"type":"object","description":"To who is targeted this feedback?","properties":{"name":{"type":"string","description":"To who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET"},"description":{"type":"string","description":"Description of the target: Area, Manager name, or Employee Name. Just for FREE_TARGET, LIST_FREE_TARGET"},"id":{"type":"string","description":"The ID to who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET feedback types"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Which target type is this? is directed to someone or to a team"}}},"FeedbackCycleStatusDTO":{"type":"object","description":"Status of a feedback cycle: color, label, and description (e.g. approved, in review).","properties":{"color":{"type":"string","description":"Color code for the status (e.g. for UI)"},"label":{"type":"string","description":"Short label for the status"},"description":{"type":"string","description":"Description of the status"}}},"AnnouncementCommentContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"announcementId":{"type":"string","description":"ID of the announcement this comment belongs to"}}}],"description":"Comment context when the comment is on an announcement."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"ENPSContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the ENPS question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Selected or displayed question value"}}}],"description":"Comment context when the comment is in an ENPS (eNPS) question context."},"QuestionContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is on a question (e.g. HI, check-in)."},"ScoreContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"scoreName":{"type":"string","description":"Name of the score"},"factorName":{"type":"string","description":"Name of the factor"},"questionTitle":{"type":"string","description":"Title of the question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value for the score"}}}],"description":"Comment context when the comment is in a score (factor/question) context."},"SurveyContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"roundTitle":{"type":"string","description":"Title of the survey round"},"questionTitle":{"type":"string","description":"Title of the survey question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is in a survey (round title, question title, question values)."}}}} ``` ## The FeedbackWallDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackWallDTO":{"type":"object","description":"Feedback wall: id, title, display order, and whether it is the default wall.","properties":{"wallId":{"type":"string","description":"Unique identifier of the wall"},"title":{"type":"string","description":"Title of the wall"},"order":{"type":"integer","format":"int32","description":"Display order"},"byDefault":{"type":"boolean","description":"Whether this wall is the default"}}}}}} ``` ## The IdeaInitiativeContainerStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IdeaInitiativeContainerStatus":{"type":"string","description":"Status of the idea/initiative container: ONGOING, NEAR_END","enum":["ONGOING","NEAR_END"]}}}} ``` ## The PaginableGenericListResultAbstractFeedbackContainerDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultAbstractFeedbackContainerDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FeedbackIdeaInitiativeContainerDTO"}]}}}},"FeedbackIdeaInitiativeContainerDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractFeedbackContainerDTO"},{"type":"object","properties":{"description":{"$ref":"#/components/schemas/MultiLanguage"},"owner":{"type":"string"},"sendNotification":{"type":"boolean"},"nonAnonymous":{"type":"boolean"}}},{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IdeaInitiativeContainerStatus","description":"Current status: ONGOING or NEAR_END"},"description":{"type":"string","description":"Description of the idea/initiative"},"owner":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature (owner) of the container"},"nonAnonymous":{"type":"boolean","description":"Whether the container allows non-anonymous participation"}}}]},"AbstractFeedbackContainerDTO":{"type":"object","discriminator":{"propertyName":"type"},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updateOn":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"draft":{"type":"boolean"},"archived":{"type":"boolean"},"type":{"$ref":"#/components/schemas/FeedbackContainerType"},"status":{"$ref":"#/components/schemas/FeedbackContainerStatus"},"numComments":{"type":"integer","format":"int32"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"FeedbackContainerStatus":{"type":"string","enum":["ONGOING","EXPIRED","SCHEDULED","ARCHIVED","DRAFT"]},"IdeaInitiativeContainerStatus":{"type":"string","description":"Status of the idea/initiative container: ONGOING, NEAR_END","enum":["ONGOING","NEAR_END"]},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}}}}} ``` ## The EmployeeDataInfo object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeDataInfo":{"type":"object","properties":{"email":{"type":"string"},"companyName":{"type":"string"},"companyId":{"type":"string"},"sessionToken":{"type":"string"},"language":{"type":"string"}}}}}} ``` ## The PaginableGenericListResultConversationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultConversationDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConversationDTO"}}}},"ConversationDTO":{"allOf":[{"$ref":"#/components/schemas/ConversationHeaderDTO"},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"name":{"type":"string"},"commentId":{"type":"string"},"updated":{"type":"boolean"},"updatedOn":{"type":"string","format":"date-time"},"title":{"type":"string","deprecated":true},"hierarchyName":{"type":"string","deprecated":true},"imagePath":{"type":"string"},"owned":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"messages":{"type":"array","description":"Messages in this conversation","items":{"$ref":"#/components/schemas/ConversationMessageDTO"}}}}],"description":"Full conversation: header fields plus list of messages."},"ConversationHeaderDTO":{"type":"object","description":"Conversation header: id, type, name, comment id, updated, dates, owner, signature, and messages.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"name":{"type":"string"},"commentId":{"type":"string"},"updated":{"type":"boolean"},"updatedOn":{"type":"string","format":"date-time"},"title":{"type":"string","deprecated":true},"hierarchyName":{"type":"string","deprecated":true},"imagePath":{"type":"string"},"owned":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ConversationMessageDTO"}}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"ConversationMessageDTO":{"type":"object","description":"Single message in a conversation: date, text, user type, seen, owned, anonymous, signature.","properties":{"date":{"type":"string","format":"date-time","description":"Message date and time"},"message":{"type":"string","description":"Message text"},"userType":{"$ref":"#/components/schemas/UserType","description":"Type of user who sent the message"},"seen":{"type":"boolean","description":"Whether the message has been seen"},"owned":{"type":"boolean","description":"Whether the message is from the current user"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature when not anonymous"},"anonymous":{"type":"boolean"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The ConversationsStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationsStatusDTO":{"type":"object","description":"Conversations status: unread count and total count.","properties":{"unread":{"type":"integer","format":"int32","description":"Number of unread conversations"},"total":{"type":"integer","format":"int32","description":"Total number of conversations"}}}}}} ``` ## The ConversationStarterSuggestionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationStarterSuggestionDTO":{"type":"object","description":"Suggested conversation starter for a context (e.g. a comment): starter text and reason.","properties":{"starter":{"type":"string","description":"Suggested text to start the conversation"},"reason":{"type":"string","description":"Reason or context for suggesting this starter"}}}}}} ``` ## The AnniversaryContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnniversaryContentDTO":{"allOf":[{"$ref":"#/components/schemas/ExtraContentDTO"},{"type":"object","properties":{"title":{"type":"string","description":"Title of the anniversary content"},"body":{"type":"string","description":"Body text"}}}],"description":"Anniversary/celebration content: title and body. Extends extra content (media, type, shareable)."},"ExtraContentDTO":{"type":"object","description":"Base class for extra content (quote, celebration): media, type, shareable. Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"QUOTE":"#/components/schemas/QuoteContentDTO","CELEBRATION":"#/components/schemas/AnniversaryContentDTO"}},"properties":{"media":{"type":"string","description":"Media URL or identifier"},"mediaType":{"$ref":"#/components/schemas/ExtraContentMediaType","description":"Type of media"},"type":{"$ref":"#/components/schemas/ExtraContentType","description":"Content type: QUOTE, CELEBRATION, OTHER"},"shareable":{"type":"boolean","description":"Whether this content can be shared"}},"required":["type"]},"ExtraContentMediaType":{"type":"string","description":"Media type: IMAGE, VIDEO, NONE","enum":["IMAGE","VIDEO","NONE"]},"ExtraContentType":{"type":"string","description":"Type of extra content (quote, birthday, work anniversary, etc.)","enum":["HAS_QUOTE","HAS_BIRTHDAY","HAS_WORK_ANNIVERSARY","cookie","NONE","VOTE_STORE"]}}}} ``` ## The ExtraContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ExtraContentDTO":{"type":"object","description":"Base class for extra content (quote, celebration): media, type, shareable. Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"QUOTE":"#/components/schemas/QuoteContentDTO","CELEBRATION":"#/components/schemas/AnniversaryContentDTO"}},"properties":{"media":{"type":"string","description":"Media URL or identifier"},"mediaType":{"$ref":"#/components/schemas/ExtraContentMediaType","description":"Type of media"},"type":{"$ref":"#/components/schemas/ExtraContentType","description":"Content type: QUOTE, CELEBRATION, OTHER"},"shareable":{"type":"boolean","description":"Whether this content can be shared"}},"required":["type"]},"ExtraContentMediaType":{"type":"string","description":"Media type: IMAGE, VIDEO, NONE","enum":["IMAGE","VIDEO","NONE"]},"ExtraContentType":{"type":"string","description":"Type of extra content (quote, birthday, work anniversary, etc.)","enum":["HAS_QUOTE","HAS_BIRTHDAY","HAS_WORK_ANNIVERSARY","cookie","NONE","VOTE_STORE"]}}}} ``` ## The ExtraContentMediaType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ExtraContentMediaType":{"type":"string","description":"Media type: IMAGE, VIDEO, NONE","enum":["IMAGE","VIDEO","NONE"]}}}} ``` ## The QuoteContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuoteContentDTO":{"allOf":[{"$ref":"#/components/schemas/ExtraContentDTO"},{"type":"object","properties":{"quote":{"type":"string","description":"Quote text"},"author":{"type":"string","description":"Author of the quote"}}}],"description":"Quote content: quote text and author. Extends extra content (media, type, shareable)."},"ExtraContentDTO":{"type":"object","description":"Base class for extra content (quote, celebration): media, type, shareable. Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"QUOTE":"#/components/schemas/QuoteContentDTO","CELEBRATION":"#/components/schemas/AnniversaryContentDTO"}},"properties":{"media":{"type":"string","description":"Media URL or identifier"},"mediaType":{"$ref":"#/components/schemas/ExtraContentMediaType","description":"Type of media"},"type":{"$ref":"#/components/schemas/ExtraContentType","description":"Content type: QUOTE, CELEBRATION, OTHER"},"shareable":{"type":"boolean","description":"Whether this content can be shared"}},"required":["type"]},"ExtraContentMediaType":{"type":"string","description":"Media type: IMAGE, VIDEO, NONE","enum":["IMAGE","VIDEO","NONE"]},"ExtraContentType":{"type":"string","description":"Type of extra content (quote, birthday, work anniversary, etc.)","enum":["HAS_QUOTE","HAS_BIRTHDAY","HAS_WORK_ANNIVERSARY","cookie","NONE","VOTE_STORE"]}}}} ``` ## The CompanyCharacteristicBaseDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCharacteristicBaseDTO":{"type":"object","description":"Base for company characteristic (employee segment): discriminated by questionType (LIST or DATE).","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/CompanyCharacteristicListDTO","DATE":"#/components/schemas/CompanyCharacteristicDateDTO"}},"properties":{"id":{"type":"string"},"question":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["question","questionType"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The CompanyCharacteristicDateDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCharacteristicDateDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"}],"description":"Company characteristic of type DATE."},"CompanyCharacteristicBaseDTO":{"type":"object","description":"Base for company characteristic (employee segment): discriminated by questionType (LIST or DATE).","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/CompanyCharacteristicListDTO","DATE":"#/components/schemas/CompanyCharacteristicDateDTO"}},"properties":{"id":{"type":"string"},"question":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["question","questionType"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]}}}} ``` ## The CompanyCharacteristicListDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCharacteristicListDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/CompanyCharacteristicListItemDTO"}}}}],"description":"Company characteristic of type LIST: list of segment values."},"CompanyCharacteristicBaseDTO":{"type":"object","description":"Base for company characteristic (employee segment): discriminated by questionType (LIST or DATE).","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/CompanyCharacteristicListDTO","DATE":"#/components/schemas/CompanyCharacteristicDateDTO"}},"properties":{"id":{"type":"string"},"question":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["question","questionType"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"CompanyCharacteristicListItemDTO":{"type":"object","description":"Single item in a list characteristic: id, value, position.","properties":{"id":{"type":"string","description":"Item identifier"},"value":{"type":"string","description":"Display value"},"position":{"type":"integer","format":"int32","description":"Display order position"}}}}}} ``` ## The CompanyCharacteristicListItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyCharacteristicListItemDTO":{"type":"object","description":"Single item in a list characteristic: id, value, position.","properties":{"id":{"type":"string","description":"Item identifier"},"value":{"type":"string","description":"Display value"},"position":{"type":"integer","format":"int32","description":"Display order position"}}}}}} ``` ## The ParticipationProfileConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ParticipationProfileConfigurationDTO":{"type":"object","description":"Participation profile configuration: hierarchy and characteristics (segments) for the user.","properties":{"hierarchy":{"type":"array","description":"Hierarchy nodes applicable to the user","items":{"$ref":"#/components/schemas/EmployeeHierarchyDTO"}},"characteristics":{"type":"array","description":"Company characteristics (segment questions) and their values","items":{"oneOf":[{"$ref":"#/components/schemas/CompanyCharacteristicDateDTO"},{"$ref":"#/components/schemas/CompanyCharacteristicListDTO"}]}}}},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"CompanyCharacteristicDateDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"}],"description":"Company characteristic of type DATE."},"CompanyCharacteristicBaseDTO":{"type":"object","description":"Base for company characteristic (employee segment): discriminated by questionType (LIST or DATE).","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/CompanyCharacteristicListDTO","DATE":"#/components/schemas/CompanyCharacteristicDateDTO"}},"properties":{"id":{"type":"string"},"question":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["question","questionType"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"CompanyCharacteristicListDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/CompanyCharacteristicListItemDTO"}}}}],"description":"Company characteristic of type LIST: list of segment values."},"CompanyCharacteristicListItemDTO":{"type":"object","description":"Single item in a list characteristic: id, value, position.","properties":{"id":{"type":"string","description":"Item identifier"},"value":{"type":"string","description":"Display value"},"position":{"type":"integer","format":"int32","description":"Display order position"}}}}}} ``` ## The QuestionCommentActionsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionCommentActionsDTO":{"type":"object","description":"Available comment actions for a question: pending counts, feedback level mode, supported reply types.","properties":{"pendingComments":{"type":"integer","format":"int64","description":"Number of pending comments"},"pendingReplies":{"type":"integer","format":"int64","description":"Number of pending replies"},"feedbackLevelMode":{"$ref":"#/components/schemas/FeedbackLevelMode","description":"Feedback level mode for this question"},"supportedReplyTypes":{"type":"array","description":"Reply types supported for this question","items":{"$ref":"#/components/schemas/ReplyTypeDTO"},"uniqueItems":true}}},"FeedbackLevelMode":{"type":"string","enum":["ANONYMOUS_OPEN","ANONYMOUS_ON_REPLY","ALL_CLOSED","NO_FEEDBACK"]},"ReplyTypeDTO":{"type":"object","description":"Reply type option: id, title, and image URL.","properties":{"id":{"type":"integer","format":"int32","description":"Reply type identifier"},"title":{"type":"string","description":"Display title"},"imageURL":{"type":"string","description":"URL of the image for this reply type"}}}}}} ``` ## The ReplyTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ReplyTypeDTO":{"type":"object","description":"Reply type option: id, title, and image URL.","properties":{"id":{"type":"integer","format":"int32","description":"Reply type identifier"},"title":{"type":"string","description":"Display title"},"imageURL":{"type":"string","description":"URL of the image for this reply type"}}}}}} ``` ## The ChatType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ChatType":{"type":"string","description":"Type of chat context","enum":["PERSONAL_CHAT"]}}}} ``` ## The ChatCommandDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ChatCommandDTO":{"type":"object","description":"Chat command: label, command identifier, optional expiry, and parameters.","properties":{"label":{"type":"string","description":"Display label for the command"},"command":{"type":"string","description":"Command identifier"},"expiresMs":{"type":"integer","format":"int64","description":"Expiration time in milliseconds (optional)"},"params":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value parameters for the command"}}}}}} ``` ## The ChatItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ChatItemDTO":{"type":"object","description":"Chat item: type (OBJECT or TEXT), ownership, content, timestamp, and optional commands.","properties":{"type":{"$ref":"#/components/schemas/ChatItemType","description":"Item type: OBJECT or TEXT"},"isOwn":{"type":"boolean","description":"Whether the message is from the current user"},"content":{"description":"Message content (object or text)"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of the message"},"commands":{"type":"array","description":"Optional commands for this item","items":{"$ref":"#/components/schemas/ChatCommandDTO"}}}},"ChatItemType":{"type":"string","description":"Chat item type: OBJECT or TEXT","enum":["OBJECT","TEXT"]},"ChatCommandDTO":{"type":"object","description":"Chat command: label, command identifier, optional expiry, and parameters.","properties":{"label":{"type":"string","description":"Display label for the command"},"command":{"type":"string","description":"Command identifier"},"expiresMs":{"type":"integer","format":"int64","description":"Expiration time in milliseconds (optional)"},"params":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value parameters for the command"}}}}}} ``` ## The ChatItemType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ChatItemType":{"type":"string","description":"Chat item type: OBJECT or TEXT","enum":["OBJECT","TEXT"]}}}} ``` ## The PaginableGenericListResultChatItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultChatItemDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ChatItemDTO"}}}},"ChatItemDTO":{"type":"object","description":"Chat item: type (OBJECT or TEXT), ownership, content, timestamp, and optional commands.","properties":{"type":{"$ref":"#/components/schemas/ChatItemType","description":"Item type: OBJECT or TEXT"},"isOwn":{"type":"boolean","description":"Whether the message is from the current user"},"content":{"description":"Message content (object or text)"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of the message"},"commands":{"type":"array","description":"Optional commands for this item","items":{"$ref":"#/components/schemas/ChatCommandDTO"}}}},"ChatItemType":{"type":"string","description":"Chat item type: OBJECT or TEXT","enum":["OBJECT","TEXT"]},"ChatCommandDTO":{"type":"object","description":"Chat command: label, command identifier, optional expiry, and parameters.","properties":{"label":{"type":"string","description":"Display label for the command"},"command":{"type":"string","description":"Command identifier"},"expiresMs":{"type":"integer","format":"int64","description":"Expiration time in milliseconds (optional)"},"params":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional key-value parameters for the command"}}}}}} ``` ## The PaginableGenericListResultAnnouncementHeaderForEmployeeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultAnnouncementHeaderForEmployeeDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementHeaderForEmployeeDTO"}}}},"AnnouncementHeaderForEmployeeDTO":{"type":"object","description":"Announcement header for employee: id, title, dates, images, categories, comments/reactions settings, signature.","properties":{"id":{"type":"string"},"title":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"announcementNumber":{"type":"string","deprecated":true},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"unSeen":{"type":"boolean"},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"pinned":{"type":"boolean","deprecated":true},"hfBranded":{"type":"boolean"},"hfBrandedAvatarPath":{"type":"string"},"hfBrandedAuthorName":{"type":"string"},"hfBrandedAuthorRole":{"type":"string"},"resume":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFileDTO"},"uniqueItems":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementCategoryDTO"}},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"reactionsEnabled":{"type":"boolean"},"liked":{"type":"boolean"},"likesCount":{"type":"integer","format":"int32"},"numComments":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowedCommentAttachmentTypes":{"type":"array","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"requiresCommentVerification":{"type":"boolean"},"commented":{"type":"boolean"},"canComment":{"type":"boolean"},"commentSignatureMode":{"$ref":"#/components/schemas/SignatureMode"}}},"CompanyFileDTO":{"type":"object","description":"Company file reference: name, file type, and path/URL.","properties":{"name":{"type":"string","description":"File name"},"fileType":{"type":"string","description":"MIME or file type"},"filePath":{"type":"string","description":"Path or URL to the file"}}},"AnnouncementCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]}}}} ``` ## The AnnouncementStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementStatusDTO":{"type":"object","description":"Announcement status for the employee: count of unread announcements.","properties":{"unread":{"type":"integer","format":"int32","description":"Number of unread announcements"}}}}}} ``` ## The AnnouncementSectionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementSectionDTO":{"type":"object","description":"Announcement section: id, title, layout, representation, listing type, search, and HTML content.","properties":{"id":{"type":"string","description":"Section identifier"},"title":{"type":"string","description":"Section title"},"layout":{"type":"string","description":"Banner layout type","enum":["HORIZONTAL","VERTICAL","HTML"]},"representation":{"type":"string","description":"Representation type","enum":["COVER","STANDARD"]},"listingType":{"type":"string","description":"Listing type","enum":["STANDARD","DATE_GROUPS","DIRECT"]},"searchEnabled":{"type":"boolean","description":"Whether search is enabled for this section"},"htmlContent":{"type":"string","description":"HTML content of the section"}}}}}} ``` ## The PaginableGenericListResultEmployeeCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultEmployeeCommentDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeCommentDTO"}}}},"EmployeeCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"questionId":{"type":"string","description":"Question ID when the comment is in a question context"},"announcementNumber":{"type":"string","deprecated":true,"description":"Deprecated. Announcement number reference."},"conversationId":{"type":"string","description":"Conversation ID if this comment started or belongs to a conversation"},"replied":{"type":"boolean","description":"Whether this comment has been replied to"},"allowReply":{"type":"boolean","description":"Whether replies are allowed for this comment"},"requiresReplyVerification":{"type":"boolean","description":"Whether a reply must pass verification/moderation before being published"},"replySignatureMode":{"$ref":"#/components/schemas/SignatureMode","description":"Signature mode required for replies (e.g. ANONYMOUS, MANDATORY)"},"allowNotAnonymousReply":{"type":"boolean","deprecated":true,"description":"Deprecated. Replaced by replySignatureMode and other flags."},"allowStartConversation":{"type":"boolean","description":"Whether the user can start a conversation from this comment"},"allowedReplyAttachmentTypes":{"type":"array","description":"Attachment types allowed when replying (e.g. IMAGE)","items":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"uniqueItems":true},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentReplyDTO"}},"target":{"$ref":"#/components/schemas/FeedbackTargetDTO","description":"Target (e.g. hierarchy or group) this comment is associated with"},"status":{"$ref":"#/components/schemas/FeedbackCycleStatusDTO","description":"Status of the feedback cycle this comment belongs to"},"context":{"description":"Context of the comment (e.g. SURVEY, QUESTION, ANNOUNCEMENT) with type-specific data","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentContextDTO"},{"$ref":"#/components/schemas/ENPSContextDTO"},{"$ref":"#/components/schemas/QuestionContextDTO"},{"$ref":"#/components/schemas/ScoreContextDTO"},{"$ref":"#/components/schemas/SurveyContextDTO"}]}}}],"description":"Top-level employee comment. Extends base comment with question/conversation ids, reply settings, target, status, and context."},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"FeedbackContainerPreviewDTO":{"type":"object","description":"Lightweight preview of a feedback container (id, type, title, image).","properties":{"id":{"type":"string","description":"Unique identifier of the container"},"type":{"$ref":"#/components/schemas/FeedbackContainerType","description":"Container type (e.g. IDEA_INITIATIVE)"},"title":{"type":"string","description":"Title of the container"},"imageUrl":{"type":"string","description":"URL of the container image"}}},"FeedbackContainerType":{"type":"string","enum":["IDEA_INITIATIVE"]},"CommentFeedbackTypeDTO":{"type":"object","deprecated":true,"description":"Deprecated. Feedback type with image URL. Use feedback-type-specific configuration instead.","properties":{"feedbackType":{"$ref":"#/components/schemas/FeedbackType","description":"Feedback type (e.g. RECOGNITION, SUGGESTION)"},"imageURL":{"type":"string","description":"URL of the image/icon for this feedback type"}}},"EmployeeCommentAttachmentDTO":{"type":"object","description":"Attachment linked to a comment (e.g. image) with type and file URL.","properties":{"type":{"type":"string","description":"Attachment type (e.g. IMAGE)","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string","description":"URL of the attached file"}}},"SignatureMode":{"type":"string","enum":["ANONYMOUS","OPTIONAL","MANDATORY","PUBLIC_MANDATORY"]},"EmployeeCommentReplyDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the comment"},"date":{"type":"string","format":"date-time","description":"Date and time when the comment was created"},"comment":{"type":"string","description":"Comment text content"},"hierarchy":{"$ref":"#/components/schemas/EmployeeHierarchyDTO","description":"Hierarchy information of the comment author (may be anonymized)"},"likes":{"type":"integer","format":"int32","description":"Number of likes received"},"liked":{"type":"boolean","description":"Whether the current user has liked this comment"},"dislikes":{"type":"integer","format":"int32","description":"Number of dislikes received"},"disliked":{"type":"boolean","description":"Whether the current user has disliked this comment"},"inappropriates":{"type":"integer","format":"int32","description":"Number of inappropriate flags"},"inappropriated":{"type":"boolean","description":"Whether the current user has flagged this as inappropriate"},"flaggedInapropriate":{"type":"boolean","description":"Whether this comment has been flagged as inappropriate"},"flaggedAnonymous":{"type":"boolean","description":"Whether the comment was posted anonymously"},"rating":{"type":"integer","format":"int32","description":"Optional rating value when the comment is tied to a question/score"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value when the comment is in a question or score context"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature information (anonymous or signed)"},"containerPreview":{"$ref":"#/components/schemas/FeedbackContainerPreviewDTO","description":"Preview of the feedback container this comment belongs to"},"html":{"type":"boolean","description":"Whether the comment content is HTML"},"sourceComment":{"type":"string","description":"Original comment text when edited or from another source"},"allowLike":{"type":"boolean","description":"Whether the current user can like this comment"},"allowDislike":{"type":"boolean","description":"Whether the current user can dislike this comment"},"allowFlagInappropriate":{"type":"boolean","description":"Whether the current user can flag this comment as inappropriate"},"feedbackType":{"$ref":"#/components/schemas/CommentFeedbackTypeDTO","deprecated":true,"description":"Deprecated. Feedback type classification for this comment."},"additionalFields":{"type":"object","additionalProperties":{},"description":"Additional fields keyed by CommentAdditionalFields enum"},"attachments":{"type":"array","description":"Attachments (e.g. images) linked to this comment","items":{"$ref":"#/components/schemas/EmployeeCommentAttachmentDTO"}},"hasBeenSeen":{"type":"boolean","description":"Whether this comment has been seen by the current user"},"highlightScore":{"type":"integer","format":"int32","description":"Score used to highlight or order this reply"}}}],"description":"Reply to an employee comment. Extends base comment with highlight score for ordering/display."},"FeedbackTargetDTO":{"type":"object","description":"To who is targeted this feedback?","properties":{"name":{"type":"string","description":"To who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET"},"description":{"type":"string","description":"Description of the target: Area, Manager name, or Employee Name. Just for FREE_TARGET, LIST_FREE_TARGET"},"id":{"type":"string","description":"The ID to who is targeted the recognition. Just for FREE_TARGET, LIST_FREE_TARGET feedback types"},"type":{"$ref":"#/components/schemas/FeedbackTargetType","description":"Which target type is this? is directed to someone or to a team"}}},"FeedbackCycleStatusDTO":{"type":"object","description":"Status of a feedback cycle: color, label, and description (e.g. approved, in review).","properties":{"color":{"type":"string","description":"Color code for the status (e.g. for UI)"},"label":{"type":"string","description":"Short label for the status"},"description":{"type":"string","description":"Description of the status"}}},"AnnouncementCommentContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"announcementId":{"type":"string","description":"ID of the announcement this comment belongs to"}}}],"description":"Comment context when the comment is on an announcement."},"AbstractCommentContextDTO":{"type":"object","description":"Base class for comment context (survey, score, question, announcement, etc.). Discriminated by type.","discriminator":{"propertyName":"type","mapping":{"SURVEY":"#/components/schemas/SurveyContextDTO","SCORE":"#/components/schemas/ScoreContextDTO","ENPS":"#/components/schemas/ENPSContextDTO","QUESTION":"#/components/schemas/QuestionContextDTO","ANNOUNCEMENT":"#/components/schemas/AnnouncementCommentContextDTO"}},"properties":{"type":{"type":"string"}},"required":["type"]},"ENPSContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the ENPS question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Selected or displayed question value"}}}],"description":"Comment context when the comment is in an ENPS (eNPS) question context."},"QuestionContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"questionTitle":{"type":"string","description":"Title of the question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is on a question (e.g. HI, check-in)."},"ScoreContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"scoreName":{"type":"string","description":"Name of the score"},"factorName":{"type":"string","description":"Name of the factor"},"questionTitle":{"type":"string","description":"Title of the question"},"questionValue":{"$ref":"#/components/schemas/QuestionValueDTO","description":"Question value for the score"}}}],"description":"Comment context when the comment is in a score (factor/question) context."},"SurveyContextDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractCommentContextDTO"},{"type":"object","properties":{"roundTitle":{"type":"string","description":"Title of the survey round"},"questionTitle":{"type":"string","description":"Title of the survey question"},"questionValues":{"type":"array","description":"Question value options or selected values","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true}}}],"description":"Comment context when the comment is in a survey (round title, question title, question values)."}}}} ``` ## The UserAppActivationTokenDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserAppActivationTokenDTO":{"type":"object","properties":{"appActivationToken":{"type":"string"}}}}}} ``` ## The PaginableGenericResultListSurveyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListSurveyDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SurveyDTO"}}}},"SurveyDTO":{"type":"object","description":"The details of the survey to be created","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"managerAccessEnabled":{"type":"boolean"},"notAnonymous":{"type":"boolean"},"canUpdate":{"type":"boolean"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"schedulePlan":{"$ref":"#/components/schemas/SurveySchedulePlanDTO"},"rounds":{"type":"array","items":{"$ref":"#/components/schemas/SurveyRoundDTO"}},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockDTOAbstractSurveyQuestion"},"minItems":1},"status":{"$ref":"#/components/schemas/SurveyStatus"},"hasReports":{"type":"boolean"}},"required":["blocks","title"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveySchedulePlanDTO":{"type":"object","description":"The details of the schedule to be updated","properties":{"roundTitle":{"$ref":"#/components/schemas/MultiLanguage"},"appSurvey":{"type":"boolean"},"mailSurvey":{"type":"boolean"},"communicationTitle":{"$ref":"#/components/schemas/MultiLanguage"},"communicationDescription":{"$ref":"#/components/schemas/MultiLanguage"},"activationRule":{"$ref":"#/components/schemas/ActivationRule"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"paused":{"type":"boolean"},"archived":{"type":"boolean"},"mandatory":{"type":"boolean"},"status":{"$ref":"#/components/schemas/SurveyStatus"}},"required":["activationRule"]},"ActivationRule":{"type":"object","description":"Base class for all activation rule types","discriminator":{"propertyName":"ruleType","mapping":{"CALENDAR":"#/components/schemas/ActivationCalendarRule","RECURRENT":"#/components/schemas/ActivationRecurrentRule","SINGLE":"#/components/schemas/ActivationSingleRule","CONTINUOUS":"#/components/schemas/ContinuousActivationRule"}},"oneOf":[{"$ref":"#/components/schemas/ActivationCalendarRule"},{"$ref":"#/components/schemas/ActivationRecurrentRule"},{"$ref":"#/components/schemas/ActivationSingleRule"},{"$ref":"#/components/schemas/ContinuousActivationRule"}],"properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"}},"required":["ruleType"]},"ActivationCalendarRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"ruleExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationCalendarRule","required":["ruleExpression","ruleType","startAt"]},"ActivationRecurrentRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"cronExpression":{"type":"string","minLength":1},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32","minimum":1}}}],"description":"ActivationRecurrentRule","required":["cronExpression","ruleType","startAt"]},"ActivationSingleRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"},{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}],"description":"ActivationSingleRule","required":["ruleType"]},"ContinuousActivationRule":{"type":"object","allOf":[{"$ref":"#/components/schemas/ActivationRule"}],"description":"ContinuousActivationRule","required":["ruleType"]},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SurveyStatus":{"type":"string","description":"Status of a survey or questionnaire","enum":["PAUSED","EXPIRED","FUTURE","NOW","ARCHIVED","DRAFT"]},"SurveyRoundDTO":{"type":"object","description":"Survey Round Data Transfer Object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"SurveyBlockDTOAbstractSurveyQuestion":{"type":"object","description":"A survey block containing a list of questions","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}}}},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}}} ``` ## The SurveyReportSimpleDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyReportSimpleDTO":{"type":"object","description":"Lightweight survey report representation for listings","properties":{"id":{"type":"string","description":"Unique identifier for this report"},"forUsers":{"type":"array","description":"User IDs for manager reports. Only populated when the report is for managers, containing the set of manager user IDs that share the same segmentation.","items":{"type":"string"},"uniqueItems":true},"targetHierarchyId":{"type":"string","description":"Target hierarchy ID for manager reports. This represents the specific hierarchy area from the manager's managed areas that this report is generated for. Null for admin reports or when not applicable."},"status":{"type":"string","description":"Status of the report generation: ONGOING (being generated), DONE (completed successfully), RETRYING (failed, will retry), FAILED (failed after max retries)","enum":["ONGOING","DONE","RETRYING","FAILED"]},"reportTypeTitle":{"$ref":"#/components/schemas/MultiLanguage","description":"Title of the report type (e.g., 'Global Report', 'Engagement Report', 'Multi-Area Report'). This field is translatable."},"characteristics":{"type":"array","description":"Employee characteristics used to filter the data analyzed in this report (e.g., department, tenure, role). Empty set means all characteristics.","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","description":"Group IDs used to filter the data analyzed in this report. Empty set means all groups.","items":{"type":"string"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The DistributionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"DistributionDTO":{"type":"object","properties":{"negative":{"type":"number","format":"double","description":"Percentage of negative responses (0-100)"},"neutral":{"type":"number","format":"double","description":"Percentage of neutral responses (0-100)"},"positive":{"type":"number","format":"double","description":"Percentage of positive responses (0-100)"}}}}}} ``` ## The SegmentContextDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SegmentContextDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValues":{"type":"array","description":"List of segment value IDs (ObjectIds) - e.g., [femaleId, maleId] or [techId]","items":{"type":"string"}},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}}}}}}} ``` ## The SegmentValueDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SegmentValueDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValueId":{"type":"string","description":"Segment value ID (ObjectId) - e.g., femaleId, maleId, techId"},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses for this segment"}}},"DistributionDTO":{"type":"object","properties":{"negative":{"type":"number","format":"double","description":"Percentage of negative responses (0-100)"},"neutral":{"type":"number","format":"double","description":"Percentage of neutral responses (0-100)"},"positive":{"type":"number","format":"double","description":"Percentage of positive responses (0-100)"}}}}}} ``` ## The SubjectDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SubjectDTO":{"type":"object","properties":{"blocks":{"type":"array","description":"List of blocks with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"questions":{"type":"array","description":"List of questions with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyQuestionResultDTO"}}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"SurveyQuestionResultDTO":{"type":"object","properties":{"question":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"questionIndex":{"type":"number","format":"double"},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"votes":{"type":"integer","format":"int32"},"skipped":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"}}}}}} ``` ## The SurveyBlockResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The SurveyParticipantsDistribution object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}}}}} ``` ## The SurveyQuestionResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyQuestionResultDTO":{"type":"object","properties":{"question":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"questionIndex":{"type":"number","format":"double"},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"votes":{"type":"integer","format":"int32"},"skipped":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"}}},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}}}}} ``` ## The SurveyReportDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyReportDTO":{"type":"object","description":"Survey report entity containing AI-generated analysis sections","properties":{"id":{"type":"string","description":"Unique identifier for this report"},"companyId":{"type":"string","description":"Company ID this report belongs to"},"surveyId":{"type":"string","description":"Survey ID this report analyzes"},"roundId":{"type":"string","description":"Survey round ID this report analyzes"},"generatedAt":{"type":"string","format":"date-time","description":"Timestamp when the report was generated"},"configId":{"type":"string","description":"The config/template ID as MongoDB ObjectId. Determines which report configuration was used."},"forUsers":{"type":"array","description":"User IDs for manager reports. Only populated when configId indicates a manager report, containing the set of manager user IDs that share the same segmentation (hierarchy, segments, groups).","items":{"type":"string"},"uniqueItems":true},"targetHierarchyId":{"type":"string","description":"Target hierarchy ID for manager reports. This represents the specific hierarchy area from the manager's managed areas that this report is generated for. Null for admin reports or when not applicable."},"reportObjective":{"type":"string","description":"Report objective or purpose that guided the AI generation (e.g., 'identify key drivers of satisfaction')"},"tone":{"type":"string","description":"Tone used in the report content (e.g., 'professional', 'conversational', 'analytical')"},"reportTypeTitle":{"$ref":"#/components/schemas/MultiLanguage","description":"Title of the report type (e.g., 'Global Report', 'Engagement Report', 'Multi-Area Report'). This field is translatable."},"hierarchyIds":{"type":"array","description":"Organizational hierarchy IDs used to filter the data analyzed in this report. Empty set means all hierarchies.","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","description":"Employee characteristics used to filter the data analyzed in this report (e.g., department, tenure, role). Empty set means all characteristics.","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","description":"Group IDs used to filter the data analyzed in this report. Empty set means all groups.","items":{"type":"string"},"uniqueItems":true},"sections":{"type":"array","description":"List of report sections containing the AI-generated analysis. Sections can be OVERVIEW (executive summary) or STANDARD (detailed analysis with evidence).","items":{"oneOf":[{"$ref":"#/components/schemas/SurveyReportOverviewSectionDTO"},{"$ref":"#/components/schemas/SurveyReportStandardSectionDTO"}]}},"scaleNormalized":{"type":"boolean","description":"Indicates if the survey index scale has been normalized (e.g., to a 0–100 scale)."},"scaleMin":{"type":"integer","format":"int32","description":"Minimum value of the survey index scale used in the analytics for this report."},"scaleMax":{"type":"integer","format":"int32","description":"Maximum value of the survey index scale used in the analytics for this report."},"reportStatus":{"type":"string","description":"Status of the report: SURVEY_ONGOING (survey not expired), ONGOING/DONE/RETRYING/FAILED (report generation status when survey is expired)","enum":["SURVEY_ONGOING","ONGOING","DONE","RETRYING","FAILED"]}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SurveyReportOverviewSectionDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/SurveyReportSectionBaseDTO"},{"type":"object","properties":{"content":{"$ref":"#/components/schemas/MultiLanguage","description":"Executive summary content in multiple languages"}}}],"description":"Overview section providing a high-level executive summary of key findings, participation metrics, and overall sentiment. This section does not include detailed evidence.","required":["type"]},"SurveyReportSectionBaseDTO":{"type":"object","description":"Base class for survey report sections. Each section contains AI-generated analysis content. Sections can be either OVERVIEW (executive summary) or STANDARD (detailed analysis with supporting evidence).","discriminator":{"propertyName":"type","mapping":{"OVERVIEW":"#/components/schemas/SurveyReportOverviewSectionDTO","STANDARD":"#/components/schemas/SurveyReportStandardSectionDTO"}},"properties":{"sectionId":{"type":"string","description":"Unique identifier for this section (matches the instruction ID used during report generation)"},"type":{"type":"string","description":"Type of section: OVERVIEW (executive summary) or STANDARD (detailed analysis with evidence)","enum":["OVERVIEW","STANDARD"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Section title in multiple languages"}},"required":["sectionId","title","type"]},"SurveyReportStandardSectionDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/SurveyReportSectionBaseDTO"},{"type":"object","properties":{"content":{"$ref":"#/components/schemas/MultiLanguage","description":"Detailed analysis content in multiple languages"},"evidences":{"type":"array","description":"List of evidence objects supporting the statements in this section. Each evidence provides analytical backing for claims made in the content.","items":{"$ref":"#/components/schemas/SurveyReportEvidenceDTO"}}}}],"description":"Standard section containing detailed analysis with supporting evidence. Includes the main content, data references, and a list of evidence objects that support the statements made in the content.","required":["type"]},"SurveyReportEvidenceDTO":{"type":"object","description":"Evidence supporting statements in survey report sections. Uses a structured format that matches the new simplified evidence types specification.","properties":{"evidenceType":{"type":"string","description":"The specific type of evidence. Valid values: SCORE_LEVEL, DOMINANT_DISTRIBUTION, HIGH_NEUTRALITY, HIGH_NEGATIVE_CONCENTRATION, SEGMENT_DIFFERENCE, SEGMENT_OUTLIER, KEY_DRIVER, ACTION_PRIORITY, STRONG_CORRELATION, NEGATIVE_CORRELATION, CORRELATION_BY_SEGMENT, SYNTHETIC_INSIGHT","enum":["SCORE_LEVEL","DOMINANT_DISTRIBUTION","HIGH_NEUTRALITY","HIGH_NEGATIVE_CONCENTRATION","SEGMENT_DIFFERENCE","SEGMENT_OUTLIER","KEY_DRIVER","ACTION_PRIORITY","STRONG_CORRELATION","NEGATIVE_CORRELATION","CORRELATION_BY_SEGMENT","SYNTHETIC_INSIGHT"]},"subject":{"$ref":"#/components/schemas/SubjectDTO","description":"The source of the evidence: which questions or blocks this evidence refers to."},"segmentContext":{"$ref":"#/components/schemas/SegmentContextDTO","description":"Optional segment context indicating which segments this evidence points to. Used for segment_difference, segment_outlier, and correlation_by_segment types. All IDs are ObjectIds."},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses in percentages (negative, neutral, positive)."},"value":{"type":"number","format":"double","description":"Numeric value for the evidence (score, correlation coefficient, driver strength, etc.)."},"values":{"type":"array","description":"Array of segment values with their distributions. Required only for segment_difference type.","items":{"$ref":"#/components/schemas/SegmentValueDTO"}},"text":{"$ref":"#/components/schemas/MultiLanguage","description":"Text content for synthetic insights in multiple languages. Required only for synthetic_insight type."},"severity":{"type":"string","description":"Severity level indicating impact and polarity (LOW_POSITIVE, MEDIUM_POSITIVE, HIGH_POSITIVE, LOW_NEGATIVE, MEDIUM_NEGATIVE, HIGH_NEGATIVE).","enum":["LOW_POSITIVE","MEDIUM_POSITIVE","HIGH_POSITIVE","LOW_NEGATIVE","MEDIUM_NEGATIVE","HIGH_NEGATIVE"]},"confidence":{"type":"number","format":"double","description":"Statistical confidence level (0.0-1.0)."},"dominant":{"type":"string","description":"Dominant sentiment in the distribution (NEGATIVE, NEUTRAL, POSITIVE).","enum":["NEGATIVE","NEUTRAL","POSITIVE"]},"correlationType":{"type":"string","description":"Type of correlation (POSITIVE, NEGATIVE).","enum":["POSITIVE","NEGATIVE"]},"strength":{"type":"string","description":"Strength of correlation or relationship (WEAK, MODERATE, STRONG).","enum":["WEAK","MODERATE","STRONG"]},"priority":{"type":"string","description":"Priority level for action items (LOW, MEDIUM, HIGH).","enum":["LOW","MEDIUM","HIGH"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Short, concise title for this evidence in multiple languages"},"description":{"$ref":"#/components/schemas/MultiLanguage","description":"Human-readable description of what this evidence shows in multiple languages"},"reference":{"type":"string","description":"Optional reference indicating what this evidence is compared against (AVERAGE, REST_OF_POPULATION, OTHER_SEGMENTS, BENCHMARK).","enum":["AVERAGE","REST_OF_POPULATION","OTHER_SEGMENTS","BENCHMARK"]},"supportingCommentIds":{"type":"array","description":"Optional list of up to 10 comment IDs that provide direct supporting evidence for this item.","items":{"type":"string"}}}},"SubjectDTO":{"type":"object","properties":{"blocks":{"type":"array","description":"List of blocks with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"questions":{"type":"array","description":"List of questions with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyQuestionResultDTO"}}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"SurveyQuestionResultDTO":{"type":"object","properties":{"question":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"questionIndex":{"type":"number","format":"double"},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"votes":{"type":"integer","format":"int32"},"skipped":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"}}},"SegmentContextDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValues":{"type":"array","description":"List of segment value IDs (ObjectIds) - e.g., [femaleId, maleId] or [techId]","items":{"type":"string"}},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}}}},"DistributionDTO":{"type":"object","properties":{"negative":{"type":"number","format":"double","description":"Percentage of negative responses (0-100)"},"neutral":{"type":"number","format":"double","description":"Percentage of neutral responses (0-100)"},"positive":{"type":"number","format":"double","description":"Percentage of positive responses (0-100)"}}},"SegmentValueDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValueId":{"type":"string","description":"Segment value ID (ObjectId) - e.g., femaleId, maleId, techId"},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses for this segment"}}}}}} ``` ## The SurveyReportEvidenceDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyReportEvidenceDTO":{"type":"object","description":"Evidence supporting statements in survey report sections. Uses a structured format that matches the new simplified evidence types specification.","properties":{"evidenceType":{"type":"string","description":"The specific type of evidence. Valid values: SCORE_LEVEL, DOMINANT_DISTRIBUTION, HIGH_NEUTRALITY, HIGH_NEGATIVE_CONCENTRATION, SEGMENT_DIFFERENCE, SEGMENT_OUTLIER, KEY_DRIVER, ACTION_PRIORITY, STRONG_CORRELATION, NEGATIVE_CORRELATION, CORRELATION_BY_SEGMENT, SYNTHETIC_INSIGHT","enum":["SCORE_LEVEL","DOMINANT_DISTRIBUTION","HIGH_NEUTRALITY","HIGH_NEGATIVE_CONCENTRATION","SEGMENT_DIFFERENCE","SEGMENT_OUTLIER","KEY_DRIVER","ACTION_PRIORITY","STRONG_CORRELATION","NEGATIVE_CORRELATION","CORRELATION_BY_SEGMENT","SYNTHETIC_INSIGHT"]},"subject":{"$ref":"#/components/schemas/SubjectDTO","description":"The source of the evidence: which questions or blocks this evidence refers to."},"segmentContext":{"$ref":"#/components/schemas/SegmentContextDTO","description":"Optional segment context indicating which segments this evidence points to. Used for segment_difference, segment_outlier, and correlation_by_segment types. All IDs are ObjectIds."},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses in percentages (negative, neutral, positive)."},"value":{"type":"number","format":"double","description":"Numeric value for the evidence (score, correlation coefficient, driver strength, etc.)."},"values":{"type":"array","description":"Array of segment values with their distributions. Required only for segment_difference type.","items":{"$ref":"#/components/schemas/SegmentValueDTO"}},"text":{"$ref":"#/components/schemas/MultiLanguage","description":"Text content for synthetic insights in multiple languages. Required only for synthetic_insight type."},"severity":{"type":"string","description":"Severity level indicating impact and polarity (LOW_POSITIVE, MEDIUM_POSITIVE, HIGH_POSITIVE, LOW_NEGATIVE, MEDIUM_NEGATIVE, HIGH_NEGATIVE).","enum":["LOW_POSITIVE","MEDIUM_POSITIVE","HIGH_POSITIVE","LOW_NEGATIVE","MEDIUM_NEGATIVE","HIGH_NEGATIVE"]},"confidence":{"type":"number","format":"double","description":"Statistical confidence level (0.0-1.0)."},"dominant":{"type":"string","description":"Dominant sentiment in the distribution (NEGATIVE, NEUTRAL, POSITIVE).","enum":["NEGATIVE","NEUTRAL","POSITIVE"]},"correlationType":{"type":"string","description":"Type of correlation (POSITIVE, NEGATIVE).","enum":["POSITIVE","NEGATIVE"]},"strength":{"type":"string","description":"Strength of correlation or relationship (WEAK, MODERATE, STRONG).","enum":["WEAK","MODERATE","STRONG"]},"priority":{"type":"string","description":"Priority level for action items (LOW, MEDIUM, HIGH).","enum":["LOW","MEDIUM","HIGH"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Short, concise title for this evidence in multiple languages"},"description":{"$ref":"#/components/schemas/MultiLanguage","description":"Human-readable description of what this evidence shows in multiple languages"},"reference":{"type":"string","description":"Optional reference indicating what this evidence is compared against (AVERAGE, REST_OF_POPULATION, OTHER_SEGMENTS, BENCHMARK).","enum":["AVERAGE","REST_OF_POPULATION","OTHER_SEGMENTS","BENCHMARK"]},"supportingCommentIds":{"type":"array","description":"Optional list of up to 10 comment IDs that provide direct supporting evidence for this item.","items":{"type":"string"}}}},"SubjectDTO":{"type":"object","properties":{"blocks":{"type":"array","description":"List of blocks with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"questions":{"type":"array","description":"List of questions with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyQuestionResultDTO"}}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"SurveyQuestionResultDTO":{"type":"object","properties":{"question":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"questionIndex":{"type":"number","format":"double"},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"votes":{"type":"integer","format":"int32"},"skipped":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"}}},"SegmentContextDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValues":{"type":"array","description":"List of segment value IDs (ObjectIds) - e.g., [femaleId, maleId] or [techId]","items":{"type":"string"}},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}}}},"DistributionDTO":{"type":"object","properties":{"negative":{"type":"number","format":"double","description":"Percentage of negative responses (0-100)"},"neutral":{"type":"number","format":"double","description":"Percentage of neutral responses (0-100)"},"positive":{"type":"number","format":"double","description":"Percentage of positive responses (0-100)"}}},"SegmentValueDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValueId":{"type":"string","description":"Segment value ID (ObjectId) - e.g., femaleId, maleId, techId"},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses for this segment"}}}}}} ``` ## The SurveyReportOverviewSectionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyReportOverviewSectionDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/SurveyReportSectionBaseDTO"},{"type":"object","properties":{"content":{"$ref":"#/components/schemas/MultiLanguage","description":"Executive summary content in multiple languages"}}}],"description":"Overview section providing a high-level executive summary of key findings, participation metrics, and overall sentiment. This section does not include detailed evidence.","required":["type"]},"SurveyReportSectionBaseDTO":{"type":"object","description":"Base class for survey report sections. Each section contains AI-generated analysis content. Sections can be either OVERVIEW (executive summary) or STANDARD (detailed analysis with supporting evidence).","discriminator":{"propertyName":"type","mapping":{"OVERVIEW":"#/components/schemas/SurveyReportOverviewSectionDTO","STANDARD":"#/components/schemas/SurveyReportStandardSectionDTO"}},"properties":{"sectionId":{"type":"string","description":"Unique identifier for this section (matches the instruction ID used during report generation)"},"type":{"type":"string","description":"Type of section: OVERVIEW (executive summary) or STANDARD (detailed analysis with evidence)","enum":["OVERVIEW","STANDARD"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Section title in multiple languages"}},"required":["sectionId","title","type"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The SurveyReportSectionBaseDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyReportSectionBaseDTO":{"type":"object","description":"Base class for survey report sections. Each section contains AI-generated analysis content. Sections can be either OVERVIEW (executive summary) or STANDARD (detailed analysis with supporting evidence).","discriminator":{"propertyName":"type","mapping":{"OVERVIEW":"#/components/schemas/SurveyReportOverviewSectionDTO","STANDARD":"#/components/schemas/SurveyReportStandardSectionDTO"}},"properties":{"sectionId":{"type":"string","description":"Unique identifier for this section (matches the instruction ID used during report generation)"},"type":{"type":"string","description":"Type of section: OVERVIEW (executive summary) or STANDARD (detailed analysis with evidence)","enum":["OVERVIEW","STANDARD"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Section title in multiple languages"}},"required":["sectionId","title","type"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The SurveyReportStandardSectionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyReportStandardSectionDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/SurveyReportSectionBaseDTO"},{"type":"object","properties":{"content":{"$ref":"#/components/schemas/MultiLanguage","description":"Detailed analysis content in multiple languages"},"evidences":{"type":"array","description":"List of evidence objects supporting the statements in this section. Each evidence provides analytical backing for claims made in the content.","items":{"$ref":"#/components/schemas/SurveyReportEvidenceDTO"}}}}],"description":"Standard section containing detailed analysis with supporting evidence. Includes the main content, data references, and a list of evidence objects that support the statements made in the content.","required":["type"]},"SurveyReportSectionBaseDTO":{"type":"object","description":"Base class for survey report sections. Each section contains AI-generated analysis content. Sections can be either OVERVIEW (executive summary) or STANDARD (detailed analysis with supporting evidence).","discriminator":{"propertyName":"type","mapping":{"OVERVIEW":"#/components/schemas/SurveyReportOverviewSectionDTO","STANDARD":"#/components/schemas/SurveyReportStandardSectionDTO"}},"properties":{"sectionId":{"type":"string","description":"Unique identifier for this section (matches the instruction ID used during report generation)"},"type":{"type":"string","description":"Type of section: OVERVIEW (executive summary) or STANDARD (detailed analysis with evidence)","enum":["OVERVIEW","STANDARD"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Section title in multiple languages"}},"required":["sectionId","title","type"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveyReportEvidenceDTO":{"type":"object","description":"Evidence supporting statements in survey report sections. Uses a structured format that matches the new simplified evidence types specification.","properties":{"evidenceType":{"type":"string","description":"The specific type of evidence. Valid values: SCORE_LEVEL, DOMINANT_DISTRIBUTION, HIGH_NEUTRALITY, HIGH_NEGATIVE_CONCENTRATION, SEGMENT_DIFFERENCE, SEGMENT_OUTLIER, KEY_DRIVER, ACTION_PRIORITY, STRONG_CORRELATION, NEGATIVE_CORRELATION, CORRELATION_BY_SEGMENT, SYNTHETIC_INSIGHT","enum":["SCORE_LEVEL","DOMINANT_DISTRIBUTION","HIGH_NEUTRALITY","HIGH_NEGATIVE_CONCENTRATION","SEGMENT_DIFFERENCE","SEGMENT_OUTLIER","KEY_DRIVER","ACTION_PRIORITY","STRONG_CORRELATION","NEGATIVE_CORRELATION","CORRELATION_BY_SEGMENT","SYNTHETIC_INSIGHT"]},"subject":{"$ref":"#/components/schemas/SubjectDTO","description":"The source of the evidence: which questions or blocks this evidence refers to."},"segmentContext":{"$ref":"#/components/schemas/SegmentContextDTO","description":"Optional segment context indicating which segments this evidence points to. Used for segment_difference, segment_outlier, and correlation_by_segment types. All IDs are ObjectIds."},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses in percentages (negative, neutral, positive)."},"value":{"type":"number","format":"double","description":"Numeric value for the evidence (score, correlation coefficient, driver strength, etc.)."},"values":{"type":"array","description":"Array of segment values with their distributions. Required only for segment_difference type.","items":{"$ref":"#/components/schemas/SegmentValueDTO"}},"text":{"$ref":"#/components/schemas/MultiLanguage","description":"Text content for synthetic insights in multiple languages. Required only for synthetic_insight type."},"severity":{"type":"string","description":"Severity level indicating impact and polarity (LOW_POSITIVE, MEDIUM_POSITIVE, HIGH_POSITIVE, LOW_NEGATIVE, MEDIUM_NEGATIVE, HIGH_NEGATIVE).","enum":["LOW_POSITIVE","MEDIUM_POSITIVE","HIGH_POSITIVE","LOW_NEGATIVE","MEDIUM_NEGATIVE","HIGH_NEGATIVE"]},"confidence":{"type":"number","format":"double","description":"Statistical confidence level (0.0-1.0)."},"dominant":{"type":"string","description":"Dominant sentiment in the distribution (NEGATIVE, NEUTRAL, POSITIVE).","enum":["NEGATIVE","NEUTRAL","POSITIVE"]},"correlationType":{"type":"string","description":"Type of correlation (POSITIVE, NEGATIVE).","enum":["POSITIVE","NEGATIVE"]},"strength":{"type":"string","description":"Strength of correlation or relationship (WEAK, MODERATE, STRONG).","enum":["WEAK","MODERATE","STRONG"]},"priority":{"type":"string","description":"Priority level for action items (LOW, MEDIUM, HIGH).","enum":["LOW","MEDIUM","HIGH"]},"title":{"$ref":"#/components/schemas/MultiLanguage","description":"Short, concise title for this evidence in multiple languages"},"description":{"$ref":"#/components/schemas/MultiLanguage","description":"Human-readable description of what this evidence shows in multiple languages"},"reference":{"type":"string","description":"Optional reference indicating what this evidence is compared against (AVERAGE, REST_OF_POPULATION, OTHER_SEGMENTS, BENCHMARK).","enum":["AVERAGE","REST_OF_POPULATION","OTHER_SEGMENTS","BENCHMARK"]},"supportingCommentIds":{"type":"array","description":"Optional list of up to 10 comment IDs that provide direct supporting evidence for this item.","items":{"type":"string"}}}},"SubjectDTO":{"type":"object","properties":{"blocks":{"type":"array","description":"List of blocks with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"questions":{"type":"array","description":"List of questions with results this evidence refers to","items":{"$ref":"#/components/schemas/SurveyQuestionResultDTO"}}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"SurveyQuestionResultDTO":{"type":"object","properties":{"question":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"questionIndex":{"type":"number","format":"double"},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"votes":{"type":"integer","format":"int32"},"skipped":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"}}},"SegmentContextDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValues":{"type":"array","description":"List of segment value IDs (ObjectIds) - e.g., [femaleId, maleId] or [techId]","items":{"type":"string"}},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}}}},"DistributionDTO":{"type":"object","properties":{"negative":{"type":"number","format":"double","description":"Percentage of negative responses (0-100)"},"neutral":{"type":"number","format":"double","description":"Percentage of neutral responses (0-100)"},"positive":{"type":"number","format":"double","description":"Percentage of positive responses (0-100)"}}},"SegmentValueDTO":{"type":"object","properties":{"segmentId":{"type":"string","description":"Segment ID (ObjectId) - e.g., gender, department"},"segmentValueId":{"type":"string","description":"Segment value ID (ObjectId) - e.g., femaleId, maleId, techId"},"hierarchyId":{"type":"string","description":"Optional hierarchy ID (ObjectId) - e.g., IT department"},"groups":{"type":"array","description":"Optional list of group IDs (ObjectIds)","items":{"type":"string"}},"distribution":{"$ref":"#/components/schemas/DistributionDTO","description":"Distribution of responses for this segment"}}}}}} ``` ## The QuestionsByUsersStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionsByUsersStatsDTO":{"type":"object","properties":{"totalQuestions":{"type":"integer","format":"int32"}}}}}} ``` ## The AnnouncementByUserStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementByUserStatsDTO":{"type":"object","properties":{"totalAnnouncements":{"type":"integer","format":"int32"}}}}}} ``` ## The SurveyPeriodResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyPeriodResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"$ref":"#/components/schemas/SurveyResultDTO"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"SurveyResultDTO":{"type":"object","properties":{"roundId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"nonAnonymous":{"type":"boolean"},"nonEnoughEmployees":{"type":"boolean"},"periodHasIndex":{"type":"boolean"},"periodIndex":{"type":"number","format":"double"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int64"},"completedParticipants":{"type":"integer","format":"int64"},"expectedActivatedParticipants":{"type":"integer","format":"int64"},"expectedInvitedParticipants":{"type":"integer","format":"int64"},"votes":{"type":"integer","format":"int64"},"comments":{"type":"integer","format":"int32"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"},"scaleNormalized":{"type":"boolean"},"scaleMin":{"type":"integer","format":"int32"},"scaleMax":{"type":"integer","format":"int32"}}},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The SurveyResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyResultDTO":{"type":"object","properties":{"roundId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"nonAnonymous":{"type":"boolean"},"nonEnoughEmployees":{"type":"boolean"},"periodHasIndex":{"type":"boolean"},"periodIndex":{"type":"number","format":"double"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int64"},"completedParticipants":{"type":"integer","format":"int64"},"expectedActivatedParticipants":{"type":"integer","format":"int64"},"expectedInvitedParticipants":{"type":"integer","format":"int64"},"votes":{"type":"integer","format":"int64"},"comments":{"type":"integer","format":"int32"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"},"scaleNormalized":{"type":"boolean"},"scaleMin":{"type":"integer","format":"int32"},"scaleMax":{"type":"integer","format":"int32"}}},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The GroupingResultDTOSurveyGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingResultDTOSurveyGroupingResultDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SurveyGroupingResultDTO"}}}},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"SurveyGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"result":{"$ref":"#/components/schemas/SurveyResultDTO"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SurveyResultDTO":{"type":"object","properties":{"roundId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"nonAnonymous":{"type":"boolean"},"nonEnoughEmployees":{"type":"boolean"},"periodHasIndex":{"type":"boolean"},"periodIndex":{"type":"number","format":"double"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int64"},"completedParticipants":{"type":"integer","format":"int64"},"expectedActivatedParticipants":{"type":"integer","format":"int64"},"expectedInvitedParticipants":{"type":"integer","format":"int64"},"votes":{"type":"integer","format":"int64"},"comments":{"type":"integer","format":"int32"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"},"scaleNormalized":{"type":"boolean"},"scaleMin":{"type":"integer","format":"int32"},"scaleMax":{"type":"integer","format":"int32"}}},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The SurveyGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"result":{"$ref":"#/components/schemas/SurveyResultDTO"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SurveyResultDTO":{"type":"object","properties":{"roundId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"nonAnonymous":{"type":"boolean"},"nonEnoughEmployees":{"type":"boolean"},"periodHasIndex":{"type":"boolean"},"periodIndex":{"type":"number","format":"double"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int64"},"completedParticipants":{"type":"integer","format":"int64"},"expectedActivatedParticipants":{"type":"integer","format":"int64"},"expectedInvitedParticipants":{"type":"integer","format":"int64"},"votes":{"type":"integer","format":"int64"},"comments":{"type":"integer","format":"int32"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"},"scaleNormalized":{"type":"boolean"},"scaleMin":{"type":"integer","format":"int32"},"scaleMax":{"type":"integer","format":"int32"}}},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The SurveyEvolutionResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"SurveyEvolutionResultDTO":{"type":"object","properties":{"grouping":{"$ref":"#/components/schemas/DateGroupingTypes"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SurveyPeriodResultDTO"}}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"SurveyPeriodResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"$ref":"#/components/schemas/SurveyResultDTO"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"SurveyResultDTO":{"type":"object","properties":{"roundId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"nonAnonymous":{"type":"boolean"},"nonEnoughEmployees":{"type":"boolean"},"periodHasIndex":{"type":"boolean"},"periodIndex":{"type":"number","format":"double"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int64"},"completedParticipants":{"type":"integer","format":"int64"},"expectedActivatedParticipants":{"type":"integer","format":"int64"},"expectedInvitedParticipants":{"type":"integer","format":"int64"},"votes":{"type":"integer","format":"int64"},"comments":{"type":"integer","format":"int32"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlockResultDTO"}},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"},"scaleNormalized":{"type":"boolean"},"scaleMin":{"type":"integer","format":"int32"},"scaleMax":{"type":"integer","format":"int32"}}},"SurveyParticipantsDistribution":{"type":"object","properties":{"classification":{"type":"string","enum":["NEGATIVE","NEUTRAL","POSITIVE","SKIPPED"]},"count":{"type":"integer","format":"int32"}}},"SurveyBlockResultDTO":{"type":"object","properties":{"blockId":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]}},"blockIndex":{"type":"number","format":"double"},"blockHasIndex":{"type":"boolean"},"distribution":{"type":"array","items":{"$ref":"#/components/schemas/SurveyParticipantsDistribution"}},"participants":{"type":"integer","format":"int32"},"completedParticipants":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"},"comments":{"type":"integer","format":"int32"},"byInvitedQuality":{"$ref":"#/components/schemas/DataQuality"},"byActivatedQuality":{"$ref":"#/components/schemas/DataQuality"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The BenchmarkRankingType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]}}}} ``` ## The CorrelationLevel object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]}}}} ``` ## The ScoreFactorStatsV2Result object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ScoreQuestionStatsResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ScoreStatsV2DTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStatsV2DTO":{"type":"object","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"groupingType":{"$ref":"#/components/schemas/DateGroupingTypes"},"filtered":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreStatsV2Result"}}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ScoreStatsV2Result":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ScoreStatsV2Result object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStatsV2Result":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ScorePersonalFactorResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScorePersonalFactorResultDTO":{"type":"object","properties":{"factorId":{"type":"string"},"score":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ScorePersonalStatsResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScorePersonalStatsResultDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"to":{"type":"string","format":"date-time"},"score":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"factors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ScorePersonalFactorResultDTO"}}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ScorePersonalFactorResultDTO":{"type":"object","properties":{"factorId":{"type":"string"},"score":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ScoresModel object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoresModel":{"type":"string","description":"Score model to use (CORE or DERIVED)","enum":["CORE","DERIVED"]}}}} ``` ## The ScoreImpactResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreImpactResultDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"result":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"level":{"$ref":"#/components/schemas/CorrelationLevel"},"correlation":{"type":"number","format":"double"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]}}}} ``` ## The GroupingResultDTOScoreStatsGroupingResulsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingResultDTOScoreStatsGroupingResulsDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreStatsGroupingResulsDTO"}}}},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"ScoreStatsGroupingResulsDTO":{"type":"object","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"groupingType":{"$ref":"#/components/schemas/DateGroupingTypes"},"filtered":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreGroupingResultDTO"}}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ScoreGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"result":{"$ref":"#/components/schemas/ScoreStatsV2Result"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"ScoreStatsV2Result":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ScoreGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"result":{"$ref":"#/components/schemas/ScoreStatsV2Result"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"ScoreStatsV2Result":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ScoreStatsGroupingResulsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoreStatsGroupingResulsDTO":{"type":"object","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"groupingType":{"$ref":"#/components/schemas/DateGroupingTypes"},"filtered":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreGroupingResultDTO"}}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ScoreGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"result":{"$ref":"#/components/schemas/ScoreStatsV2Result"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"ScoreStatsV2Result":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The RecognitionAggregatedItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionAggregatedItemDTO":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"count":{"type":"integer","format":"int32"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The RecognitionAggregatedResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionAggregatedResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"total":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RecognitionAggregatedItemDTO"},"uniqueItems":true}}},"RecognitionAggregatedItemDTO":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"count":{"type":"integer","format":"int32"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The RecognitionRankingDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionRankingDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"ranking":{"type":"array","items":{"$ref":"#/components/schemas/RecognitionRankingItemDTO"}}}},"RecognitionRankingItemDTO":{"type":"object","properties":{"id":{"type":"string"},"count":{"type":"integer","format":"int32"},"name":{"type":"string"},"sourceType":{"$ref":"#/components/schemas/RecognitionSourceType"},"targetType":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"RecognitionSourceType":{"type":"string","description":"Recognition source type","enum":["USER","AREA"]},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The RecognitionRankingItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionRankingItemDTO":{"type":"object","properties":{"id":{"type":"string"},"count":{"type":"integer","format":"int32"},"name":{"type":"string"},"sourceType":{"$ref":"#/components/schemas/RecognitionSourceType"},"targetType":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"RecognitionSourceType":{"type":"string","description":"Recognition source type","enum":["USER","AREA"]},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]}}}} ``` ## The RecognitionSourceType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"RecognitionSourceType":{"type":"string","description":"Recognition source type","enum":["USER","AREA"]}}}} ``` ## The QuestionStatsDateResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionStatsDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"indexRating":{"type":"number","format":"double"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/VoteRating"},"uniqueItems":true},"totalVotes":{"type":"integer","format":"int32"},"totalParticipants":{"type":"integer","format":"int32"},"skippedVotes":{"type":"integer","format":"int32"},"participationPercent":{"type":"number","format":"double"}}},"VoteRating":{"type":"object","properties":{"puntuation":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"}}}}}} ``` ## The QuestionStatsResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionStatsResult":{"type":"object","properties":{"votes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/QuestionStatsDateResult"}},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"ratingPercents":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"ratingsVariation":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"invitedParticipants":{"type":"integer","format":"int64"},"expectedParticipants":{"type":"integer","format":"int64"},"periodParticipants":{"type":"integer","format":"int64"},"periodParticipantsVariation":{"type":"integer","format":"int64"},"periodParticipantsVariationPercent":{"type":"number","format":"double"},"newParticipants":{"type":"integer","format":"int64"},"lostParticipants":{"type":"integer","format":"int64"},"participationPercent":{"type":"number","format":"double"},"votesPeriod":{"type":"integer","format":"int64"},"votesVariation":{"type":"integer","format":"int64"},"votesVariationPercent":{"type":"number","format":"double"},"periodIndex":{"type":"number","format":"double"},"periodIndexVariation":{"type":"number","format":"double"},"periodIndexVariationPercent":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"quality":{"$ref":"#/components/schemas/DataQuality"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"skippedVotes":{"type":"integer","format":"int64"}}},"QuestionStatsDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"indexRating":{"type":"number","format":"double"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/VoteRating"},"uniqueItems":true},"totalVotes":{"type":"integer","format":"int32"},"totalParticipants":{"type":"integer","format":"int32"},"skippedVotes":{"type":"integer","format":"int32"},"participationPercent":{"type":"number","format":"double"}}},"VoteRating":{"type":"object","properties":{"puntuation":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The QuestionStatsResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"QuestionStatsResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/QuestionStatsResult"}},"periodResults":{"$ref":"#/components/schemas/QuestionStatsResult"}}},"QuestionStatsResult":{"type":"object","properties":{"votes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/QuestionStatsDateResult"}},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"ratingPercents":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"ratingsVariation":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"invitedParticipants":{"type":"integer","format":"int64"},"expectedParticipants":{"type":"integer","format":"int64"},"periodParticipants":{"type":"integer","format":"int64"},"periodParticipantsVariation":{"type":"integer","format":"int64"},"periodParticipantsVariationPercent":{"type":"number","format":"double"},"newParticipants":{"type":"integer","format":"int64"},"lostParticipants":{"type":"integer","format":"int64"},"participationPercent":{"type":"number","format":"double"},"votesPeriod":{"type":"integer","format":"int64"},"votesVariation":{"type":"integer","format":"int64"},"votesVariationPercent":{"type":"number","format":"double"},"periodIndex":{"type":"number","format":"double"},"periodIndexVariation":{"type":"number","format":"double"},"periodIndexVariationPercent":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"quality":{"$ref":"#/components/schemas/DataQuality"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"skippedVotes":{"type":"integer","format":"int64"}}},"QuestionStatsDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"indexRating":{"type":"number","format":"double"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/VoteRating"},"uniqueItems":true},"totalVotes":{"type":"integer","format":"int32"},"totalParticipants":{"type":"integer","format":"int32"},"skippedVotes":{"type":"integer","format":"int32"},"participationPercent":{"type":"number","format":"double"}}},"VoteRating":{"type":"object","properties":{"puntuation":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The VoteRating object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"VoteRating":{"type":"object","properties":{"puntuation":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"}}}}}} ``` ## The GroupingResultDTOParticipationGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingResultDTOParticipationGroupingResultDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ParticipationGroupingResultDTO"}}}},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"ParticipationGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"activated":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"},"invited":{"type":"integer","format":"int64"},"participationPercent":{"type":"number","format":"double"},"participations":{"type":"integer","format":"int64"},"variationPercent":{"type":"number","format":"double"},"newParticipants":{"type":"integer","format":"int64"},"lostParticipants":{"type":"integer","format":"int64"},"sleepingParticipants":{"type":"integer","format":"int64"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ParticipationGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ParticipationGroupingResultDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"activated":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"},"invited":{"type":"integer","format":"int64"},"participationPercent":{"type":"number","format":"double"},"participations":{"type":"integer","format":"int64"},"variationPercent":{"type":"number","format":"double"},"newParticipants":{"type":"integer","format":"int64"},"lostParticipants":{"type":"integer","format":"int64"},"sleepingParticipants":{"type":"integer","format":"int64"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ParticipationDateDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ParticipationDateDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"activated":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"}}}}}} ``` ## The ParticipationPeriodDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ParticipationPeriodDTO":{"type":"object","properties":{"grouping":{"$ref":"#/components/schemas/DateGroupingTypes"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"activated":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"},"participantsVariationPercent":{"type":"number","format":"double"},"invited":{"type":"integer","format":"int64"},"participations":{"type":"integer","format":"int64"},"newParticipants":{"type":"integer","format":"int64"},"lostParticipants":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ParticipationDateDTO"}}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ParticipationDateDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"activated":{"type":"integer","format":"int64"},"participants":{"type":"integer","format":"int64"}}}}}} ``` ## The ParticipationDistributionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ParticipationDistributionDTO":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"mean":{"type":"number","format":"double"},"percentile50":{"type":"number","format":"double"},"percentile70":{"type":"number","format":"double"},"percentile90":{"type":"number","format":"double"},"min":{"type":"integer","format":"int32"},"max":{"type":"integer","format":"int32"}}}}}} ``` ## The IdeasDistribution object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IdeasDistribution":{"type":"object","properties":{"numIdeas":{"type":"integer","format":"int32"},"numIdeasInitiatives":{"type":"integer","format":"int32"}}}}}} ``` ## The InnovationAggregatedResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InnovationAggregatedResultDTO":{"type":"object","properties":{"byPersonRatio":{"type":"number","format":"double"},"innovationScore":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"totalIdeas":{"type":"integer","format":"int32"},"ideasInInitiative":{"type":"integer","format":"int32"},"previousTotalIdeas":{"type":"integer","format":"int32"},"finishedInitiatives":{"type":"integer","format":"int32"},"activeInitiatives":{"type":"integer","format":"int32"},"previousActiveInitiatives":{"type":"integer","format":"int32"},"previousFinishedInitiatives":{"type":"integer","format":"int32"},"ideasDistribution":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IdeasDistribution"},"description":"Distribution of ideas by feedback status phase","properties":{"NO_PHASE":{"$ref":"#/components/schemas/IdeasDistribution"},"ONGOING":{"$ref":"#/components/schemas/IdeasDistribution"},"DISCARDED":{"$ref":"#/components/schemas/IdeasDistribution"},"ACCEPTED":{"$ref":"#/components/schemas/IdeasDistribution"}}},"ideasByStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IdeasDistribution"}}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"IdeasDistribution":{"type":"object","properties":{"numIdeas":{"type":"integer","format":"int32"},"numIdeasInitiatives":{"type":"integer","format":"int32"}}}}}} ``` ## The InnovationRankingItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InnovationRankingItemDTO":{"type":"object","properties":{"id":{"type":"string"},"totalIdeas":{"type":"integer","format":"int32"},"totalAcceptedIdeas":{"type":"integer","format":"int32"}}}}}} ``` ## The InnovationRankingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InnovationRankingResultDTO":{"type":"object","properties":{"type":{"type":"string","enum":["USER","HIERARCHY"]},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"ranking":{"type":"array","items":{"$ref":"#/components/schemas/InnovationRankingItemDTO"}}}},"InnovationRankingItemDTO":{"type":"object","properties":{"id":{"type":"string"},"totalIdeas":{"type":"integer","format":"int32"},"totalAcceptedIdeas":{"type":"integer","format":"int32"}}}}}} ``` ## The HiStatsResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HiStatsResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"results":{"type":"array","items":{"$ref":"#/components/schemas/QuestionStatsResult"}},"periodResults":{"$ref":"#/components/schemas/QuestionStatsResult"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"quality":{"$ref":"#/components/schemas/DataQuality"},"filtered":{"type":"boolean"}}},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]},"QuestionStatsResult":{"type":"object","properties":{"votes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/QuestionStatsDateResult"}},"ratings":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"ratingPercents":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"ratingsVariation":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"invitedParticipants":{"type":"integer","format":"int64"},"expectedParticipants":{"type":"integer","format":"int64"},"periodParticipants":{"type":"integer","format":"int64"},"periodParticipantsVariation":{"type":"integer","format":"int64"},"periodParticipantsVariationPercent":{"type":"number","format":"double"},"newParticipants":{"type":"integer","format":"int64"},"lostParticipants":{"type":"integer","format":"int64"},"participationPercent":{"type":"number","format":"double"},"votesPeriod":{"type":"integer","format":"int64"},"votesVariation":{"type":"integer","format":"int64"},"votesVariationPercent":{"type":"number","format":"double"},"periodIndex":{"type":"number","format":"double"},"periodIndexVariation":{"type":"number","format":"double"},"periodIndexVariationPercent":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"quality":{"$ref":"#/components/schemas/DataQuality"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"skippedVotes":{"type":"integer","format":"int64"}}},"QuestionStatsDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"indexRating":{"type":"number","format":"double"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/VoteRating"},"uniqueItems":true},"totalVotes":{"type":"integer","format":"int32"},"totalParticipants":{"type":"integer","format":"int32"},"skippedVotes":{"type":"integer","format":"int32"},"participationPercent":{"type":"number","format":"double"}}},"VoteRating":{"type":"object","properties":{"puntuation":{"type":"integer","format":"int32"},"votes":{"type":"integer","format":"int32"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}}} ``` ## The IndividualHIStatsResultMemberDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IndividualHIStatsResultMemberDTO":{"type":"object","properties":{"encryptedId":{"type":"string"},"hi":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/IndividualHIStatsResultVoteDTO"}},"hasConversations":{"type":"boolean"},"allowConversations":{"type":"boolean"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"IndividualHIStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"}}}}}} ``` ## The IndividualHIStatsResultVoteDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IndividualHIStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"}}}}}} ``` ## The IndividualHIStatsResultsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IndividualHIStatsResultsDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/IndividualHIStatsResultMemberDTO"}}}},"IndividualHIStatsResultMemberDTO":{"type":"object","properties":{"encryptedId":{"type":"string"},"hi":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/IndividualHIStatsResultVoteDTO"}},"hasConversations":{"type":"boolean"},"allowConversations":{"type":"boolean"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"IndividualHIStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"}}}}}} ``` ## The GroupingResultDTOHIGroupingStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingResultDTOHIGroupingStatsDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/HIGroupingStatsDTO"}}}},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"HIGroupingStatsDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"companyBenchmark":{"type":"number","format":"double"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The HIGroupingStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIGroupingStatsDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"companyBenchmark":{"type":"number","format":"double"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The CorrelationFactorResultItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CorrelationFactorResultItemDTO":{"type":"object","properties":{"id":{"type":"string"},"correlation":{"type":"number","format":"double"},"level":{"$ref":"#/components/schemas/CorrelationLevel"}}},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]}}}} ``` ## The CorrelationHIResultItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CorrelationHIResultItemDTO":{"type":"object","properties":{"type":{"type":"string","enum":["SCORE"]},"level":{"$ref":"#/components/schemas/CorrelationLevel"},"correlation":{"type":"number","format":"double"},"averageHI":{"type":"number","format":"double"},"scoreId":{"type":"string"},"factorCorrelations":{"type":"array","items":{"$ref":"#/components/schemas/CorrelationFactorResultItemDTO"}}}},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"CorrelationFactorResultItemDTO":{"type":"object","properties":{"id":{"type":"string"},"correlation":{"type":"number","format":"double"},"level":{"$ref":"#/components/schemas/CorrelationLevel"}}}}}} ``` ## The CorrelationHIResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CorrelationHIResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"correlations":{"type":"array","items":{"$ref":"#/components/schemas/CorrelationHIResultItemDTO"}}}},"CorrelationHIResultItemDTO":{"type":"object","properties":{"type":{"type":"string","enum":["SCORE"]},"level":{"$ref":"#/components/schemas/CorrelationLevel"},"correlation":{"type":"number","format":"double"},"averageHI":{"type":"number","format":"double"},"scoreId":{"type":"string"},"factorCorrelations":{"type":"array","items":{"$ref":"#/components/schemas/CorrelationFactorResultItemDTO"}}}},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"CorrelationFactorResultItemDTO":{"type":"object","properties":{"id":{"type":"string"},"correlation":{"type":"number","format":"double"},"level":{"$ref":"#/components/schemas/CorrelationLevel"}}}}}} ``` ## The ClassificationEntry object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ClassificationEntry":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/EmployeeClassificationType"},"target":{"$ref":"#/components/schemas/EmployeeClassificationType"},"count":{"type":"integer","format":"int32"}}},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]}}}} ``` ## The HIClassificationStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HIClassificationStatsDTO":{"type":"object","properties":{"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"classification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"prevClassification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"funnel":{"type":"array","items":{"$ref":"#/components/schemas/ClassificationEntry"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ClassificationEntry":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/EmployeeClassificationType"},"target":{"$ref":"#/components/schemas/EmployeeClassificationType"},"count":{"type":"integer","format":"int32"}}},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]}}}} ``` ## The FeedbackDateStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackDateStats":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FeedbackType"},"count":{"type":"integer","format":"int32"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The FeedbackStats object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackStats":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"results":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackDateStats"}}},"totalByType":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"FeedbackDateStats":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FeedbackType"},"count":{"type":"integer","format":"int32"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]}}}} ``` ## The ENPSStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSStatsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"lastMeasurement":{"type":"string","format":"date-time"},"nextMeasurement":{"type":"string","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ENPSStatsResultDTO"}},"filtered":{"type":"boolean"}}},"ENPSStatsResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"averageResult":{"type":"number","format":"double"},"averageVariation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"companyAverageBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"globalAverageBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"industryAverageBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"classification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]}}}} ``` ## The ENPSStatsResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSStatsResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"averageResult":{"type":"number","format":"double"},"averageVariation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"companyAverageBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"globalAverageBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"industryAverageBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"classification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]}}}} ``` ## The IndividualENPSStatsResultMemberDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IndividualENPSStatsResultMemberDTO":{"type":"object","properties":{"encryptedId":{"type":"string"},"result":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/IndividualENPSStatsResultVoteDTO"}},"hasConversations":{"type":"boolean"},"allowConversations":{"type":"boolean"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"IndividualENPSStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The IndividualENPSStatsResultVoteDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IndividualENPSStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The IndividualENPSStatsResultsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"IndividualENPSStatsResultsDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/IndividualENPSStatsResultMemberDTO"}}}},"IndividualENPSStatsResultMemberDTO":{"type":"object","properties":{"encryptedId":{"type":"string"},"result":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/IndividualENPSStatsResultVoteDTO"}},"hasConversations":{"type":"boolean"},"allowConversations":{"type":"boolean"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"IndividualENPSStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}}} ``` ## The ENPSGroupingStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSGroupingStatsDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"date":{"type":"string","format":"date-time"},"previousDate":{"type":"string","format":"date-time"},"companyBenchmark":{"type":"number","format":"double"},"companyAverageBenchmark":{"type":"number","format":"double"},"result":{"type":"number","format":"double"},"averageResult":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"averageVariation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The GroupingResultDTOENPSGroupingStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingResultDTOENPSGroupingStatsDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ENPSGroupingStatsDTO"}}}},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"ENPSGroupingStatsDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"date":{"type":"string","format":"date-time"},"previousDate":{"type":"string","format":"date-time"},"companyBenchmark":{"type":"number","format":"double"},"companyAverageBenchmark":{"type":"number","format":"double"},"result":{"type":"number","format":"double"},"averageResult":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"averageVariation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ENPSClassification object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSClassification":{"type":"string","description":"Type of employee classification in the eNPS survey","enum":["PROMOTERS","PASSIVES","DETRACTORS"]}}}} ``` ## The ENPSClassificationStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSClassificationStatsDTO":{"type":"object","properties":{"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"classification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"prevClassification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"funnel":{"type":"array","items":{"$ref":"#/components/schemas/ClassificationEntry"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ClassificationEntry":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/EmployeeClassificationType"},"target":{"$ref":"#/components/schemas/EmployeeClassificationType"},"count":{"type":"integer","format":"int32"}}},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]}}}} ``` ## The EmployeeStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EmployeeStatsDTO":{"type":"object","properties":{"invited":{"type":"integer","format":"int64"},"activated":{"type":"integer","format":"int64"},"sleeping":{"type":"integer","format":"int64"}}}}}} ``` ## The CommentsStatTypes object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentsStatTypes":{"type":"string","description":"Comments statistics types","enum":["COUNT","INTERACTIONS","TAGS","AUTHORS","EMOTIONS","POSITIVITY","FEEDBACK_TYPE","REPLIES","REFEREED","POSITIVENESS"]}}}} ``` ## The CommentStatsEntity object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentStatsEntity":{"type":"object","properties":{"title":{"type":"string"},"relevance":{"type":"number","format":"double"},"averageRating":{"type":"number","format":"double"},"averagePositiveness":{"type":"number","format":"double"}}}}}} ``` ## The CommentsDateStatsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentsDateStatsDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"comments":{"type":"integer","format":"int64"},"commentsVariation":{"type":"integer","format":"int64"},"replies":{"type":"integer","format":"int64"},"authors":{"type":"integer","format":"int64"},"likes":{"type":"integer","format":"int64"},"uniqueLikes":{"type":"integer","format":"int64"},"dislikes":{"type":"integer","format":"int64"},"uniqueDislikes":{"type":"integer","format":"int64"},"inappropiates":{"type":"integer","format":"int64"},"refereed":{"type":"integer","format":"int64"},"markedAsInappropriate":{"type":"integer","format":"int64"},"positivity":{"type":"number","format":"double"},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/StatValueDouble"}},"languages":{"type":"array","items":{"$ref":"#/components/schemas/StatValueInteger"}},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatsEntity"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatsEntity"}},"feedbackTypeCount":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"positivenessCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"StatValueDouble":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"number","format":"double"}}},"StatValueInteger":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"integer","format":"int32"}}},"CommentStatsEntity":{"type":"object","properties":{"title":{"type":"string"},"relevance":{"type":"number","format":"double"},"averageRating":{"type":"number","format":"double"},"averagePositiveness":{"type":"number","format":"double"}}}}}} ``` ## The StatValueDouble object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"StatValueDouble":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"number","format":"double"}}}}}} ``` ## The StatValueInteger object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"StatValueInteger":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"integer","format":"int32"}}}}}} ``` ## The VoeCategoryCountDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"VoeCategoryCountDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"count":{"type":"integer","format":"int32"},"subcategories":{"type":"array","items":{}}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]}}}} ``` ## The ActivationResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationResult":{"type":"object","properties":{"activated":{"type":"integer","format":"int64"},"invited":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ActivationPeriodResumeResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationPeriodResumeResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}}} ``` ## The ActivationGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationGroupingResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"nonEnoughEmployees":{"type":"boolean"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The GroupingResultDTOActivationGroupingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"GroupingResultDTOActivationGroupingResultDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ActivationGroupingResultDTO"}}}},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"ActivationGroupingResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"nonEnoughEmployees":{"type":"boolean"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The ActivationDateResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"invited":{"type":"integer","format":"int64"},"invitedAcummulated":{"type":"integer","format":"int64"},"activated":{"type":"integer","format":"int64"},"activatedAcumulated":{"type":"integer","format":"int64"}}}}}} ``` ## The ActivationPeriodResult object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivationPeriodResult":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ActivationDateResult"}}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ActivationDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"invited":{"type":"integer","format":"int64"},"invitedAcummulated":{"type":"integer","format":"int64"},"activated":{"type":"integer","format":"int64"},"activatedAcumulated":{"type":"integer","format":"int64"}}}}}} ``` ## The EngagementInsightDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EngagementInsightDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"theme":{"type":"string"},"iconURL":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"},"overallCandidates":{"type":"integer","format":"int32"}}}}}} ``` ## The EngagementInsightsImpactDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EngagementInsightsImpactDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"groupId":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/EngagementInsightsImpactFactorDTO"},"uniqueItems":true},"children":{"type":"array","items":{},"uniqueItems":true}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EngagementInsightsImpactFactorDTO":{"type":"object","properties":{"factorId":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"}}}}}} ``` ## The EngagementInsightsImpactFactorDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"EngagementInsightsImpactFactorDTO":{"type":"object","properties":{"factorId":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"}}}}}} ``` ## The AIActionRecomendationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AIActionRecomendationDTO":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## The ScoresAIResumeWithActionsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ScoresAIResumeWithActionsDTO":{"type":"object","properties":{"text":{"type":"string"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/AIActionRecomendationDTO"}}}},"AIActionRecomendationDTO":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## The CommentsSortOrder object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentsSortOrder":{"type":"string","description":"Comments sort order options","enum":["AGREE","DISAGREE","INAPPROPRIATE","POPULARITY","RECENT","LAST_UPDATED","STARRED","REFEREED"]}}}} ``` ## The CommentsDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CommentsDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"$ref":"#/components/schemas/BaseCommentDTO"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/BaseCommentDTO"}}}},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The ManagerRankingDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ManagerRankingDTO":{"type":"object","properties":{"userId":{"type":"string"},"score":{"type":"integer","format":"int32"},"activityTypes":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participationPercent":{"type":"number","format":"double"},"engagementScore":{"type":"number","format":"double"},"engagementScores":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"firstResponseTime":{"type":"integer","format":"int64"},"firstResponseTimes":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"overallResponseTime":{"type":"integer","format":"int64"},"overallResponseTimes":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}}}}}} ``` ## The ManagerRankingResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ManagerRankingResultDTO":{"type":"object","properties":{"grouping":{"$ref":"#/components/schemas/DateGroupingTypes"},"periodResults":{"type":"array","items":{"$ref":"#/components/schemas/ManagerRankingDTO"}},"results":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ManagerRankingDTO"}}}}},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ManagerRankingDTO":{"type":"object","properties":{"userId":{"type":"string"},"score":{"type":"integer","format":"int32"},"activityTypes":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participationPercent":{"type":"number","format":"double"},"engagementScore":{"type":"number","format":"double"},"engagementScores":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"firstResponseTime":{"type":"integer","format":"int64"},"firstResponseTimes":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"overallResponseTime":{"type":"integer","format":"int64"},"overallResponseTimes":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}}}}}}} ``` ## The PaginableGenericResultListQuestionDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListQuestionDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/QuestionDTO"}}}},"QuestionDTO":{"type":"object","description":"The details of the question to be created","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"primary":{"type":"boolean"},"createdOn":{"type":"string","format":"date-time"},"activationDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"resultValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"notifyByPush":{"type":"boolean"},"notifyByMail":{"type":"boolean"},"notified":{"type":"boolean"},"privated":{"type":"boolean"},"nonAnonymous":{"type":"boolean"},"requireNotEmpty":{"type":"boolean","deprecated":true},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"feedbackEnabled":{"type":"boolean"},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/QuestionStatus"},"activationRule":{"$ref":"#/components/schemas/QuestionActivationRuleDTO"},"activations":{"type":"array","items":{"$ref":"#/components/schemas/QuestionActivationDTO"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionStatus":{"type":"string","description":"Status of a question in a survey or questionnaire","enum":["ANY","ACTIVE","PENDING","EXPIRED","PAUSED","ARCHIVED"]},"QuestionActivationRuleDTO":{"type":"object","properties":{"ruleType":{"$ref":"#/components/schemas/ActivationRuleType"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"cronExpression":{"type":"string"},"startAt":{"type":"string","format":"date-time"},"endAt":{"type":"string","format":"date-time"},"duration":{"type":"integer","format":"int32"}}},"ActivationRuleType":{"type":"string","description":"Type of activation rule for a survey or questionnaire","enum":["SINGLE","RECURRENT","CALENDAR","CONTINUOUS"]},"QuestionActivationDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}}} ``` ## The PersonProfileDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonProfileDTO":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}}}}} ``` ## The PaginableGenericListResultPersonDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultPersonDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PersonDTO"}}}},"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"hierarchyId":{"type":"string"},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"type":"string","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}}} ``` ## The UserMeDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"UserMeDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"}}}}}} ``` ## The PaginableGenericResultListCompanyDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListCompanyDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CompanyDTO"}}}},"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}}} ``` ## The AbstractInsightDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AbstractInsightDTO":{"type":"object","properties":{"id":{"type":"string"},"contextId":{"type":"string"},"family":{"type":"string","enum":["SCORE"]},"type":{"$ref":"#/components/schemas/InsightType"},"date":{"type":"string","format":"date-time"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"positive":{"type":"boolean"}}},"InsightType":{"type":"string","description":"Type of insight for the analysis of score results","enum":["OUTLIERS","HI_IMPACT","ENPS_IMPACT","VARIATION"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The InsightType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"InsightType":{"type":"string","description":"Type of insight for the analysis of score results","enum":["OUTLIERS","HI_IMPACT","ENPS_IMPACT","VARIATION"]}}}} ``` ## The PaginableGenericResultListAbstractInsightDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListAbstractInsightDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AbstractInsightDTO"}}}},"AbstractInsightDTO":{"type":"object","properties":{"id":{"type":"string"},"contextId":{"type":"string"},"family":{"type":"string","enum":["SCORE"]},"type":{"$ref":"#/components/schemas/InsightType"},"date":{"type":"string","format":"date-time"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"positive":{"type":"boolean"}}},"InsightType":{"type":"string","description":"Type of insight for the analysis of score results","enum":["OUTLIERS","HI_IMPACT","ENPS_IMPACT","VARIATION"]},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]}}}} ``` ## The HPTokenDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"HPTokenDTO":{"type":"object","properties":{"token":{"type":"string"}}}}}} ``` ## The PaginableGenericResultListSurveyFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListSurveyFeedbackCommentDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"}}}},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]}}}} ``` ## The PaginableGenericResultListScoreFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListScoreFeedbackCommentDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"}}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The PaginableGenericResultListENPSFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListENPSFeedbackCommentDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"}}}},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]}}}} ``` ## The FeedbackArchivedStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"FeedbackArchivedStatus":{"type":"string","description":"FeedbackArchivedStatus.","enum":["ANY","ACTIVE","ARCHIVED"]}}}} ``` ## The PaginableGenericResultListClassificationFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListClassificationFeedbackDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ClassificationFeedbackDTO"}}}},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]}}}} ``` ## The PaginableGenericListResultAnnouncementFeedbackCommentDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultAnnouncementFeedbackCommentDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}}}},"AnnouncementFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"AnnouncementFeedbackCommentDTO","required":["feedbackType"]},"StandardCommentDTO":{"allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}}],"description":"StandardCommentDTO","required":["feedbackType"]},"BaseCommentDTO":{"type":"object","description":"Base class for all types of comments","discriminator":{"propertyName":"feedbackType","mapping":{"RECOGNITION":"#/components/schemas/RecognitionCommentDTO","SUGGESTION":"#/components/schemas/StandardCommentDTO","INFORMATION":"#/components/schemas/StandardCommentDTO","CRITICISM":"#/components/schemas/SomethingIsWrongCommentDTO","OTHER":"#/components/schemas/StandardCommentDTO","CONGRATULATION":"#/components/schemas/StandardCommentDTO","SCORE":"#/components/schemas/ScoreFeedbackCommentDTO","ENPS":"#/components/schemas/ENPSFeedbackCommentDTO","CLASSIFICATION_FOLLOWUP":"#/components/schemas/ClassificationFeedbackDTO","QUESTION":"#/components/schemas/QuestionFeedbackCommentDTO","SURVEY":"#/components/schemas/SurveyFeedbackCommentDTO","ANNOUNCEMENT_COMMENT":"#/components/schemas/AnnouncementFeedbackCommentDTO"}},"oneOf":[{"$ref":"#/components/schemas/RecognitionCommentDTO"},{"$ref":"#/components/schemas/StandardCommentDTO"},{"$ref":"#/components/schemas/SomethingIsWrongCommentDTO"},{"$ref":"#/components/schemas/ScoreFeedbackCommentDTO"},{"$ref":"#/components/schemas/ENPSFeedbackCommentDTO"},{"$ref":"#/components/schemas/ClassificationFeedbackDTO"},{"$ref":"#/components/schemas/QuestionFeedbackCommentDTO"},{"$ref":"#/components/schemas/SurveyFeedbackCommentDTO"},{"$ref":"#/components/schemas/AnnouncementFeedbackCommentDTO"}],"properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"}},"required":["feedbackType"]},"RecognitionCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/RecognitionValueDTO"},"target":{"$ref":"#/components/schemas/CommentTargetDTO"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"RecognitionCommentDTO","required":["feedbackType"]},"RecognitionValueDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconImagePath":{"type":"string"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CommentTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FeedbackTargetType"}}},"FeedbackTargetType":{"type":"string","description":"Feedback target type","enum":["EMPLOYEE","MANAGER","HIERARCHY","FREE"]},"SomethingIsWrongCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"makesMeFeel":{"type":"string"},"howToSolve":{"type":"string"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"SomethingIsWrongCommentDTO","required":["feedbackType"]},"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"CommentAttachmentDTO":{"type":"object","properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","EXTERNAL_GIF"]},"fileURL":{"type":"string"}}},"EmployeeSentiment":{"type":"object","properties":{"agreement":{"type":"boolean"},"ironic":{"type":"boolean"},"subjective":{"type":"boolean"},"score":{"type":"integer","format":"int32"},"positivity":{"type":"number","format":"double"}}},"CommentTopic":{"type":"object","properties":{"form":{"type":"string"},"relevance":{"type":"number","format":"double"},"type":{"type":"string"}}},"CommentReplyDTO":{"type":"object","description":"Comment reply with standard comment capabilities","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"}}},"Cluster":{"type":"object","properties":{"title":{"type":"string"},"score":{"type":"number","format":"double"}}},"HR_POSSITIVENES_CLASSIFICATION":{"type":"string","enum":["POSITIVE","NEGATIVE","NEUTRAL"]},"EmployeeInnappropiateFeedbackDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/InappropriateReasonType"},"reason":{"type":"string"}}},"InappropriateReasonType":{"type":"string","enum":["THRESHOLD","OFFENSIVE","DISRESPECTFUL","OTHER"]},"InappropriateSourceType":{"type":"string","enum":["EMPLOYEES","USER"]},"CommentRefereed":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"CommentStatusDTO":{"type":"object","properties":{"statusTypeId":{"type":"string"},"date":{"type":"string","format":"date-time"},"userId":{"type":"string"},"current":{"type":"boolean"}}},"CommentContainerDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"}}},"CommentRefereedDTO":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"ScoreFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"scoreId":{"type":"string"},"factorId":{"type":"string"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"},"scoreName":{"$ref":"#/components/schemas/MultiLanguage"},"factorName":{"$ref":"#/components/schemas/MultiLanguage"},"invertedQuestion":{"type":"boolean"}}}],"description":"ScoreFeedbackCommentDTO","required":["feedbackType"]},"ENPSFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"ENPSFeedbackCommentDTO","required":["feedbackType"]},"ClassificationFeedbackDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmployeeClassificationType"}}}],"description":"ClassificationFeedbackCommentDTO","required":["feedbackType"]},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]},"QuestionFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/StandardCommentDTO"},{"type":"object","properties":{"id":{"type":"string"},"feedbackType":{"$ref":"#/components/schemas/FeedbackType"},"feedbackTypeImage":{"type":"string"},"privated":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"hierarchyAnonymized":{"type":"boolean"},"flaggedAnonymous":{"type":"boolean"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CommentAttachmentDTO"}},"allowStartConversation":{"type":"boolean"},"conversationOwnerId":{"type":"string"},"signerId":{"type":"string"},"conversationId":{"type":"string"},"hasBeenSeen":{"type":"boolean"},"allowPrivatedSwap":{"type":"boolean"},"hrRelevant":{"type":"boolean"},"hrTags":{"type":"array","items":{"type":"string"},"uniqueItems":true},"sentimentScore":{"$ref":"#/components/schemas/EmployeeSentiment"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentTopic"}},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personalities":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"personas":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"announcementId":{"type":"string"},"replies":{"type":"array","description":"List of replies to this comment","items":{"$ref":"#/components/schemas/CommentReplyDTO"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}},"hrPositivenessClassification":{"$ref":"#/components/schemas/HR_POSSITIVENES_CLASSIFICATION"},"replied":{"type":"boolean"},"allowReply":{"type":"boolean"},"allowNonAnonymousReply":{"type":"boolean"},"originalPrivated":{"type":"boolean"},"privateStatusChangedById":{"type":"string"},"privateStatusChangedOn":{"type":"string","format":"date-time"},"allowTypeSwap":{"type":"boolean"},"likes":{"type":"integer","format":"int32"},"dislikes":{"type":"integer","format":"int32"},"inappropriate":{"type":"boolean"},"inappropriates":{"type":"integer","format":"int32"},"employeeInnappropiateFeedback":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInnappropiateFeedbackDTO"}},"inappropriateReasonType":{"$ref":"#/components/schemas/InappropriateReasonType"},"inappropriateSourceType":{"$ref":"#/components/schemas/InappropriateSourceType"},"commentRefereed":{"$ref":"#/components/schemas/CommentRefereed"},"inappropriateReason":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatusDTO"}},"container":{"$ref":"#/components/schemas/CommentContainerDTO"},"refereed":{"$ref":"#/components/schemas/CommentRefereedDTO"},"questionId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}},{"$ref":"#/components/schemas/BaseCommentDTO"}],"description":"QuestionFeedbackCommentDTO","required":["feedbackType"]},"SurveyFeedbackCommentDTO":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseCommentDTO"},{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"surveyId":{"type":"string"},"roundId":{"type":"string"},"questionTitle":{"$ref":"#/components/schemas/MultiLanguage"}}}],"description":"SurveyFeedbackCommentDTO","required":["feedbackType"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]}}}} ``` ## The ENPSConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSConfigurationDTO":{"type":"object","properties":{"questionId":{"type":"string"},"enabled":{"type":"boolean"},"fullPeriod":{"type":"boolean"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"measuringNow":{"type":"boolean"},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"numberOfMeasures":{"type":"integer","format":"int32"},"currentPeriodHasVotes":{"type":"boolean"}}},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}}} ``` ## The ENPSCurrentStatus object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ENPSCurrentStatus":{"type":"object","properties":{"hasSchedule":{"type":"boolean"},"measuringNow":{"type":"boolean"},"hasVotes":{"type":"boolean"},"measureFrom":{"type":"string","format":"date-time"},"measureTo":{"type":"string","format":"date-time"}}}}}} ``` ## The PaginableGenericListResultConversationHeaderDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultConversationHeaderDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConversationHeaderDTO"}}}},"ConversationHeaderDTO":{"type":"object","description":"Conversation header: id, type, name, comment id, updated, dates, owner, signature, and messages.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["COMMENT","ENGAGEMENT_STATUS"]},"name":{"type":"string"},"commentId":{"type":"string"},"updated":{"type":"boolean"},"updatedOn":{"type":"string","format":"date-time"},"title":{"type":"string","deprecated":true},"hierarchyName":{"type":"string","deprecated":true},"imagePath":{"type":"string"},"owned":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/SignatureDTO"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ConversationMessageDTO"}}}},"SignatureDTO":{"type":"object","description":"Signature (author) of a comment: id, name, description, and profile image.","properties":{"id":{"type":"string","description":"User ID of the signer"},"name":{"type":"string","description":"Display name of the signer"},"description":{"type":"string","description":"Optional description (e.g. role)"},"profileImagePath":{"type":"string","description":"URL or path to the profile image"}}},"ConversationMessageDTO":{"type":"object","description":"Single message in a conversation: date, text, user type, seen, owned, anonymous, signature.","properties":{"date":{"type":"string","format":"date-time","description":"Message date and time"},"message":{"type":"string","description":"Message text"},"userType":{"$ref":"#/components/schemas/UserType","description":"Type of user who sent the message"},"seen":{"type":"boolean","description":"Whether the message has been seen"},"owned":{"type":"boolean","description":"Whether the message is from the current user"},"signature":{"$ref":"#/components/schemas/SignatureDTO","description":"Signature when not anonymous"},"anonymous":{"type":"boolean"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The ConversationPendingDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ConversationPendingDTO":{"type":"object","properties":{"pending":{"type":"integer","format":"int32"}}}}}} ``` ## The CheckDomainResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CheckDomainResponse":{"type":"object","properties":{"domain":{"type":"string"},"status":{"type":"string","enum":["VALID","RESTRICTED","INVALID","IN_USE"]}}}}}} ``` ## The CheckMailResponse object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CheckMailResponse":{"type":"object","properties":{"valid":{"type":"boolean"},"userType":{"$ref":"#/components/schemas/UserType"},"allowedLoginMethods":{"type":"array","items":{"type":"string","enum":["USER_PASSWORD","USER_ACCESS_LINK","GOOGLE_AUTH","MICROSOFT_AUTH","HP_AUTH","SSO_SAML2","SSO_OIDC"]},"uniqueItems":true},"ssoRedirectUrl":{"type":"string"},"ssoMandatory":{"type":"boolean"}}},"UserType":{"type":"string","description":"Type of user in the system, either an employee or a company user (admin, manager, etc).","enum":["EMPLOYEE","COMPANY_USER"]}}}} ``` ## The AnonymityDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnonymityDTO":{"type":"object","properties":{"valid":{"type":"boolean"},"requiredEmployees":{"type":"integer","format":"int32"}}}}}} ``` ## The AnnouncementOrder object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"AnnouncementOrder":{"type":"string","description":"Type announcement order","enum":["RECENT","OLDER","MOST_COMMENTED","MOST_LIKED","MOST_VIEWED"]}}}} ``` ## The PaginableGenericListResultAnnouncementExternalDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericListResultAnnouncementExternalDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementExternalDTO"}}}},"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"MultiLanguage":{"type":"object","properties":{"defaultValue":{"type":"string","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"}},"valid":{"type":"boolean"}},"required":["defaultValue"]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}}} ``` ## The CompanyRole object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CompanyRole":{"type":"object","properties":{"companyId":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]}}}}}} ``` ## The PersonAdvisorDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PersonAdvisorDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"hierarchyId":{"type":"string"},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"}]},"uniqueItems":true},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"type":"string","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"roles":{"type":"array","items":{"$ref":"#/components/schemas/CompanyRole"}}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}},"CompanyRole":{"type":"object","properties":{"companyId":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]}}}}}} ``` ## The ActivityType object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ActivityType":{"type":"string","description":"Managager activity type in the platform.","enum":["QUESTION_PUBLISHED","ANNOUNCEMENT_PUBLISHED","ANNOUNCEMENT_REPLY","CONVERSATION_PARTICIPATED","COMMENT_SIGNED","REPLY_SIGNED","RECOGNITION_PERFORMED"]}}}} ``` ## The ManagerActivityDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"ManagerActivityDTO":{"type":"object","properties":{"contextId":{"type":"string"},"userId":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"activityDate":{"type":"string","format":"date-time"},"activityType":{"$ref":"#/components/schemas/ActivityType"}}},"ActivityType":{"type":"string","description":"Managager activity type in the platform.","enum":["QUESTION_PUBLISHED","ANNOUNCEMENT_PUBLISHED","ANNOUNCEMENT_REPLY","CONVERSATION_PARTICIPATED","COMMENT_SIGNED","REPLY_SIGNED","RECOGNITION_PERFORMED"]}}}} ``` ## The PaginableGenericResultListManagerActivityDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"PaginableGenericResultListManagerActivityDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ManagerActivityDTO"}}}},"ManagerActivityDTO":{"type":"object","properties":{"contextId":{"type":"string"},"userId":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"activityDate":{"type":"string","format":"date-time"},"activityType":{"$ref":"#/components/schemas/ActivityType"}}},"ActivityType":{"type":"string","description":"Managager activity type in the platform.","enum":["QUESTION_PUBLISHED","ANNOUNCEMENT_PUBLISHED","ANNOUNCEMENT_REPLY","CONVERSATION_PARTICIPATED","COMMENT_SIGNED","REPLY_SIGNED","RECOGNITION_PERFORMED"]}}}} ``` ## The CsrfToken object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"CsrfToken":{"type":"object","properties":{"headerName":{"type":"string"},"token":{"type":"string"},"parameterName":{"type":"string"}}}}}} ``` ## The TimesheetDeleteRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"components":{"schemas":{"TimesheetDeleteRequestDTO":{"type":"object","description":"Timesheet delete data","properties":{"deleteReason":{"type":"string","description":"Reason for deleting this timesheet record","minLength":1}},"required":["deleteReason"]}}}} ```