2.0info: 2.0.8 Índice de felicidade description: Backend responsável por armazenar o índice de felicidade do Waapi x-senior-domain: Gestão de Pessoas x-senior-domain-path: hcm x-senior-service-path: happiness_index contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /happiness_index/queries/healthcheck: post: description: Retorna as informações de healthcheck do serviço. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Estado atual do serviço. checks: type: object allOf: – #/definitions/healthcheckChecks description: Verificações efetuadas e seus respectivos estados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de healthcheck do serviço. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Estado atual do serviço. checks: type: object allOf: – #/definitions/healthcheckChecks description: Verificações efetuadas e seus respectivos estados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/isEnabled: post: description: Indica se o módulo está habilitado para o tenant. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Indicativo se o módulo está habilitado para o tenant. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Indica se o módulo está habilitado para o tenant. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Indicativo se o módulo está habilitado para o tenant. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/retrieveMoodOfTheDay: post: description: Retorna o sentimento do dia atual registrado pelo colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: language: type: string maxLength: 5 description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. responses: 200: description: Ok schema: type: object properties: mood: type: string allOf: – #/definitions/moodType description: Sentimento do dia do colaborador. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o sentimento do dia atual registrado pelo colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: language description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. in: query type: string maxLength: 5 responses: 200: description: Ok schema: type: object properties: mood: type: string allOf: – #/definitions/moodType description: Sentimento do dia do colaborador. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/retrieveAllReasons: post: description: Retorna as razões dos sentimentos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: language: type: string maxLength: 5 description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. responses: 200: description: Ok schema: type: object required: – moodReasons properties: moodReasons: type: array items: type: object allOf: – #/definitions/groupReasonDto minimum: 1 description: Lista das razões do sentimento do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as razões dos sentimentos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: language description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. in: query type: string maxLength: 5 responses: 200: description: Ok schema: type: object required: – moodReasons properties: moodReasons: type: array items: type: object allOf: – #/definitions/groupReasonDto minimum: 1 description: Lista das razões do sentimento do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/retrieveMyMoodRecords: post: description: Retorna os sentimentos e as razões do colaborador em um intervalo de data. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial para a busca dos sentimentos do colaborador. endDate: type: string format: date description: Data final para a busca dos sentimentos do colaborador. language: type: string maxLength: 5 description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. responses: 200: description: Ok schema: type: object required: – myMoodRecords properties: myMoodRecords: type: array items: type: object allOf: – #/definitions/myMoodRecordsDto minimum: 1 description: Lista dos sentimentos do colaborador. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os sentimentos e as razões do colaborador em um intervalo de data. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial para a busca dos sentimentos do colaborador. in: query required: true type: string format: date – name: endDate description: Data final para a busca dos sentimentos do colaborador. in: query required: true type: string format: date – name: language description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. in: query type: string maxLength: 5 responses: 200: description: Ok schema: type: object required: – myMoodRecords properties: myMoodRecords: type: array items: type: object allOf: – #/definitions/myMoodRecordsDto minimum: 1 description: Lista dos sentimentos do colaborador. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/exportEmployeeMood: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/exportReason: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/exportGroupReason: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/exportSubGroupReason: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/exportMoodReason: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/migrateSchema: post: description: Executa as migrações de base de dados do serviço. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/registerMoodOfTheDay: post: description: Registra o sentimento do dia atual para o colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mood properties: mood: type: string allOf: – #/definitions/moodType description: Sentimento do dia do colaborador. language: type: string maxLength: 5 description: Idioma do usuário no padrão pt-BR caso necessite sobrescrever o idioma retornado pela plataforma para o usuário. notes: type: string maxLength: 255 description: Nota atribuída à escolha do sentimento do colaborador de forma mais detalhada. reasons: type: array items: type: string description: Razões do contexto do sentimento do colaborador no dia. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Você já definiu seu sentimento do dia para hoje. Só é possível defini-lo uma única vez por dia. Por favor, tente novamente amanhã. 404: description: Não foi possível encontrar seu contrato de trabalho ativo. Por favor, tente novamente mais tarde. default: description: Error response schema: #/definitions/genericError /happiness_index/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/importEmployeeMood: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/importReason: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/importGroupReason: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/importSubGroupReason: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/actions/importMoodReason: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/events/importEmployeeMoodEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/exportEmployeeMoodEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/importReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/exportReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/importGroupReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/exportGroupReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/importSubGroupReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/exportSubGroupReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/importMoodReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/events/exportMoodReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /happiness_index/entities/employeeMood: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeMood responses: 200: description: The created resource schema: #/definitions/employeeMood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeMood responses: 200: description: The created resource schema: #/definitions/employeeMood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/employeeMood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/employeeMood/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeMood responses: 200: description: Ok schema: #/definitions/employeeMood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeMood responses: 200: description: Ok schema: #/definitions/employeeMood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeMood 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/employeeMood/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeMood responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/reason: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reason responses: 200: description: The created resource schema: #/definitions/reason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reason responses: 200: description: The created resource schema: #/definitions/reason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/reason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/reason/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reason responses: 200: description: Ok schema: #/definitions/reason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reason responses: 200: description: Ok schema: #/definitions/reason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/reason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/reason/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/reason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/groupReason: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/groupReason responses: 200: description: The created resource schema: #/definitions/groupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/groupReason responses: 200: description: The created resource schema: #/definitions/groupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/groupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/groupReason/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/groupReason responses: 200: description: Ok schema: #/definitions/groupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/groupReason responses: 200: description: Ok schema: #/definitions/groupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/groupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/groupReason/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/groupReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/subGroupReason: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/subGroupReason responses: 200: description: The created resource schema: #/definitions/subGroupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/subGroupReason responses: 200: description: The created resource schema: #/definitions/subGroupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/subGroupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/subGroupReason/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/subGroupReason responses: 200: description: Ok schema: #/definitions/subGroupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/subGroupReason responses: 200: description: Ok schema: #/definitions/subGroupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/subGroupReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/subGroupReason/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/subGroupReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/moodReason: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/moodReason responses: 200: description: The created resource schema: #/definitions/moodReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/moodReason responses: 200: description: The created resource schema: #/definitions/moodReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/moodReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/moodReason/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/moodReason responses: 200: description: Ok schema: #/definitions/moodReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/moodReason responses: 200: description: Ok schema: #/definitions/moodReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/moodReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /happiness_index/entities/moodReason/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/moodReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckStatus: description: Contém os estados do healthcheck da plataforma. type: string enum: – UP – DOWN moodType: description: Contém os estados de humor que o usuário pode usar para representar seu índice de felicidade. type: string enum: – GREAT – FINE – NEUTRAL – UPSET – ANGRY userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckChecks: description: Contém a verificação e seu respectivo estado para retornar ao healthcheck da plataforma. type: object required: – name – status properties: name: type: string description: Nome do estado. status: type: string allOf: – #/definitions/healthcheckStatus description: Estado. reasonDto: description: Contém o retorno das razões do sentimento. type: object required: – id – description – subGroupReasonId properties: id: type: string description: Identificador único do reasonDTO. description: type: string maxLength: 255 description: nome das razões do sentimento subGroupReasonId: type: string description: Identificador único subGroupReason ao qual o sentimento pertence. subGroupReasonDto: description: Contém o retorno dos subgrupos das razões do sentimento. type: object required: – id – groupReasonId – name – isDefault – reason properties: id: type: string description: Identificador único do subGroupReason. groupReasonId: type: string description: Identificador único do GroupReason ao qual o subgrupo pertence. name: type: string maxLength: 255 description: Nome do subgrupo das razões do sentimento. isDefault: type: boolean description: Valida se o subgrupo é padrão (default). reason: type: array items: type: object allOf: – #/definitions/reasonDto minimum: 1 description: Lista de razões do sentimento. groupReasonDto: description: Contém o retorno dos grupos de razões do sentimento. type: object required: – id – name – subGroupReason properties: id: type: string description: Identificador único do groupReason. name: type: string maxLength: 255 description: Nome do grupo das razões do sentimento. subGroupReason: type: array items: type: object allOf: – #/definitions/subGroupReasonDto minimum: 1 description: Lista de subGroupReason. myMoodRecordsDto: description: Contém o retorno dos sentimentos do colaborador. type: object required: – dateMood – mood – groupReason properties: dateMood: type: string format: date-time description: Data do sentimento do colaborador. mood: type: string allOf: – #/definitions/moodType description: Sentimento do dia do colaborador. groupReason: type: array items: type: object allOf: – #/definitions/groupReasonDto minimum: 1 description: Razões do contexto do sentimento do colaborador no dia. notes: type: string maxLength: 255 description: Nota atribuída à escolha do sentimento do colaborador de forma mais detalhada. employeeMood: description: Armazena as informações do índice de felicidade de um colaborador. type: object required: – departmentId – mood – moodDate – hierarchyFilter properties: id: type: string format: uuid description: Identificador único do sentimento do colaborador. employeeId: type: string maxLength: 32 description: Identificador único do colaborador. departmentId: type: string maxLength: 32 description: Identificador único do departamento. mood: type: string allOf: – #/definitions/moodType description: Sentimento apontado pelo colaborador. moodDate: type: string format: date-time description: Data em que o sentimento foi apontado pelo colaborador. hierarchyFilter: type: string maxLength: 255 description: Filtro de liderados do colaborador. notes: type: string maxLength: 255 description: uma nota sobre o porque da escolha do sentimento reason: description: Armazena os sentimentos do colaborador. type: object required: – id – description – subGroupReasonId properties: id: type: string format: uuid description: Identificador único do sentimento do colaborador. description: type: string maxLength: 255 description: Nome do grupo das razões do sentimento. x-i18n: true subGroupReasonId: type: string format: uuid description: Identificador do sub-grupo ao qual o sentimento pertence. translations: type: object properties: locale: type: object properties: description: type: string maxLength: 255 example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. groupReason: description: Armazena os grupos das razões do sentimento. type: object required: – id – name properties: id: type: string format: uuid description: Identificador único do grupo de razões do sentimento. name: type: string maxLength: 255 description: Nome do grupo das razões do sentimento. x-i18n: true translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. subGroupReason: description: Armazena os subgrupos das razões do sentimento. type: object required: – id – name – isDefault – groupReasonId properties: id: type: string format: uuid description: Identificador único do subgrupo de razões do sentimento. name: type: string maxLength: 255 description: Nome dos subgrupos das razões do sentimento. x-i18n: true isDefault: type: boolean description: Indica se o subgrupo é padrão (default). groupReasonId: type: string format: uuid description: Identificador único do grupo ao qual o subgrupo pertence. translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. moodReason: description: Armazena as razões do sentimento do colaborador no dia. type: object required: – id – idMood – idReason properties: id: type: string format: uuid description: Identificador único do moodReason. idMood: type: object allOf: – #/definitions/employeeMood description: Identificador único do registro do sentimento do dia idReason: type: object allOf: – #/definitions/reason description: Identificador único da razão do sentimento no dia notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE