2.0info: 12.1.9 (PRIVATE) – moods description: Moods x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: moods contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /private/hcm/moodssecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /getImportEmployeeResult: post: description: Retorna o tenant e informações relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: id único responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError /updateBranchOfficeHistorical: post: description: Atualizar histórico x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – historical properties: historical: #/definitions/branchOfficeHistorical responses: 200: description: Ok schema: type: object required: – historical properties: historical: #/definitions/branchOfficeHistorical default: description: Error response schema: #/definitions/genericError /saveEmployee: post: description: Cria ou atualiza um colaborador com os dados informados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employee properties: employee: #/definitions/employeeDTO responses: 200: description: Ok schema: type: object properties: employee: #/definitions/employeeDTO default: description: Error response schema: #/definitions/genericError /updateTenant: post: description: Update tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: #/definitions/tenant responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /updateCompany: post: description: Atualizar empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – company properties: company: #/definitions/company responses: 200: description: Ok schema: type: object required: – company properties: company: #/definitions/company default: description: Error response schema: #/definitions/genericError /updateDimension: post: description: Edtiar dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dimension properties: dimension: #/definitions/dimension responses: 200: description: Ok schema: type: object required: – dimension properties: dimension: #/definitions/dimensionOut default: description: Error response schema: #/definitions/genericError /retrieveBranchOfficeHistorical: post: description: Buscar histórico x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – historicalID properties: historicalID: type: string description: Id do Histórico a ser buscado responses: 200: description: Ok schema: type: object required: – historical properties: historical: #/definitions/branchOfficeHistorical default: description: Error response schema: #/definitions/genericError /healthcheck: post: description: HealthCheck Plataforma x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/heathcheckDTO checks: #/definitions/checkDTO default: description: Error response schema: #/definitions/genericError /retrieveCompany: post: description: Buscar empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da empresa a ser buscada responses: 200: description: Ok schema: type: object required: – company properties: company: #/definitions/company default: description: Error response schema: #/definitions/genericError /deleteCompany: post: description: Excluir empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da empresa a ser deletada responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /setHierarchy: post: description: Cria os itens de uma hierarquia.
Caso já existam itens nessa hierarquia ele são removidos. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchy – shouldResetHierarchy properties: hierarchy: type: string description: Hierarquia que deve ter os itens criados. items: type: array items: #/definitions/hierarchyItemInput description: Itens que devem ser criados. companies: type: array items: #/definitions/companyHierarchyInput description: Empresas que utilizam a hierarquia shouldResetHierarchy: type: boolean description: Se deve limpar a hierarquia responses: 200: description: Ok schema: type: object required: – hierarchy properties: hierarchy: type: string description: Identificador único da hierarquia que foi atualizada. parents: #/definitions/hierarchyItem default: description: Error response schema: #/definitions/genericError /countPulses: post: description: Retorna a quantidade total de pulsos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object properties: amount: type: integer description: Quantidade total de pulsos default: description: Error response schema: #/definitions/genericError /createHierarchy: post: description: Criar hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchy properties: hierarchy: #/definitions/hierarchy responses: 200: description: Ok schema: type: object required: – hierarchy properties: hierarchy: #/definitions/hierarchy default: description: Error response schema: #/definitions/genericError /retrieveHierarchyItem: post: description: Retorna item de hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do item de hierarquia a ser buscado responses: 200: description: Ok schema: type: object required: – hierarchyItem properties: hierarchyItem: #/definitions/hierarchyItem default: description: Error response schema: #/definitions/genericError /createPulseResult: post: description: Criar Resultado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseResult properties: pulseResult: #/definitions/pulseResult responses: 200: description: Ok schema: type: object required: – pulseResult properties: pulseResult: #/definitions/pulseResult default: description: Error response schema: #/definitions/genericError /getCompany: post: description: Retorna a empresa e informações relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – company properties: company: #/definitions/companyDTO default: description: Error response schema: #/definitions/genericError /deleteBranchOfficeHistorical: post: description: Excluir histórico x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – historicalId properties: historicalId: type: string description: Id do Histórico a ser deletado responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /createPulse: post: description: Cria um pulso da pesquisa de clima, caso necessário.
Para gerar um pulso é necessário que:
– A pesquisa de clima esteja habilitada;
– A data do último pulso + 7 ou 14 dias(dependendo da periodicidade) seja menor ou igual à data atual;
– O dia de semana da data atual seja igual ao dia de semana configurado na pesquisa.
O público alvo são os liderados diretos dos gestores que estiverem configurados na pesquisa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object properties: pulseId: type: string description: Id do pulso pulseAnswerRespondentsEmail: #/definitions/pulseAnswerRespondent pulseAnswerRespondentsSMS: #/definitions/pulseAnswerRespondent default: description: Error response schema: #/definitions/genericError /getAnswerTicketRespondent: post: description: Busca respostas por pulso x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseId properties: pulseId: type: string description: Identificador do pulso page: type: integer description: Página responses: 200: description: Ok schema: type: object required: – items – currentPage – pages – total properties: items: #/definitions/answerTicketRepondentDTO currentPage: type: integer description: Página atual pages: type: integer description: Total de páginas total: type: integer description: Total de elementos default: description: Error response schema: #/definitions/genericError /retrieveHierarchy: post: description: Buscar hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchyId properties: hierarchyId: type: string description: Id da Hierarquia que será buscada responses: 200: description: Ok schema: type: object required: – hierarchy properties: hierarchy: #/definitions/hierarchy default: description: Error response schema: #/definitions/genericError /findLeaders: post: description: Obtém todos os colaboradores liderados do colaborador passado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: leaderId: type: string description: Id do líder que se deseja retornar os liderados responses: 200: description: Ok schema: type: object required: – employees properties: employees: #/definitions/employee default: description: Error response schema: #/definitions/genericError /updateSurveyConfig: post: description: Serviço para atualizar uma configuração de pesquisa de clima x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – survey properties: survey: #/definitions/climateSurvey responses: 200: description: Ok schema: type: object required: – survey properties: survey: #/definitions/climateSurvey smsMessageSize: type: integer description: Tamanho permitido para a mensagem de texto a ser enviada por SMS default: description: Error response schema: #/definitions/genericError /anonymous/shortToLongSurveyUrl: post: description: Retorna a URL Longa com base na URL Curta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – shortUrl properties: shortUrl: type: string description: Url encurtada para acesso à pesquisa responses: 200: description: Ok schema: type: object required: – longUrl properties: longUrl: type: string description: Url para acesso à pesquisa concatenada com o prefixo definido nas configurações da plataforma default: description: Error response schema: #/definitions/genericError /updateQuestionStatusAndImage: post: description: Serviço para atualizar o status e/ou imagem de uma questão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – questionId – enabled properties: questionId: type: string description: Id da questão enabled: type: boolean description: Indica se a questão ficará ativa imageId: type: string description: Id da imagem responses: 200: description: Ok schema: #/definitions/question default: description: Error response schema: #/definitions/genericError /npsScore: post: description: Retorna a pontuação de NPS (Net Promoter Score) da última avaliação x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – detractorsPercentage – detractors – passivesPercentage – passives – promotersPercentage – promoters – score – pulseIdentifier – status properties: detractorsPercentage: type: number description: Percentual de detratores. detractors: type: integer description: Quantidade de detratores. passivesPercentage: type: number description: Percentual de passivos. passives: type: integer description: Quantidade de passivos. promotersPercentage: type: number description: Percentual de promotores. promoters: type: integer description: Qunatidade de promotores. score: type: integer description: Pontuação. pulseIdentifier: type: string description: Identificador do pulso status: #/definitions/npsChartState default: description: Error response schema: #/definitions/genericError /employeeBatch: post: description: Serviço para criar colaboradores em lote. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: #/definitions/employeeDTO description: Colaboradores que devem ser criados. responses: 200: description: Ok schema: type: object required: – ids properties: ids: type: string description: Identificador dos colaboradores que foram criados. Estão na mesma ordem em que foram recebidos. default: description: Error response schema: #/definitions/genericError /anonymous/getTenantByShortHash: post: description: Retorna o tenant e informações relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – shortHash properties: shortHash: type: string description: Short hash único responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /getCommentsCountGroupByDimension: post: description: Obtém a quantidade de comentários por dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Quantidade de dimensões para retornar por página page: type: integer description: Página requisitada ticket: type: string description: Ticket identificador do filtro do Analytics responses: 200: description: Ok schema: type: object required: – totalComments – lastPulseTotalComments – found properties: dimensions: #/definitions/commentsCountGroupByDimension totalComments: type: integer description: Quantidade total de comentários lastPulseTotalComments: type: integer description: Quantidade total de comentários do último pulso found: type: integer description: Quantidade totalde dimensões default: description: Error response schema: #/definitions/genericError /deleteHierarchy: post: description: Excluir hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchyId properties: hierarchyId: type: string description: Id da Hierarquia que será excluida responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /createQuestion: post: description: Cria e persiste nova questão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – question properties: question: #/definitions/question responses: 200: description: Ok schema: type: object required: – question properties: question: #/definitions/questionOut default: description: Error response schema: #/definitions/genericError /findEmployees: post: description: Obtém todos os colaboradores que atendem o filtro informado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – showExcluded properties: term: type: string description: Utilizado para filtrar os colaboradores pelo email page: type: integer description: Página(Iniciando em 1) size: type: integer description: Tamanho da página showExcluded: type: boolean description: Exibir colaboradores desligados responses: 200: description: Ok schema: type: object required: – employees – pages – total properties: employees: #/definitions/employeeSummaryDTO pages: type: integer description: Total de páginas total: type: integer description: Total de elementos default: description: Error response schema: #/definitions/genericError /updateHierarchy: post: description: Atualizar hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchy properties: hierarchy: #/definitions/hierarchy responses: 200: description: Ok schema: type: object required: – hierarchy properties: hierarchy: #/definitions/hierarchy default: description: Error response schema: #/definitions/genericError /emailInUse: post: description: Indica se o email informado já está em uso por outro colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: Email a ser verificado employeeId: type: string description: Colaborador, usamos para exclui-lo da consulta, pois ele mesmo pode ter o email informado. responses: 200: description: Ok schema: type: object required: – emailInUse properties: emailInUse: type: boolean description: Se o email está em uso default: description: Error response schema: #/definitions/genericError /deleteQuestion: post: description: Excluir questão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Questão responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /subordinatesSituation: post: description: Retorna todos os subordinados conforme leadersSituation, carregamento lazy x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – leaderId properties: leaderId: type: string description: Termos que devem ser buscados no texto da pergunta. q: type: string description: Termos que devem ser buscados no texto da pergunta. page: type: integer description: Página que deve ser retornada, começando em 1. (Padrão 1) size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) responses: 200: description: Ok schema: type: object required: – subordinates properties: subordinates: #/definitions/subordinate default: description: Error response schema: #/definitions/genericError /defineSurveyEvaluated: post: description: Informa líderes que devem ser avaliados no pulso da pesquisa de clima. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: leaders: type: array items: type: string description: Identificador único dos líderes que devem ser avaliados. allLeaders: type: boolean description: Marcar todos q: type: string description: Termo para buscar os gestores pelo seu nome/email ou de seus liderados responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a alteração foi realizada com sucesso. default: description: Error response schema: #/definitions/genericError /npsScorePulseDetail: post: description: Obtém a satisfação das questões do pulso informado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – target properties: pulseId: type: string description: Id do pulso leaderId: type: string description: Id do leader target: #/definitions/scoreDetailsTarget responses: 200: description: Ok schema: type: object required: – detractorsPercentage – detractors – passivesPercentage – passives – promotersPercentage – promoters – score – pulseIdentifier – status properties: detractorsPercentage: type: number description: Percentual de detratores. detractors: type: integer description: Quantidade de detratores. passivesPercentage: type: number description: Percentual de passivos. passives: type: integer description: Quantidade de passivos. promotersPercentage: type: number description: Percentual de promotores. promoters: type: integer description: Qunatidade de promotores. score: type: integer description: Pontuação. pulseIdentifier: type: string description: Identificador do pulso status: #/definitions/npsChartState default: description: Error response schema: #/definitions/genericError /deleteDimension: post: description: Excluir dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Dimensão a ser deletada responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /createDimension: post: description: Cria dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dimension properties: dimension: #/definitions/dimension responses: 200: description: Ok schema: type: object required: – dimension properties: dimension: #/definitions/dimensionOut default: description: Error response schema: #/definitions/genericError /createTenant: post: description: Criar tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: #/definitions/tenant responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /listJobPositions: post: description: Serviço que retorna os cargos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – jobPositions properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros jobPositions: #/definitions/jobPositionDTO default: description: Error response schema: #/definitions/genericError /saveBranchOffice: post: description: Cria/atualiza uma filial x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – branchOffice properties: branchOffice: #/definitions/branchOfficeDTO responses: 200: description: Ok schema: type: object required: – branchOffice properties: branchOffice: #/definitions/branchOfficeDTO default: description: Error response schema: #/definitions/genericError /searchLeaders: post: description: Busca os liderados de um colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – role properties: page: type: integer description: Página a ser buscada size: type: integer description: Tamanho da página q: type: string description: Filtro por nome do colaborador. role: #/definitions/employeeRoleType selectedPulsesId: type: array items: type: string description: Pulsos selecionados isAnalytics: type: boolean description: Solicitação apartir do Analytics ticket: type: string description: Ticket referente a filtros do Analytics responses: 200: description: Ok schema: type: object properties: leaders: #/definitions/employeeInfo selectedLeaders: #/definitions/employeeInfo blockedLeaders: type: boolean description: Bloqueia seleção de gestories default: description: Error response schema: #/definitions/genericError /notifyMoodsCoupledHcm: post: description: Indica se foi feita a carga inicial da base do hcm para o moods x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – coupled properties: coupled: type: boolean description: Indica se foi feito a carga inicial do hcm para o moods responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /listCompanies: post: description: Serviço que retorna as empresas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – companies properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros companies: #/definitions/companyDTO default: description: Error response schema: #/definitions/genericError /anonymous/answerSurvey: post: description: Responde um pulso da pesquisa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – pulseAnswer properties: pulseAnswer: type: string description: Identificador único da resposta do pulso. answers: type: array items: #/definitions/questionAnswer description: Respostas das perguntas do pulso. npsAnswer: type: integer description: Resposta da questão NPS responses: 200: description: Ok schema: type: object required: – answered properties: answered: type: boolean description: Indica se a resposta foi bem sucedida. default: description: Error response schema: #/definitions/genericError /pulseScoreAverage: post: description: Retorna a pontuação média do pulso mais recente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: leaderId: type: string description: Id do líder que deseja obter a pontuação médial do pulso mais recente. responses: 200: description: Ok schema: type: object required: – startDate – endDate – score – status properties: startDate: type: string description: Data inicial do pulso. endDate: type: string description: Data final do pulso. attendance: type: number description: Assiduidade do pulso. score: type: number description: Pontuação média do pulso. status: #/definitions/pointTrend default: description: Error response schema: #/definitions/genericError /listWorkstationGroups: post: description: Serviço que retorna os postos de trabalho x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – workstationGroups properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros workstationGroups: #/definitions/workstationGroupDTO default: description: Error response schema: #/definitions/genericError /leadersSituation: post: description: Retorna todos os líderes com uma flag indicando se ele está sendo avaliado na pesquisa de clima x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: q: type: string description: Termos que devem ser buscados no texto da pergunta. page: type: integer description: Página que deve ser retornada, começando em 1. (Padrão 1) size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) responses: 200: description: Ok schema: type: object required: – found – allEvaluated properties: leaders: #/definitions/leaderSituation found: type: integer description: Total de comentários encontrados pela busca. allEvaluated: type: boolean description: Todos estão avaliados evaluatedLeaders: type: string description: Líderes avaliados default: description: Error response schema: #/definitions/genericError /allowThirdParties: post: description: Retorna se deve ou não levar em consideração colaboradores terceirizados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object properties: allowThirdParties: type: boolean description: Flag que indica se deve ou não considerar terceiros default: description: Error response schema: #/definitions/genericError /containsPulseSendTypeSmsOrBothWithNoEmail: post: description: Retorna se possui algum colaborador com tipo de envio de pulso por sms ou ambos e não contém e-mail. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – containsPulseSendTypeSmsOrBothWithNoEmail properties: containsPulseSendTypeSmsOrBothWithNoEmail: type: boolean description: Represente se há colaborador com tipo de envio de pulso por sms ou ambos e não contém e-mail default: description: Error response schema: #/definitions/genericError /getEmployee: post: description: Retorna o colaborador e informações relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do colaborador responses: 200: description: Ok schema: type: object required: – employee properties: employee: #/definitions/employeeDTO default: description: Error response schema: #/definitions/genericError /createBranchOfficeHistorical: post: description: Criar histórico x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – historical properties: historical: #/definitions/branchOfficeHistorical responses: 200: description: Ok schema: type: object required: – historical properties: historical: #/definitions/branchOfficeHistorical default: description: Error response schema: #/definitions/genericError /requestFileAccess: post: description: Solicitação para acessar um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. ttl: type: integer description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado. responses: 200: description: Ok schema: type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download. default: description: Error response schema: #/definitions/genericError /deletePulse: post: description: Serviço para exclusão de pulso x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseId properties: pulseId: type: string description: Id do Pulso responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Resposta default: description: Error response schema: #/definitions/genericError /uploadEmployeePhoto: post: description: Atualiza foto do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: photos: type: array items: #/definitions/employeePhoto description: Lista de fotos do colaborador responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retrieveQuestion: post: description: Retorna questão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Questão responses: 200: description: Ok schema: type: object required: – question properties: question: #/definitions/questionOut default: description: Error response schema: #/definitions/genericError /importEmployees: post: description: Serviço para criar os dados importados dos colaboradores. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: #/definitions/importEmployeeDTO description: Colaborador que será importados overwriteExistingData: type: boolean description: Sobrescrever registros existentes responses: 200: description: Ok schema: type: object properties: employeesSuccessfulImported: #/definitions/employeeDTO employeesDataExceptions: #/definitions/employeeDataExceptions default: description: Error response schema: #/definitions/genericError /updateHierarchyItem: post: description: Alterar item de hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchyItem properties: hierarchyItem: #/definitions/hierarchyItemInput responses: 200: description: Ok schema: type: object required: – hierarchyItem properties: hierarchyItem: #/definitions/hierarchyItem default: description: Error response schema: #/definitions/genericError /hierarchyBatch: post: description: Serviço para criar hierarquias em lote. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchies properties: hierarchies: type: array items: #/definitions/hierarchy description: Hierarquias que devem ser criadas. responses: 200: description: Ok schema: type: object required: – ids properties: ids: type: string description: Identificador das hierarquias que foram criadas. Estão na mesma ordem em que foram recebidas. default: description: Error response schema: #/definitions/genericError /pulseHistory: post: description: Retorna o histórico dos ultimos pulso x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: amount: type: integer description: Quantidade de pulsos para retornar responses: 200: description: Ok schema: type: object required: – averageSatisfaction properties: averageSatisfaction: #/definitions/pulseAverage default: description: Error response schema: #/definitions/genericError /currentPulsePeriodicity: post: description: Retorna a periodicidade definida na configuração do pulso x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – currentPulsePeriodicity properties: currentPulsePeriodicity: type: string description: Periodicidade definida na configuração do pulso default: description: Error response schema: #/definitions/genericError /changeQuestionStatus: post: description: Altera o status de ativo/inativo de uma questão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – questionId – enabled properties: questionId: type: string description: Id da questão. enabled: type: boolean description: Indica se a questão ficará ativa. responses: 200: description: Ok schema: type: object required: – question properties: question: #/definitions/question default: description: Error response schema: #/definitions/genericError /sendMailToRespondents: post: description: Envia um e-mail para todos os respondentes de um pulso. O e-mail contém o link para o colaborador responder ao pulso da pesquisa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseId – pulseAnswerRespondents properties: pulseId: type: string description: Id do pulso pulseAnswerRespondents: type: array items: #/definitions/pulseAnswerRespondent description: Lista com associação entre cada PulseAnswer e PulseRespondent responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /commitUploadedFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. responses: 200: description: Ok schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. default: description: Error response schema: #/definitions/genericError /searchCommentsOfDimension: post: description: Retorna os comentários da dimensão informada x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dimensionId properties: q: type: string description: Termo a ser pesquisado no comentário, pergunta ou dimensão. page: type: integer description: Página que deve ser retornada, começando em 1. (Padrão 1) size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) dimensionId: type: string description: Id da dimensão em que o comentário foi escrito. responses: 200: description: Ok schema: type: object required: – dimensionId – description – found – comments properties: dimensionId: type: string description: Identificador único da dimensão. description: type: string description: Descrição da dimensão. found: type: integer description: Total de comentários encontrados para a dimensão. comments: #/definitions/commentSearch default: description: Error response schema: #/definitions/genericError /getDefaultPulseSendType: post: description: Retorna o tipo padrão de envio do pulso da configuração da pesquisa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – defaultPulseSendType properties: defaultPulseSendType: #/definitions/pulseSendType default: description: Error response schema: #/definitions/genericError /deleteCompanyHierarchy: post: description: Excluir Hierarquia de empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyHierarchyId properties: companyHierarchyId: type: string description: Id da Hierarquia de empresa a ser deletada responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /changeDimensionStatus: post: description: Altera o status de ativo/inativo de uma dimensão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dimensionId – enabled properties: dimensionId: type: string description: Id da dimensão. enabled: type: boolean description: Indica se a dimensão ficará ativa. responses: 200: description: Ok schema: type: object required: – dimension properties: dimension: #/definitions/dimension default: description: Error response schema: #/definitions/genericError /getEmployeeObjectOfAnalysis: post: description: Retorna os dados do objeto de análise do Moods x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Usuário do colaborador employeeId: type: string description: Identificador único do colaborador responses: 200: description: Ok schema: type: object required: – employeeId – employeeName – companyName – jobPositionName – departmentName – employeeLeaderName – photoLink – leaderPhotoLink properties: employeeId: type: string description: Id do Employee employeeName: type: string description: Nome do colaborador. companyName: type: string description: Nome da empresa do colaborador jobPositionName: type: string description: Nome do cargo da pessoa. departmentName: type: string description: Nome do local de trabalho da pessoa. employeeLeaderName: type: string description: Nome do líder do colaborador. photoLink: type: string description: Link da foto do colaborador. leaderPhotoLink: type: string description: Link da foto do colaborador. default: description: Error response schema: #/definitions/genericError /sendEmailTest: post: description: Envia um email de teste x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – recipient – sender – senderName – subject – message properties: recipient: type: string description: Email de teste sender: type: string description: Remetente do email senderName: type: string description: Nome do remetente do email subject: type: string description: Assunto do email message: type: string description: Menssagem do email responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: Status do envio default: description: Error response schema: #/definitions/genericError /searchComments: post: description: Busca os comentários das respostas.
Os comentários podem ser filtrados pelo comentário, pergunta ou dimensão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: q: type: string description: Termo a ser pesquisado no comentário, pergunta ou dimensão. page: type: integer description: Página que deve ser retornada, começando em 1. (Padrão 1) size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) pulseId: type: string description: Id do pulso que deve ter os comentários retornados. (Opcional) responses: 200: description: Ok schema: type: object required: – found – comments properties: found: type: integer description: Total de comentários encontrados pela busca. comments: #/definitions/commentWithDimensionSearch default: description: Error response schema: #/definitions/genericError /getSurveyAnalysts: post: description: Retorna os employees que são analista da pesquisa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Página que deve ser retornada, começando em 1. (Padrão 1) size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) responses: 200: description: Ok schema: type: object required: – employees – found properties: employees: #/definitions/employee found: type: integer description: Quantidade total de analistas default: description: Error response schema: #/definitions/genericError /questionsByDimension: post: description: Retorna todas questões da dimensão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dimension properties: dimension: type: string description: Identificador único da dimensão. responses: 200: description: Ok schema: type: object required: – questions properties: questions: #/definitions/questionSummary default: description: Error response schema: #/definitions/genericError /retrieveCompanyHierarchy: post: description: Buscar Hierarquia de empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyHierarchyId properties: companyHierarchyId: type: string description: Id da Hierarquia de empresa que será pesquisada responses: 200: description: Ok schema: type: object required: – companyHierarchy properties: companyHierarchy: #/definitions/companyHierarchy default: description: Error response schema: #/definitions/genericError /companyBatch: post: description: Serviço para criar empresas em lote. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companies properties: companies: type: array items: #/definitions/company description: Empresas que devem ser criadas. responses: 200: description: Ok schema: type: object required: – ids properties: ids: type: string description: Identificador das empresas que foram criadas. Estão na mesma ordem em que foram recebidas. default: description: Error response schema: #/definitions/genericError /generateLongAndShortUrl: post: description: Gera LongUrl e ShortUrl para ticket x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant – shortHash – pulseId – quantity properties: tenant: type: string description: Tenant para quem vai ser gerado shortHash: type: string description: Hash do tenant pulseId: type: string description: Id do pulso quantity: type: integer description: Quantidade responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Lista de resultados default: description: Error response schema: #/definitions/genericError /getTenantById: post: description: Retorna o tenant e informações relacionadas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: id único responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /getDimensions: post: description: Retorna as dimensões ativas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – dimensions properties: dimensions: #/definitions/dimensionInfo default: description: Error response schema: #/definitions/genericError /statusPanel: post: description: Retorna as informações da pesquisa de clima. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – periodicity – amount – nextPulse – endatPulse – createdAt – nextPulseReminder properties: enabled: type: boolean description: Situação da Pesquisa (habilitada ou desabilitada) periodicity: #/definitions/periodicity amount: type: integer description: Quantidade de pulsos nextPulse: type: string description: Data do próximo pulso endatPulse: type: string description: Data do próximo pulso createdAt: type: string description: Data de criação do pulso nextPulseReminder: type: string description: Data do próximo lembrete do pulso default: description: Error response schema: #/definitions/genericError /getAllCompaniesHeadQuarters: post: description: Retorna todos os registros da entidade Company que são do tipo 'Head Quarter'. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – companies properties: companies: #/definitions/company default: description: Error response schema: #/definitions/genericError /employeeActualBranchOffice: post: description: Retorna o BranchOffice atual do employee com base no Id do employee x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: ID do employee responses: 200: description: Ok schema: type: object required: – branchOffice properties: branchOffice: #/definitions/company default: description: Error response schema: #/definitions/genericError /scoreByPulse: post: description: Obtém os dados do painel do gestor x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: leaderId: type: string description: Id do líder que deve ter os dados do dashboard retornado (caso não for informado retorna o do usuário logado). selectedManagers: type: array items: type: string description: Ids dos gestores selecionados ticket: type: string description: Ticket referente ao filtro do analytics responses: 200: description: Ok schema: type: object properties: leaderScores: #/definitions/pulseScoreCommon companyScores: #/definitions/pulseScoreCommon myDepartmentScores: #/definitions/pulseScoreCommon leadersLedScores: #/definitions/managerPulseScores default: description: Error response schema: #/definitions/genericError /npsByPulse: post: description: Obtém os dados do nps x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: leaderId: type: string description: Id do líder que deve ter os dados do dashboard retornado (caso não for informado retorna o do usuário logado). selectedManagers: type: array items: type: string description: Ids dos gestores selecionados ticket: type: string description: Ticket referente ao filtro do analytics target: #/definitions/scoreDetailsTarget responses: 200: description: Ok schema: type: object properties: leaderScores: #/definitions/npsScoreCommon companyScores: #/definitions/npsScoreCommon myDepartmentScores: #/definitions/npsScoreCommon leadersLedScores: #/definitions/managerNpsScores default: description: Error response schema: #/definitions/genericError /retrieveDimension: post: description: retornar dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da dimensão a ser buscada responses: 200: description: Ok schema: type: object required: – dimension properties: dimension: #/definitions/dimensionOut default: description: Error response schema: #/definitions/genericError /getHcmIntegrationVersion: post: description: Obtém a versão de integração com o HCM x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – version properties: type: integer description: Versão de integração com o HCM default: description: Error response schema: #/definitions/genericError /companyHierarchyBatch: post: description: Serviço para criar ligação entre empresas e hierarquias em lote. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyHierarchies properties: companyHierarchies: type: array items: #/definitions/companyHierarchy description: Ligações entre empresas e hierarquias que devem ser criadas. responses: 200: description: Ok schema: type: object required: – ids properties: ids: type: string description: Identificador das ligações que foram criadas. Estão na mesma ordem em que foram recebidas. default: description: Error response schema: #/definitions/genericError /listCompaniesToComponent: post: description: Busca empresas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: q: type: string description: Filtro headquarter: type: string description: Matriz caso filiais responses: 200: description: Ok schema: type: object required: – items properties: items: #/definitions/commonToComponent default: description: Error response schema: #/definitions/genericError /searchQuestionsByDimension: post: description: Busca as questões que contém os termos informados e retorna elas agrupadas por dimensão.
Caso não seja informado nenhum termo são retornadas todas as dimensões existentes. (Sem as suas questões) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: q: type: string description: Termos que devem ser buscados no texto da pergunta. responses: 200: description: Ok schema: type: object properties: dimensions: #/definitions/dimensionSearch default: description: Error response schema: #/definitions/genericError /phoneInUse: post: description: Indica se o telefone informado já está em uso por outro colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – phone properties: phone: #/definitions/employeePhone employeeId: type: string description: Colaborador, usamos para exclui-lo da consulta, pois ele mesmo pode ter o telefone informado. responses: 200: description: Ok schema: type: object required: – phoneInUse properties: phoneInUse: type: boolean description: Se o telefone está em uso default: description: Error response schema: #/definitions/genericError /listEmployeesToComponent: post: description: Busca colaboradores x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: q: type: string description: Filtro isLeader: type: boolean description: Caso queria retornar apenas líderes responses: 200: description: Ok schema: type: object required: – items properties: items: #/definitions/commonToComponent default: description: Error response schema: #/definitions/genericError /listDepartments: post: description: Serviço que retorna os departamentos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – departments properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros departments: #/definitions/departmentDTO default: description: Error response schema: #/definitions/genericError /getLastNPulses: post: description: Retorna os ultimos 50 pulsos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: amount: type: integer description: Quantidade de pulsos a ser retornado responses: 200: description: Ok schema: type: object required: – pulses properties: pulses: #/definitions/pulseInfo default: description: Error response schema: #/definitions/genericError /createCompanyHierarchy: post: description: Criar Hierarquia de empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyHierarchy properties: companyHierarchy: #/definitions/companyHierarchy responses: 200: description: Ok schema: type: object required: – companyHierarchy properties: companyHierarchy: #/definitions/companyHierarchy default: description: Error response schema: #/definitions/genericError /questionScores: post: description: Obtém a satisfação das questões do pulso informado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – target properties: pulseId: type: string description: Id do pulso leaderId: type: string description: Id do leader target: #/definitions/scoreDetailsTarget page: type: integer description: Página que será demonstrada size: type: integer description: Quantidade de registros demonstrados por página responses: 200: description: Ok schema: type: object required: – found properties: questionScores: #/definitions/pulseQuestionScores found: type: integer description: Quantidade de registros encontrados default: description: Error response schema: #/definitions/genericError /createCompany: post: description: Criar empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – company properties: company: #/definitions/company responses: 200: description: Ok schema: type: object required: – company properties: company: #/definitions/company default: description: Error response schema: #/definitions/genericError /deletePulseResult: post: description: Deleta Resultado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseResultId properties: pulseResultId: type: string description: Id do Resultado a ser deletado responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /getLeaderAverageScoreGroupByDimensions: post: description: Obtém a satisfação do gestor agrupada por dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseId – leaderId properties: pulseId: type: string description: Id do pulso leaderId: type: string description: Id do gestor responses: 200: description: Ok schema: type: object required: – averages properties: averages: #/definitions/leaderAverageScoreGroupByDimension default: description: Error response schema: #/definitions/genericError /canEmployeeBeLeader: post: description: Indica se o colaborador informado pode ser líder x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do colaborador responses: 200: description: Ok schema: type: object required: – canBeLeader properties: canBeLeader: type: boolean description: Se o colaborador informado pode ser líder default: description: Error response schema: #/definitions/genericError /averageDimensionPointHrAnalyst: post: description: Obtém a satisfação do ponto de vista do analista da pesquisa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseId properties: pulseId: type: string description: Id do pulso responses: 200: description: Ok schema: type: object required: – startDate – endDate – averagePeriod – engagementPercentage – averages properties: startDate: type: string description: Data Inicial da Faixa pesquisada endDate: type: string description: Data final da Faixa pesquisada averagePeriod: type: number description: Média do período engagementPercentage: type: number description: Porcentagem de engajamento averages: #/definitions/dimensionPoint default: description: Error response schema: #/definitions/genericError /createHierarchyItem: post: description: Criar item de hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – hierarchyItem properties: hierarchyItem: #/definitions/hierarchyItemInput responses: 200: description: Ok schema: type: object required: – hierarchyItem properties: hierarchyItem: #/definitions/hierarchyItem default: description: Error response schema: #/definitions/genericError /dimensionHistory: post: description: Obtém histórico de uma determinada dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dimensionId – target properties: leaderId: type: string description: Id do gestor dimensionId: type: string description: Id da dimensão amount: type: integer description: Quantidade de pulsos para trazer no histórico target: #/definitions/scoreDetailsTarget responses: 200: description: Ok schema: type: object required: – dimensionName – pulses properties: dimensionName: type: string description: Nome da dimensão pulses: #/definitions/pulseDimension leaderName: type: string description: Nome do líder(quando aplicavel) default: description: Error response schema: #/definitions/genericError /listEducationDegrees: post: description: Serviço que retorna os graus de instrução x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – educationDegrees properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros educationDegrees: #/definitions/educationDegreeDTO default: description: Error response schema: #/definitions/genericError /listCostCenters: post: description: Serviço que retorna os centros de custo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – costCenters properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros costCenters: #/definitions/costCenterDTO default: description: Error response schema: #/definitions/genericError /getCommentsDetail: post: description: Retorna o detalhamento dos comentários. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – role – order properties: id: type: string description: Id da resposta pulseIds: type: array items: type: string description: Lista dos Ids dos pulsos dimensionIds: type: array items: type: string description: Lista dos Ids das dimensões leaderIds: type: array items: type: string description: Lista dos Ids dos gestores role: #/definitions/employeeRoleType order: #/definitions/orderCommentsDetail visible: #/definitions/filterCommentVisibleType searchTerm: type: string description: Busca por palavra page: type: integer description: Termo a ser pesquisado no comentário, pergunta ou dimensão. size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) responses: 200: description: Ok schema: type: object required: – found – commentDetail properties: found: type: integer description: Total de comentários encontrados pela busca. commentDetail: #/definitions/commentDetail default: description: Error response schema: #/definitions/genericError /updateQuestion: post: description: Editar questão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – question properties: question: #/definitions/question responses: 200: description: Ok schema: type: object required: – question properties: question: #/definitions/questionOut default: description: Error response schema: #/definitions/genericError /saveCompany: post: description: Cria/atualiza uma empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – company properties: company: #/definitions/companyDTO responses: 200: description: Ok schema: type: object required: – company properties: company: #/definitions/companyDTO default: description: Error response schema: #/definitions/genericError /deleteAnswerTicket: post: description: Excluir resposta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – answerTicketId properties: answerTicketId: type: string description: Id da resposta que será excluída responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /deleteHierarchyItem: post: description: Excluir item de hierarquia x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do item de hierarquia que será excluído responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /pulseLeadersScore: post: description: Retorna os lideres e sua pontução no pulso atual x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: amount: type: integer description: Quantidade de gestores para retornar, padrão 10. page: type: integer description: Página a ser buscada, padrão 1. q: type: string description: Termo de pesquisa por nome de gestor pulseId: type: string description: Id do pulso responses: 200: description: Ok schema: type: object required: – found – leaders properties: found: type: integer description: Quantidade total de registros leaders: #/definitions/leaderScore default: description: Error response schema: #/definitions/genericError /getMetadata: post: description: Default 'getMetadata' query. Every service must handle this command and return metadata in the format requested. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: default: description: Error response schema: #/definitions/genericError /retrieveTenant: post: description: Retorna tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantId properties: tenantId: type: string description: Id do Tenant a ser retornado responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /currentPulseCommentsCount: post: description: Retorna a quantidade de comentários do pulso atual x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – pulseId – amount properties: pulseId: type: string description: Id do pulso amount: type: integer description: Quantidade de comentários no pulso atual default: description: Error response schema: #/definitions/genericError /deleteTenant: post: description: Excluir tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantId properties: tenantId: type: string description: Id do Tenant que será atualizado responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /shortAnswerTicket: post: description: Obtém um ticket curto e retorna um ticket longo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – shortId properties: shortId: type: string description: Id curto responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id Longo default: description: Error response schema: #/definitions/genericError /createCompanyForImport: post: description: Serviço que cria a estrutura da empresa para importar os colaboradores x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – company properties: company: #/definitions/company responses: 200: description: Ok schema: type: object required: – company properties: company: #/definitions/company default: description: Error response schema: #/definitions/genericError /updatePulseResult: post: description: Atualizar Resultado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseResult properties: pulseResult: #/definitions/pulseResult responses: 200: description: Ok schema: type: object required: – pulseResult properties: pulseResult: #/definitions/pulseResult default: description: Error response schema: #/definitions/genericError /listBranchOffices: post: description: Serviço que retorna as filiais x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da página(Iniciando em 1) size: type: integer description: Tamanho da página searchTerm: type: string description: Termo que será buscado responses: 200: description: Ok schema: type: object required: – pages – total – branchOffices properties: pages: type: integer description: Quantidade de páginas encontradas total: type: integer description: Quantidade total de registros branchOffices: #/definitions/branchOfficeDTO default: description: Error response schema: #/definitions/genericError /survey: post: description: Retorna os dados da pesquisa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseAnswer properties: pulseAnswer: type: string description: Identificador único da resposta do pulso. responses: 200: description: Ok schema: type: object required: – showNpsQuestion properties: startImage: type: string description: Url da imagem que deve ser apresentada no início da pesquisa. startImageLink: type: string description: Link para acessar a imagem que deve ser apresentada no início da pesquisa. startTitle: type: string description: Título da mensagem que deve ser apresentada no início da pesquisa. startMessage: type: string description: Mensagem que deve ser apresentada no início da pesquisa. endImage: type: string description: Url da imagem que deve ser apresentada no fim da pesquisa. endImageLink: type: string description: Link para acessar a imagem que deve ser apresentada no fim da pesquisa. endTitle: type: string description: Título da mensagem que deve ser apresentada no fim da pesquisa. endMessage: type: string description: Mensagem que deve ser apresentada no fim da pesquisa. questions: #/definitions/surveyQuestion showNpsQuestion: type: boolean description: Sinaliza se deve exibir a questão NPS longUrl: type: string description: URL de acesso à pesquisa showComments: type: boolean description: Mostra a opção de escolha da visibilidade de comentários default: description: Error response schema: #/definitions/genericError /deleteEmployee: post: description: Excluir colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do colaborador que será excluído responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /searchCommentsByDimension: post: description: Retorna os comentários por dimensão.
Caso seja informado um termo na pesquisa são retornados os comentários
que tenham esse termo na pergunta em que o comentário foi feito ou no próprio comentário. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: q: type: string description: Termo a ser pesquisado no comentário, pergunta ou dimensão. page: type: integer description: Página que deve ser retornada, começando em 1. (Padrão 1) size: type: integer description: Tamanho da página que deve ser retornado. (Padrão 10) responses: 200: description: Ok schema: type: object required: – commentsByDimension properties: commentsByDimension: #/definitions/commentsByDimension default: description: Error response schema: #/definitions/genericError /contracts: post: description: Retorna todos os ids dos contratos ativos associados ao username informado. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: username: type: string description: Username que deve estar associado aos contratos. responses: 200: description: Ok schema: type: object required: – ids properties: ids: type: string description: Ids dos contratos ativos ordenados por tipo de contrato. default: description: Error response schema: #/definitions/genericError /pulseCommentsDetails: post: description: Retorna as informações de comentários no pulso. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: pulseId: type: string description: Id do pulso que deve ter os detalhes retornados.
– Caso o Id não seja informado serão retornados os dados do último pulso. responses: 200: description: Ok schema: type: object required: – pulseId – startDate – endDate – averageScore – commentsAmount properties: pulseId: type: string description: Id do pulso que teve os dados retornados. startDate: type: string description: Data de inicio do pulso endDate: type: string description: Data final do pulso averageScore: type: number description: Satisfacao do pulso commentsAmount: type: integer description: Quantidade de comentários do pulso. default: description: Error response schema: #/definitions/genericError /anonymous/logFrontendError: post: description: Registra um erro ocorrido no frontend com as informações do cliente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – errorMessage – clientInfo properties: errorMessage: type: string description: Mensagem de erro. Pode conter apenas a mensagem ou o stack trace completo. clientInfo: type: string description: Informações do cliente, como ID da pesquisa, navegador, etc. responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se o erro foi registrado com sucesso. default: description: Error response schema: #/definitions/genericError /hcmAutoSync: post: description: Retorna se deve ou não integrar com o HCM x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object properties: hcmAutoSync: type: boolean description: Flag que indica se deve ou não integrar default: description: Error response schema: #/definitions/genericError /scoreLastPulseByDimension: post: description: Obtém os dados do painel do gestor de ultimos pulsos por dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: leaderId: type: string description: Id do líder que deve ter os dados do dashboard retornado (caso não for informado retorna o do usuário logado). page: type: integer description: Página a ser buscada size: type: integer description: Tamanho da página ticket: type: string description: Ticket do filtro do analytics responses: 200: description: Ok schema: type: object required: – showDepartmentScore – showCommentsQuantity – departmentScoreAverage – companySatisfactionAverage – leaderSatisfactionAverage – commentsQuantityTotal – statusCommentsQuantityTotal – statusLeaderSatisfactionAverage – found properties: leaderAndCompanyGroupByDimension: #/definitions/leaderAverageScoreGroupByDimension showDepartmentScore: type: boolean description: Indica se deve exibir a pontuação da área showCommentsQuantity: type: boolean description: Indica se deve exibir a contagem de comentários por dimnesion departmentScoreAverage: type: number description: Média das notas do departamento companySatisfactionAverage: type: number description: Média das notas da empresa leaderSatisfactionAverage: type: number description: Média da pontuação do líder commentsQuantityTotal: type: integer description: Quantidade total de comentários statusCommentsQuantityTotal: #/definitions/pointTrend statusLeaderSatisfactionAverage: #/definitions/pointTrend found: type: integer description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /retrievePulseResult: post: description: Retorna Resultado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseResultId properties: pulseResultId: type: string description: Id do Resultado a ser buscado responses: 200: description: Ok schema: type: object required: – pulseResult properties: pulseResult: #/definitions/pulseResult default: description: Error response schema: #/definitions/genericError /currentUserInfo: post: description: Retorna dados do employee associado ao usuário logado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – employee properties: employee: #/definitions/employee default: description: Error response schema: #/definitions/genericError /requestUploadFile: post: description: Solicitação para realizar o upload de um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. responses: 200: description: Ok schema: type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. default: description: Error response schema: #/definitions/genericError /averageSatisfactionByDimensionPoint: post: description: Retorna os dados relativos a Média de Satisfação por Dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – target properties: leaderId: type: string description: Identificação única do líder pulseId: type: string description: Identificação única do Pulso target: #/definitions/scoreDetailsTarget responses: 200: description: Ok schema: type: object required: – startDate – endDate – average – engagementPercentage – leaderName – leaderJobPosition – dimensionsAverage properties: startDate: type: string description: Data Inicial da Faixa pesquisada endDate: type: string description: Data final da Faixa pesquisada average: type: number description: Média do líder engagementPercentage: type: number description: Porcentagem de engajamento leaderName: type: string description: Nome do colaborador leaderJobPosition: type: string description: Cargo do líder dimensionsAverage: #/definitions/dimensionPoint default: description: Error response schema: #/definitions/genericError /surveyConfig: post: description: Retorna os dados da pesquisa de clima x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – survey properties: survey: #/definitions/climateSurvey smsMessageSize: type: integer description: Tamanho permitido para a mensagem de texto a ser enviada por SMS default: description: Error response schema: #/definitions/genericError /autocomplete: post: description: Autocomplete genérico. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – table – fields properties: table: #/definitions/autocompleteTables fields: type: array items: #/definitions/autocompleteFields description: Campos para retorno da consulta no out description. order: type: array items: #/definitions/autocompleteFields description: Campos para ordenação. conditions: type: array items: #/definitions/autocompleteConditions description: Condições para a consulta. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/autocompleteResult default: description: Error response schema: #/definitions/genericError /averageDimensionPoint: post: description: Retorna os dados relativos a Média Pontuação por Dimensão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – average properties: average: #/definitions/dimensionPoint default: description: Error response schema: #/definitions/genericError /updateCompanyHierarchy: post: description: Atualizar Hierarquia de empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyHierarchy properties: companyHierarchy: #/definitions/companyHierarchy responses: 200: description: Ok schema: type: object required: – companyHierarchy properties: companyHierarchy: #/definitions/companyHierarchy default: description: Error response schema: #/definitions/genericError /allPulseCommentsCount: post: description: Retorna a quantidade de comentários de todos os pulsos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – amount properties: amount: type: integer description: Quantidade de comentários default: description: Error response schema: #/definitions/genericError /sendMailToNewUser: post: description: Envia um email para o usuário associado ao colaborador informado, indicando qual seu papél, usuário e senha de acesso a plataforma x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employee – userName – roleName – password properties: employee: #/definitions/employeeDTO userName: type: string description: Username do usuário roleName: type: string description: Papél do usuario password: type: string description: Senha do usuário responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retrySMSRespondentsFailures: post: description: Reenvia os sms do último pulso, caso necessário. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /sendSMSToRespondents: post: description: Envia um SMS para todos os respondentes de um pulso. O SMS contém o link para o colaborador responder ao pulso da pesquisa x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pulseId – pulseAnswerRespondents properties: pulseId: type: string description: Id do pulso pulseAnswerRespondents: type: array items: #/definitions/pulseAnswerRespondent description: Lista com associação entre cada PulseAnswer e PulseRespondent responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retryRespondentsFailures: post: description: Reenvia os e-mail do último pulso, caso necessário. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /generatePulse: post: description: Gera um pulso da pesquisa de clima, caso necessesário.
Para gerar um pulso é necessário que:
– A pesquisa de clima esteja habilitada;
– A data do último pulso + 7 ou 14 dias(dependendo da periodicidade) seja menor ou igual à data atual;
– O dia de semana da data atual seja igual ao dia de semana configurado na pesquisa.
O público alvo são os liderados diretos dos gestores que estiverem configurados na pesquisa.
Todos os liderados receberão um e-mail com link para responder o pulso da pesquisa. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /processPulse: post: description: Processa os pulsos passados que ainda não foram processados x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: pulses: type: array items: type: string description: Pulsos que devem ser processados, caso não seja informado, serão processados todos os pulsos pendentes responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /setupPulse: post: description: Serviço para criar dados fictícios – setup. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /importEmployeesAsync: post: description: Importe do colaboradores asyncrona x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employees properties: employees: type: array items: #/definitions/importEmployeeDTO description: Colaborador que será importados overwriteExistingData: type: boolean description: Sobrescrever registros existentes responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /retryRespondentsReminder: post: description: Reenvia os e-mail/sms do último pulso, lembrando o respondente. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /verifyDismissalEmployees: post: description: Verifica os colaboradores que foram demitidos x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceStarted: post: description: Default 'serviceStarted' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /notifyUserEvent: post: description: Default 'notifyUser' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/notifyUserEventPayload responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/questionBalance: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/questionBalance responses: 200: description: The created resource schema: #/definitions/questionBalance default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/questionBalance responses: 200: description: The created resource schema: #/definitions/questionBalance default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/questionBalance default: description: Error response schema: #/definitions/genericError /entities/questionBalance/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionBalance responses: 200: description: Ok schema: #/definitions/questionBalance default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionBalance responses: 200: description: Ok schema: #/definitions/questionBalance default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/questionBalance default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/questionBalance/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/questionBalance responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/company: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/company default: description: Error response schema: #/definitions/genericError /entities/pulseRespondent: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pulseRespondent responses: 200: description: The created resource schema: #/definitions/pulseRespondent default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pulseRespondent responses: 200: description: The created resource schema: #/definitions/pulseRespondent default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/pulseRespondent default: description: Error response schema: #/definitions/genericError /entities/pulseRespondent/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondent responses: 200: description: Ok schema: #/definitions/pulseRespondent default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseRespondent responses: 200: description: Ok schema: #/definitions/pulseRespondent default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pulseRespondent default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/pulseRespondent/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/pulseRespondent responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/questionChoice: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/questionChoice responses: 200: description: The created resource schema: #/definitions/questionChoice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/questionChoice responses: 200: description: The created resource schema: #/definitions/questionChoice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/questionChoice default: description: Error response schema: #/definitions/genericError /entities/questionChoice/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionChoice responses: 200: description: Ok schema: #/definitions/questionChoice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionChoice responses: 200: description: Ok schema: #/definitions/questionChoice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/questionChoice default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/questionChoice/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/questionChoice responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dimensionBalance: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dimensionBalance responses: 200: description: The created resource schema: #/definitions/dimensionBalance default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dimensionBalance responses: 200: description: The created resource schema: #/definitions/dimensionBalance default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dimensionBalance default: description: Error response schema: #/definitions/genericError /entities/dimensionBalance/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dimensionBalance responses: 200: description: Ok schema: #/definitions/dimensionBalance default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dimensionBalance responses: 200: description: Ok schema: #/definitions/dimensionBalance default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dimensionBalance default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dimensionBalance/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/dimensionBalance responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/pulseResultLeaderDimension: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pulseResultLeaderDimension responses: 200: description: The created resource schema: #/definitions/pulseResultLeaderDimension default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pulseResultLeaderDimension responses: 200: description: The created resource schema: #/definitions/pulseResultLeaderDimension default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/pulseResultLeaderDimension default: description: Error response schema: #/definitions/genericError /entities/pulseResultLeaderDimension/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseResultLeaderDimension responses: 200: description: Ok schema: #/definitions/pulseResultLeaderDimension default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseResultLeaderDimension responses: 200: description: Ok schema: #/definitions/pulseResultLeaderDimension default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pulseResultLeaderDimension default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/pulseResultLeaderDimension/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/pulseResultLeaderDimension responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/pulseResultDimension: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pulseResultDimension responses: 200: description: The created resource schema: #/definitions/pulseResultDimension default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pulseResultDimension responses: 200: description: The created resource schema: #/definitions/pulseResultDimension default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/pulseResultDimension default: description: Error response schema: #/definitions/genericError /entities/pulseResultDimension/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseResultDimension responses: 200: description: Ok schema: #/definitions/pulseResultDimension default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pulseResultDimension responses: 200: description: Ok schema: #/definitions/pulseResultDimension default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pulseResultDimension default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/pulseResultDimension/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/pulseResultDimension responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/emailLoggerErrorSend: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/emailLoggerErrorSend responses: 200: description: The created resource schema: #/definitions/emailLoggerErrorSend default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/emailLoggerErrorSend responses: 200: description: The created resource schema: #/definitions/emailLoggerErrorSend default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/emailLoggerErrorSend default: description: Error response schema: #/definitions/genericError /entities/emailLoggerErrorSend/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailLoggerErrorSend responses: 200: description: Ok schema: #/definitions/emailLoggerErrorSend default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailLoggerErrorSend responses: 200: description: Ok schema: #/definitions/emailLoggerErrorSend default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/emailLoggerErrorSend default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/emailLoggerErrorSend/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/emailLoggerErrorSend responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/hierarchyRevision: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/hierarchyRevision responses: 200: description: The created resource schema: #/definitions/hierarchyRevision default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/hierarchyRevision responses: 200: description: The created resource schema: #/definitions/hierarchyRevision default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/hierarchyRevision default: description: Error response schema: #/definitions/genericError /entities/hierarchyRevision/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hierarchyRevision responses: 200: description: Ok schema: #/definitions/hierarchyRevision default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hierarchyRevision responses: 200: description: Ok schema: #/definitions/hierarchyRevision default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hierarchyRevision default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/hierarchyRevision/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/hierarchyRevision responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/hierarchy: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/hierarchy default: description: Error response schema: #/definitions/genericError /entities/branchOfficeHistorical: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/branchOfficeHistorical default: description: Error response schema: #/definitions/genericError /entities/dimension_Questions: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dimension_Questions responses: 200: description: The created resource schema: #/definitions/dimension_Questions default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dimension_Questions responses: 200: description: The created resource schema: #/definitions/dimension_Questions default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dimension_Questions default: description: Error response schema: #/definitions/genericError /entities/dimension_Questions/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dimension_Questions responses: 200: description: Ok schema: #/definitions/dimension_Questions default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dimension_Questions responses: 200: description: Ok schema: #/definitions/dimension_Questions default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dimension_Questions default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/npsAnswer: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/npsAnswer responses: 200: description: The created resource schema: #/definitions/npsAnswer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/npsAnswer responses: 200: description: The created resource schema: #/definitions/npsAnswer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/npsAnswer default: description: Error response schema: #/definitions/genericError /entities/npsAnswer/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/npsAnswer responses: 200: description: Ok schema: #/definitions/npsAnswer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/npsAnswer responses: 200: description: Ok schema: #/definitions/npsAnswer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/npsAnswer default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/npsAnswer/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/npsAnswer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/question: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/question default: description: Error response schema: #/definitions/genericError /entities/climateSurvey: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/climateSurvey responses: 200: description: The created resource schema: #/definitions/climateSurvey default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/climateSurvey responses: 200: description: The created resource schema: #/definitions/climateSurvey default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/climateSurvey default: description: Error response schema: #/definitions/genericError /entities/climateSurvey/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/climateSurvey responses: 200: description: Ok schema: #/definitions/climateSurvey default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/climateSurvey responses: 200: description: Ok schema: #/definitions/climateSurvey default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/climateSurvey default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/climateSurvey/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/climateSurvey responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/questionAnswer: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/questionAnswer responses: 200: description: The created resource schema: #/definitions/questionAnswer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/questionAnswer responses: 200: description: The created resource schema: #/definitions/questionAnswer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/questionAnswer default: description: Error response schema: #/definitions/genericError /entities/questionAnswer/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionAnswer responses: 200: description: Ok schema: #/definitions/questionAnswer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/questionAnswer responses: 200: description: Ok schema: #/definitions/questionAnswer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/questionAnswer default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/questionAnswer/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/questionAnswer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/answerTicket: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/answerTicket default: description: Error response schema: #/definitions/genericError /entities/pulseResult: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/pulseResult default: description: Error response schema: #/definitions/genericError /entities/evaluatedLeaderHistoric: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/evaluatedLeaderHistoric responses: 200: description: The created resource schema: #/definitions/evaluatedLeaderHistoric default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/evaluatedLeaderHistoric responses: 200: description: The created resource schema: #/definitions/evaluatedLeaderHistoric default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/evaluatedLeaderHistoric default: description: Error response schema: #/definitions/genericError /entities/evaluatedLeaderHistoric/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/evaluatedLeaderHistoric responses: 200: description: Ok schema: #/definitions/evaluatedLeaderHistoric default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/evaluatedLeaderHistoric responses: 200: description: Ok schema: #/definitions/evaluatedLeaderHistoric default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/evaluatedLeaderHistoric default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/evaluatedLeaderHistoric/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/evaluatedLeaderHistoric responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/employee_Usernames: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employee_Usernames responses: 200: description: The created resource schema: #/definitions/employee_Usernames default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employee_Usernames responses: 200: description: The created resource schema: #/definitions/employee_Usernames default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/employee_Usernames default: description: Error response schema: #/definitions/genericError /entities/employee_Usernames/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee_Usernames responses: 200: description: Ok schema: #/definitions/employee_Usernames default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee_Usernames responses: 200: description: Ok schema: #/definitions/employee_Usernames default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee_Usernames default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/pulse: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/pulse default: description: Error response schema: #/definitions/genericError /entities/dimension: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dimension default: description: Error response schema: #/definitions/genericError /entities/employeeUsername: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: The created resource schema: #/definitions/employeeUsername default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: The created resource schema: #/definitions/employeeUsername default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/employeeUsername default: description: Error response schema: #/definitions/genericError /entities/employeeUsername/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: Ok schema: #/definitions/employeeUsername default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeUsername responses: 200: description: Ok schema: #/definitions/employeeUsername default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeUsername default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/employeeUsername/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/employeeUsername responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/hierarchyItem: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/hierarchyItem default: description: Error response schema: #/definitions/genericError /entities/importEmployeeResult: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/importEmployeeResult responses: 200: description: The created resource schema: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/importEmployeeResult responses: 200: description: The created resource schema: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError /entities/importEmployeeResult/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/importEmployeeResult responses: 200: description: Ok schema: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/importEmployeeResult responses: 200: description: Ok schema: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/importEmployeeResult default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/importEmployeeResult/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/importEmployeeResult responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/employee: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/employee default: description: Error response schema: #/definitions/genericError /entities/question_Choices: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/question_Choices responses: 200: description: The created resource schema: #/definitions/question_Choices default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/question_Choices responses: 200: description: The created resource schema: #/definitions/question_Choices default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/question_Choices default: description: Error response schema: #/definitions/genericError /entities/question_Choices/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/question_Choices responses: 200: description: Ok schema: #/definitions/question_Choices default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/question_Choices responses: 200: description: Ok schema: #/definitions/question_Choices default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/question_Choices default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/companyHierarchy: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/companyHierarchy default: description: Error response schema: #/definitions/genericError /entities/hierarchyItemRevision: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/hierarchyItemRevision responses: 200: description: The created resource schema: #/definitions/hierarchyItemRevision default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/hierarchyItemRevision responses: 200: description: The created resource schema: #/definitions/hierarchyItemRevision default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/hierarchyItemRevision default: description: Error response schema: #/definitions/genericError /entities/hierarchyItemRevision/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hierarchyItemRevision responses: 200: description: Ok schema: #/definitions/hierarchyItemRevision default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hierarchyItemRevision responses: 200: description: Ok schema: #/definitions/hierarchyItemRevision default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hierarchyItemRevision default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/hierarchyItemRevision/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/hierarchyItemRevision responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: type: string enum: – UP – DOWN periodicity: type: string enum: – FORTNIGHTLY – WEEKLY – DAILY – MONTHLY – QUARTERLY pointTrend: type: string enum: – UP – DOWN – STABLE – EMPTY pulseSendType: type: string enum: – EMAIL – SMS – BOTH autocompleteFields: type: string enum: – CompanyCompanyId – CompanyCompanyName – CompanyHeadQuarterId – DepartmentName – DepartmentCompanyId – DepartmentCompany – JobPositionName – JobPositionCompanyId – JobPositionCompany – CostCenterName – CostCenterCompanyId – CostCenterCompany – WorkstationGroupName – WorkstationGroupCompanyId – WorkstationGroupCompany – EducationDegreeName – EmployeeName – EmployeeExcluded – EmployeeDismissalDate – EmployeeId – CompanyExcluded – CostCenterExcluded – JobPositionExcluded – DepartmentExcluded – WorkstationGroupExcluded – EducationDegreeExcluded – CompanyCompanyCode autocompleteTables: type: string enum: – Company – Department – JobPosition – CostCenter – WorkstationGroup – EducationDegree – Employee orderCommentsDetail: type: string enum: – AFFIRMATIVE_ASC – AFFIRMATIVE_DESC – DIMENSION_ASC – DIMENSION_DESC – LEADER_ASC – LEADER_DESC – SCORE_ASC – SCORE_DESC employeeRoleType: type: string enum: – HR – LEADER filterCommentVisibleType: type: string enum: – ALL – HR – LEADER scoreDetailsTarget: type: string enum: – COMPANY – MY_DEPARTMENT – MY_SCORE – LEADER – ALL npsChartState: type: string enum: – PULSE_HAS_NO_NPS_QUESTION – PULSE_HAS_NO_MINIMUM_ANSWERS – THERE_IS_NO_PULSE_YET – THERE_IS_NO_NPS_PULSE_YET questionType: type: string enum: – MULTIPLE_CHOICE – PARAGRAPH – LINEAR_SCALE monthOfYear: type: string enum: – JANUARY – FEBRUARY – MARCH – APRIL – MAY – JUNE – JULY – AUGUST – SEPTEMBER – OCTOBER – NOVEMBER – DECEMBER dayOfWeek: type: string enum: – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY – SUNDAY weekOfMonth: type: string enum: – FIRST – SECOND – THIRD – FOURTH – LAST monthlyPeriodicity: type: string enum: – DAILY – WEEKLY genderType: type: string enum: – MALE – FEMALE employeeType: type: string enum: – EMPLOYEE – THIRDPARTY reminderType: type: string enum: – NEVER – RESEARCH_PERIOD – RESEARCH_PERIOD_TO_END reminderResearchPeriodToEndType: type: string enum: – DAY – WEEK reminderResearchPeriod: type: string enum: – ONE_QUARTER – TWO_QUARTERS – THREE_QUARTERS pulseRespondentStatusType: type: string enum: – INVALID_MAIL – MAIL_EMPLOYEE_NOT_SAVE – PHONE_EMPLOYEE_NOT_SAVE – EMPLOYEE_NOT_IN_HIERARCHY – LEADER_NOT_EVALUATED – THIRDPARTIES_NOT_ALLOWED sentStatus: type: string enum: – SENT – INVALID_MAIL – MAIL_EMPLOYEE_NOT_SAVE – EMPLOYEE_NOT_IN_HIERARCHY – LEADER_NOT_EVALUATED – FAIL – THIRDPARTIES_NOT_ALLOWED – PHONE_EMPLOYEE_NOT_SAVE companyType: type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVELY – DOMESTIC_WORKER – EMPLOYER_ESOCIAL autocompleteFieldType: type: string enum: – NUMERIC – STRING – DATE – ENUM autocompleteExpressionType: type: string enum: – GREATER_THAN – GREATER_THAN_OR_NULL – GREATER_THAN_EQUAL – GREATER_THAN_EQUAL_OR_NULL – LESS_THAN – LESS_THAN_OR_NULL – LESS_THAN_EQUAL – LESS_THAN_EQUAL_OR_NULL – EQUAL – NOT_EQUAL – LIKE – IS_NULL – IS_NOT_NULL – IS_TRUE – IN_VALUE – IS_FALSE – IS_FALSE_OR_NULL userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None answerTicketRepondentDTO: type: object required: – pulseAnswer properties: pulseAnswer: type: string description: Identificador único da resposta do pulso. cpf: type: string description: CPF registerNumber: type: string description: Número do registro answers: type: array items: #/definitions/questionAnswer description: Respostas das perguntas do pulso. questionAnswer: type: object properties: id: type: string description: Identificador único da entidade. paragraph: type: string description: Resposta descritiva. scale: type: integer description: Resposta de escala. choice: #/definitions/questionChoice comment: type: string description: Comentário sobre a resposta. question: #/definitions/question createdAt: type: string description: Instante em que a resposta foi criada format: date-time answerTicket: #/definitions/answerTicket isCommentVisible: type: boolean description: Flag identificadndo se o comentário é visível para o gestor questionChoice: type: object properties: id: type: string description: Identificador único da entidade. text: type: string description: Texto da opção. sequence: type: integer description: Sequencia em que a opção deve ser apresentada. question: #/definitions/question question: type: object required: – type – enabled properties: id: type: string description: Identificador único da entidade. imageId: type: string description: Identificador único da imagem da questão. text: type: string description: Texto da questão. type: #/definitions/questionType enabled: type: boolean description: Indica se a questão está avida. createdAt: type: string description: Instante em que a questão foi criada format: date-time dimension: #/definitions/dimension lowScaleText: type: string description: Texto do menor valor da questão de escala. lowScaleImageId: type: string description: Identificador único da imagem do menor valor da questão de escala. highScaleText: type: string description: Texto do maior valor da questão de escala. highScaleImageId: type: string description: Identificador único da imagem do maior valor da questão de escala. choices: type: array items: #/definitions/questionChoice description: Opções da questão, caso ela seja do tipo de múltipla escolha. pulses: type: array items: #/definitions/pulse description: Pulsos relacionados dimension: type: object required: – description – enabled properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da dimensão. enabled: type: boolean description: Indica se a dimensão está ativa. createdAt: type: string description: Instante em que a dimensão foi criada format: date-time updatedAt: type: string description: Instante em que a dimensão foi atualizada format: date-time pulses: type: array items: #/definitions/pulse description: Pulsos relacionados questions: type: array items: #/definitions/question description: Questões que possuem essa dimensão pulse: type: object properties: id: type: string description: Identificador único do pulso. createdAt: type: string description: Momento em que o pulso foi criado format: date-time endAt: type: string description: Momento em que o pulso será finalizado format: date-time survey: #/definitions/climateSurvey npsQuestion: type: boolean description: Informa se o pulso tem a questão NPS pulseSequence: type: integer description: Número sequencial de identificação do pulso processed: type: boolean description: Indica se o pulso ja foi processado leaders: type: array items: #/definitions/employee description: Líderes que serão avaliados no pulso. questions: type: array items: #/definitions/question description: Questões que serão utilizadas no pulso. dimensions: type: array items: #/definitions/dimension description: Questões que serão avaliadas no pulso. answers: type: array items: #/definitions/answerTicket description: Respostas dos respondentes do pulso. respondents: type: array items: #/definitions/pulseRespondent description: Respondentes deste pulso climateSurvey: type: object properties: id: type: string description: Identificador único da entidade. enabled: type: boolean description: Indica se a pesquisa está ativa. periodicity: #/definitions/periodicity monthOfYear: #/definitions/monthOfYear dayOfWeek: #/definitions/dayOfWeek emailMessage: type: string description: Mensagem em texto padrão referente a configuração do email da pesquisa. emailMessageHtml: type: string description: Mensagem em HTML que deve ser enviada no email da pesquisa. emailMessageHtmlCustom: type: string description: Mensagem em HTML personalizada que deve ser enviada no email da pesquisa. startImageId: type: string description: Identificador único da imagem que deve ser apresentada no início da pesquisa. startTitle: type: string description: Título da mensagem que deve ser apresentada no início da pesquisa. startMessage: type: string description: Mensagem que deve ser apresentada no início da pesquisa. endImageId: type: string description: Identificador único da imagem que deve ser apresentada no fim da pesquisa. endTitle: type: string description: Link para acessar a imagem que deve ser apresentada no fim da pesquisa. endMessage: type: string description: Mensagem que deve ser apresentada no fim da pesquisa. questionsCount: type: integer description: Quantidade máxima de perguntas que o pulso deve ter. showEngagement: type: boolean description: Indica se deve apresentar o engajamento aos gestores showComments: type: boolean description: Indica se deve apresentar os comentários dos pulsos aos gestores hcmAutoSync: type: boolean description: Indica se será feito a sincronização automática coupledHcm: type: boolean description: Indica se o Moods está acoplado com o HCM dayOfMonth: type: integer description: Dia do mês que a pesquisa deve ser realizada (apenas periodicity MONTHLY) weekOfMonth: #/definitions/weekOfMonth monthlyPeriodicity: #/definitions/monthlyPeriodicity smsMessage: type: string description: Mensagem de texto padrão referente a configuração do SMS da pesquisa leaders: type: array items: #/definitions/employee description: Líderes allowThirdParties: type: boolean description: Indica se o pulso deve ser enviado para colaboradores terceiros defaultPulseSendType: #/definitions/pulseSendType disableNPSQuestion: type: boolean description: Indica se a pesquisa pode considerar o a aplicação da questão do NPS reminderType: #/definitions/reminderType numberReminderCalculation: type: integer description: Numero para cálculo do envio do lembrete reminderPeriodToEndType: #/definitions/reminderResearchPeriodToEndType reminderPeriod: #/definitions/reminderResearchPeriod employee: type: object properties: id: type: string description: Identificador único da entidade registernumber: type: integer description: Código do colaborador cpf: type: string description: CPF do Colaborador name: type: string description: Nome do colaborador email: type: string description: Email do colaborador countryCodePhone: type: integer description: Código do país do celular do colaborador localCodePhone: type: integer description: Código de área do celular do colaborador numberPhone: type: integer description: Numero do celular do colaborador photoId: type: string description: Identificador único da foto do colaborador photoVersion: type: string description: Versão da foto do colaborador birthday: type: string description: Data de nascimento do colaborador format: date admissionDate: type: string description: Data de admissão do colaborador format: date gender: #/definitions/genderType dismissalDate: type: string description: Data de demissão do colaborador format: date pulseSendType: #/definitions/pulseSendType surveyAnalyst: type: boolean description: Indicação de que o colaborador é analista da pesquisa idg5: type: string description: Código do colaborador na G5 – NumEmp;TipCol;NumCad blocked: type: boolean description: Indica se o colaborador está bloqueado excluded: type: boolean description: Indica se o colaborador está excluído usernames: type: array items: #/definitions/employeeUsername description: Nome dos usuários. (Login G7) pulses: type: array items: #/definitions/pulse description: Pulsos relacionados ao líder surveys: type: array items: #/definitions/climateSurvey description: Pesquisas relacionados ao líder employeeType: #/definitions/employeeType employeeUsername: type: object required: – username properties: id: type: string description: Identificador Único employee: #/definitions/employee username: type: string description: Usuário answerTicket: type: object properties: id: type: string description: Identificador único da entidade. pulse: #/definitions/pulse leader: #/definitions/employee employee: #/definitions/employee longUrl: type: string description: URL de acesso ao questionário shortUrl: type: string description: URL de acesso ao questionário encurtada isEmailSent: type: boolean description: Flag identificando se houve erro ao enviar email isSmsSent: type: boolean description: Flag identificando se houve erro ao enviar SMS answered: type: boolean description: Indica se a resposta foi respondida answers: type: array items: #/definitions/questionAnswer description: Respostas das perguntas do pulso pulseRespondent: type: object properties: id: type: string description: Identificador do respondente pulse: #/definitions/pulse respondent: #/definitions/employee email: type: string description: Email do respondente leader: #/definitions/employee sent: type: boolean description: Flag identificando se o pulso será/foi enviado para o respondente statusErrorSent: #/definitions/pulseRespondentStatusType errorDescription: type: string description: Descrição do erro isEmailSent: type: boolean description: Flag identificando problema no envio de email isSmsSent: type: boolean description: Flag identificando problema no envio de SMS checkDTO: type: object required: – name – status properties: name: type: string description: Nome do status status: #/definitions/heathcheckDTO commonToComponent: type: object required: – id – displayName properties: id: type: string description: Identificador único da opção displayName: type: string description: Nome da opção a ser mostrado tenant: type: object required: – id – domain properties: id: type: string description: Identificador único da entidade. server: type: string description: Nome do servidor de e-mail. serverPort: type: string description: Porta do servidor de e-mail. senderEmailDefault: type: string description: Emissário padrão dos e-mails do Pulse. senderUserDefault: type: string description: Usuário do emissário padrão dos e-mails do Pulse. senderPasswordDefault: type: string description: Senha do emissário padrão dos e-mails do Pulse. authenticationEnabled: type: boolean description: Representa se a autenticação está ativa no servidor de configuração do emissário padrão dos e-mails. sslTrust: type: boolean description: Representa se o 'SSL trust' está ativo no servidor de e-mail. tlsEnabled: type: boolean description: Representa se as configurações 'TLS' estão ativas no servidor de e-mail. domain: type: string description: Domínio deste tenant. Usado para descobrir o tenant na autenticação dos usuários.
Exemplo:
Domínio: senior.com.br
Usuário: joao.silva
Login: joao.silva@senior.com.br shortHash: type: string description: Código randômico para identificar o tenant em URLs surveyQuestion: type: object required: – type – enabled properties: id: type: string description: Identificador único da entidade. imageId: type: string description: Identificador único da imagem da questão. imageLink: type: string description: URL da imagem da questão. text: type: string description: Texto da questão. type: #/definitions/questionType enabled: type: boolean description: Indica se a questão está avida. dimension: #/definitions/dimension lowScaleText: type: string description: Texto do menor valor da questão de escala. lowScaleImageId: type: string description: Identificador único da imagem do menor valor da questão de escala. highScaleText: type: string description: Texto do maior valor da questão de escala. highScaleImageId: type: string description: Identificador único da imagem do maior valor da questão de escala. choices: type: array items: #/definitions/questionChoice description: Opções da questão, caso ela seja do tipo de múltipla escolha. pulses: type: array items: #/definitions/pulse description: Pulsos relacionados questionSummary: type: object required: – text – type – enabled – canChange properties: id: type: string description: Identificador único da entidade. text: type: string description: Texto da questão. type: #/definitions/questionType enabled: type: boolean description: Indica se a questão está avida. canChange: type: boolean description: Indica se a questão pode ser alterada/excluída. hierarchyItemInput: type: object properties: id: type: string description: Identificador único da entidade. hierarchyId: type: string description: Identificador único da hierarquia a qual este item pertence. position: type: string description: Posição deste item na hierarquia. parentId: type: string description: Identificador único do pai deste item na hierarquia. branchOfficeId: type: string description: Identificador da filial workstationId: type: string description: Identificador da estação de trabalho workstationName: type: string description: Nome da estação de trabalho employeeId: type: string description: Identificador único do colaborador que ocupa este item da hierarquia. children: type: array items: #/definitions/hierarchyItemInput description: Filhos desse item na hierarquia. personId: type: string description: Id da person companyHierarchyInput: type: object required: – startDate properties: id: type: string description: Identificador da empresa startDate: type: string description: Data de início format: date dimensionOut: type: object required: – id – description – enabled properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da dimensão. enabled: type: boolean description: Indica se a dimensão está ativa. createdAt: type: string description: Instante em que a dimensão foi criada format: date-time updatedAt: type: string description: Instante em que a dimensão foi atualizada format: date-time canChange: type: boolean description: Flag identificando possibilidade de altreração questionOut: type: object required: – id – type – enabled properties: id: type: string description: Identificador único da entidade. imageId: type: string description: Identificador único da imagem da questão. imageLink: type: string description: Link para acessar a imagem da questão. text: type: string description: Texto da questão. type: #/definitions/questionType enabled: type: boolean description: Indica se a questão está avida. createdAt: type: string description: Instante em que a questão foi criada format: date-time dimensionId: type: string description: Identificador único da dimensão a qual a questão está associada. dimension: #/definitions/dimension highScaleImageLink: type: string description: Link da imagem HQ lowScaleImageLink: type: string description: Link para imagem LQ canChange: type: boolean description: Flag assinalado possiblidade de alteração lowScaleText: type: string description: Texto do menor valor da questão de escala. lowScaleImageId: type: string description: Identificador único da imagem do menor valor da questão de escala. highScaleText: type: string description: Texto do maior valor da questão de escala. highScaleImageId: type: string description: Identificador único da imagem do maior valor da questão de escala. choices: type: array items: #/definitions/questionChoice description: Opções da questão, caso ela seja do tipo de múltipla escolha. pulses: type: array items: #/definitions/pulse description: Pulsos relacionados dimensionSearch: type: object required: – description – enabled – canChange properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da dimensão. enabled: type: boolean description: Indica se a dimensão está ativa. canChange: type: boolean description: Indica se a dimensão pode ser alterada/excluída. questions: type: array items: #/definitions/questionSummary description: Resumo das questões que possuem essa dimensão e possuem algum termo da pesquisa. dimensionInfo: type: object required: – name properties: id: type: string description: Identificador único da dimensão. name: type: string description: Descrição da dimensão. commentsByDimension: type: object required: – dimensionId – description – found – comments properties: dimensionId: type: string description: Identificador único da dimensão. description: type: string description: Descrição da dimensão. found: type: integer description: Total de comentários encontrados para a dimensão. comments: type: array items: #/definitions/commentSearch description: Comentários da dimensão. commentSearch: type: object required: – comment – question – when properties: comment: type: string description: Comentário. question: type: string description: Pergunta em que o comentário foi feito. when: type: string description: Data que o comentário foi feito. format: date pulseInfo: type: object required: – pulseId – description properties: pulseId: type: string description: Identificador único do pulso. description: type: string description: Descrição. commentDetail: type: object required: – dimensionId – dimension – pulsePeriod – affirmative – scoreColor – comment properties: id: type: string description: Id da resposta dimensionId: type: string description: Identificador único da dimensão. dimension: type: string description: Descrição da dimensão. pulsePeriod: type: string description: Descrição da pulso. affirmative: type: string description: Afirmativa score: type: string description: Nota numerica scoreText: type: string description: Nota texto scoreColor: type: string description: Cor da nota comment: type: string description: Comentário readMoreAffirmative: type: boolean description: Ler mais para a afirmativa readMoreComment: type: boolean description: Ler mais para o comentário leaderName: type: string description: Nome do Lider visibleManager: type: boolean description: Visivel para o gestor? employeeInfo: type: object required: – id – name properties: id: type: string description: Identificador único do colaborador name: type: string description: Nome do colaborador commentWithDimensionSearch: type: object required: – comment – question – when – dimensionId – dimension properties: comment: type: string description: Comentário. question: type: string description: Pergunta em que o comentário foi feito. when: type: string description: Data que o comentário foi feito. format: date dimensionId: type: string description: Id da dimensão dimension: type: string description: Dimensão pulseAnswerRespondent: type: object required: – pulseAnwserId – pulseRespondentId properties: pulseAnwserId: type: string description: Id da resposta do pulso (PulseAnswer) pulseRespondentId: type: string description: Id do respondente do pulso (PulseRespondent) longUrl: type: string description: URL de acesso à pesquisa utilizando o ticket shortUrl: type: string description: URL encurtada de acesso à pesquisa utilizando o ticket leaderSituation: type: object required: – id – name – evaluated – subordinates – subordinatesCount properties: id: type: string description: Identificador único da entidade. name: type: string description: Nome do colaborador. email: type: string description: Email do colaborador. photoLink: type: string description: Foto do colaborador evaluated: type: boolean description: Indica se ele está sendo avaliado na pesquisa de clima. subordinates: type: array items: #/definitions/subordinate description: Lista de subordinados subordinatesCount: type: integer description: Quantidade de subordinados encontrados subordinate: type: object required: – id – name – sentStatus properties: id: type: string description: Identificador único da entidade. name: type: string description: Nome do colaborador. email: type: string description: Email do colaborador. photoLink: type: string description: Foto do colaborador sentStatus: #/definitions/sentStatus pulseRespondentStatusType: type: string description: Status erro de envio do pulso leaderScore: type: object required: – id – name – leaderScore – leaderStatus – departmentScore – departmentStatus properties: id: type: string description: Identificador único da entidade. name: type: string description: Nome do colaborador. email: type: string description: Email do colaborador. photoLink: type: string description: Foto do colaborador leaderScore: type: number description: Pontuação. format: double leaderStatus: #/definitions/pointTrend departmentScore: type: number description: Pontuação da área do líder format: double departmentStatus: #/definitions/pointTrend commentsCountGroupByDimension: type: object required: – dimensionId – dimensionName – comments – lastPulseComments properties: dimensionId: type: string description: Id da dimensão dimensionName: type: string description: Nome da dimensão comments: type: integer description: Quantidade de comentários na dimensão lastPulseComments: type: integer description: Comentários do último pulso leaderAverageScoreGroupByDimension: type: object required: – dimensionName – leaderSatisfaction – statusLeaderSatisfaction – companySatisfaction – departmentScore – statusLeaderComments – commentsQuantity properties: dimensionName: type: string description: Nome da dimensão leaderSatisfaction: type: number description: Satisfação da dimensão para o leader format: double statusLeaderSatisfaction: #/definitions/pointTrend companySatisfaction: type: number description: Satisfação da dimensão para a empresa format: double departmentScore: type: number description: Satisfação da área format: double statusLeaderComments: #/definitions/pointTrend commentsQuantity: type: integer description: Quantidade de comentários da área pulseAverage: type: object required: – pulseId – startDate – endDate – attendance – averageScore properties: pulseId: type: string description: Id do pulso startDate: type: string description: Data de inicio do pulso format: date endDate: type: string description: Data final do pulso format: date attendance: type: number description: Assiduidade do pulso format: double averageScore: type: number description: Satisfacao do pulso format: double dimensionPoint: type: object required: – dimensionId – dimensionName – score – status properties: dimensionId: type: string description: Id da dimensão dimensionName: type: string description: Dimensão que vamos efetuar a média score: type: number description: Média atual da dimensão format: double status: #/definitions/pointTrend pulseScoreCommon: type: object required: – pulseId – startDate – endDate – score – engageStatus properties: pulseId: type: string description: Id do pulso startDate: type: string description: Data de inicio do pulso format: date endDate: type: string description: Data final do pulso format: date score: type: number description: Pontuação no pulso format: double engage: type: number description: Engajamento format: double engageStatus: #/definitions/pointTrend npsScoreCommon: type: object required: – pulseId – startDate – endDate – npsScore properties: pulseId: type: string description: Id do pulso startDate: type: string description: Data de inicio do pulso format: date endDate: type: string description: Data final do pulso format: date npsScore: type: number description: NPS no pulso format: double engage: type: boolean description: Atingiu engajamento promotersPercentage: type: number description: Percentual de promotores format: double passivesPercentage: type: number description: Percentual de neutros format: double detractorsPercentage: type: number description: Percentual de detratores format: double managerPulseScores: type: object properties: id: type: string description: Id do gestor name: type: string description: Nome do gestor pulseScoreCommon: type: array items: #/definitions/pulseScoreCommon description: Pontuação do gestor retornado managerNpsScores: type: object properties: id: type: string description: Id do gestor name: type: string description: Nome do gestor npsScoreCommon: type: array items: #/definitions/npsScoreCommon description: Pontuação do gestor retornado pulseQuestionScores: type: object required: – question – dimension – score properties: question: type: string description: Descrição da questão dimension: type: string description: Dimensão da questão score: type: number description: Pontuação da questão format: double status: #/definitions/pointTrend pulseDimension: type: object required: – pulseId – startDate – endDate – score properties: pulseId: type: string description: Id do pulso startDate: type: string description: Data inicial do pulso format: date endDate: type: string description: Data final do pulso format: date score: type: number description: Pontuação da dimensão no pulso format: double employeePhoto: type: object required: – employeeId – photoLink properties: employeeId: type: string description: Id do colaborador photoLink: type: string description: Link da foto employeeDataExceptions: type: object required: – exception properties: employee: #/definitions/employeeDTO exception: type: array items: type: string description: Lista de Exceções line: type: integer description: Linha do erro leader: type: string description: Id do Líder details: type: string description: Detalhes do erro employeeDTO: type: object properties: id: type: string description: Identificador único do colaborador name: type: string description: Nome. registernumber: type: integer description: Código do colaborador cpf: type: string description: CPF email: type: string description: Email. photoLink: type: string description: Link para a foto. photo: #/definitions/fileInfo phone: #/definitions/employeePhone branchOffice: #/definitions/company birthday: type: string description: Data de nascimento. format: date admissionDate: type: string description: Data de admissão. format: date dismissalDate: type: string description: Data de demissão format: date gender: #/definitions/genderType leader: #/definitions/employee pulseSendType: #/definitions/pulseSendType surveyAnalyst: type: boolean description: Indica se é analista da pesquisa usernames: type: array items: type: string description: Usuários vinculados blocked: type: boolean description: Indica se o usuário está bloqueado employeeType: #/definitions/employeeType fileInfo: type: object properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo, separados por /. type: string description: Versão do arquivo. employeePhone: type: object required: – codeCountryPhone – codeLocalPhone – phoneNumber properties: codeCountryPhone: type: integer description: Código de telefone do país codeLocalPhone: type: integer description: Código de local do telefone phoneNumber: type: integer description: Número de telefone company: type: object properties: id: type: string description: Identificador único da entidade. companyCode: type: integer description: Código da empresa companyName: type: string description: Nome da empresa (Razão social). tradingName: type: string description: Nome fantasia. companyType: #/definitions/companyType cnpj: type: string description: CNPJ (Cadastro nacional de pessoa jurídica). cnae: type: string description: CNAE (Classificação nacional de atividades econômicas). headQuarter: #/definitions/company logoId: type: string description: Identificador único da logo da empresa excluded: type: boolean description: Indica se a empresa está excluída employeeSummaryDTO: type: object required: – name properties: id: type: string description: Identificador único do colaborador name: type: string description: Nome email: type: string description: Email leaderName: type: string description: Nome do gestor do colaborador companyName: type: string description: Nome da empresa do colaborador importEmployeeDTO: type: object properties: id: type: string description: Identificador único do colaborador name: type: string description: Nome. registernumber: type: integer description: Código do colaborador cpf: type: string description: CPF email: type: string description: Email. photoLink: type: string description: Link para a foto. photo: #/definitions/fileInfo phone: #/definitions/importEmployeePhone branchOffice: #/definitions/importBranchOfficeDTO admissionDate: type: string description: Data de admissão. format: date dismissalDate: type: string description: Data de demissão format: date leader: #/definitions/employee pulseSendType: #/definitions/pulseSendType surveyAnalyst: type: boolean description: Indica se é analista da pesquisa usernames: type: array items: type: string description: Usuários vinculados blocked: type: boolean description: Indica se o usuário está bloqueado employeeType: type: string description: Tipo do colaborador importEmployeePhone: type: object properties: codeCountryPhone: type: integer description: Código de telefone do país codeLocalPhone: type: integer description: Código de local do telefone phoneNumber: type: integer description: Número de telefone importBranchOfficeDTO: type: object properties: code: type: integer description: Código da filial name: type: string description: Nome da filial (Razão social) headquarterCode: type: integer description: Código da empresa a qual a filial pertence headquarterName: type: string description: Nome da empresa a qual a filial pertence autocompleteResult: type: object required: – ok – tableId – fields properties: ok: type: boolean description: Flag para indicar sucesso. warning: type: boolean description: Flag para indicar sucesso com alerta. message: type: string description: Mensagem de retorno. tableId: type: string description: Id do registro pesquisado. fields: type: array items: #/definitions/autocompleteResultFields description: Descrição do registro pesquisado. autocompleteResultFields: type: object required: – name – value properties: name: type: string description: Nome do campo de retorno. value: type: string description: Valor do campo de retorno. autocompleteConditions: type: object required: – fields – expression properties: fields: type: array items: #/definitions/autocompleteFields description: Campos disponÃveis para o autocomplete. fieldType: #/definitions/autocompleteFieldType expression: #/definitions/autocompleteExpressionType value: type: string description: Valor da condição para o autocomplete. companyDTO: type: object properties: id: type: string description: Identificador único companyCode: type: integer description: Código da empresa name: type: string description: Nome da empresa logo: #/definitions/fileInfo logoLink: type: string description: Endereço da logo para acesso branchOfficeDTO: type: object required: – name – headQuarter properties: id: type: string description: Identificador único name: type: string description: Nome da filial headQuarter: #/definitions/companyDTO companyCode: type: integer description: Código da empresa jobPositionDTO: type: object required: – name – companyName properties: id: type: string description: Identificador único name: type: string description: Nome do cargo companyName: type: string description: Nome da empresa que o cargo pertence costCenterDTO: type: object required: – name – companyName properties: id: type: string description: Identificador único name: type: string description: Nome do centro de custo companyName: type: string description: Nome da empresa que o centro de custo pertence workstationGroupDTO: type: object required: – name – companyName properties: id: type: string description: Identificador único name: type: string description: Nome do posto de trabalho companyName: type: string description: Nome da empresa que o posto de trabalho pertence departmentDTO: type: object required: – name – companyName properties: id: type: string description: Identificador único name: type: string description: Nome do departamento companyName: type: string description: Nome da empresa que o departamento pertence educationDegreeDTO: type: object required: – name properties: id: type: string description: Identificador único name: type: string description: Nome do grau de instrução hierarchy: type: object properties: id: type: string description: Identificador único da entidade. name: type: string description: Nome da hierarquia. items: type: array items: #/definitions/hierarchyItem description: Itens hierarchyItem: type: object properties: id: type: string description: Identificador único da entidade. hierarchy: #/definitions/hierarchy position: type: string description: Posição deste item na hierarquia. parent: #/definitions/hierarchyItem employee: #/definitions/employee children: type: array items: #/definitions/hierarchyItem description: Filhos desse item na hierarquia. hierarchyRevision: type: object required: – hierarchy properties: id: type: string description: Identificador único da entidade. hierarchy: #/definitions/hierarchy startDate: type: string description: Data de início format: date items: type: array items: #/definitions/hierarchyItemRevision description: Itens hierarchyItemRevision: type: object properties: id: type: string description: Identificador único da entidade hierarchy: #/definitions/hierarchyRevision position: type: string description: Posição deste item na hierarquia parent: #/definitions/hierarchyItemRevision employee: #/definitions/employee children: type: array items: #/definitions/hierarchyItem description: Filhos desse item na hierarquia questionBalance: type: object required: – id properties: id: type: string description: Identificador do balanceamento da questão question: #/definitions/question priority: type: integer description: Prioridade da questão para ser utilizada no pulso evaluatedLeaderHistoric: type: object properties: id: type: string description: Id dateAlt: type: string description: Data da tentativa de envio de email format: date-time employeeId: type: string description: Colaborador operation: type: string description: Descrição da Operação username: type: string description: Usuário do colaborador dimensionBalance: type: object properties: id: type: string description: Identificados do balanceamento da dimensão dimension: #/definitions/dimension priority: type: integer description: Prioridade da dimensão para ser utilizada no pulso companyHierarchy: type: object required: – startDate properties: id: type: string description: Identificador único da entidade. hierarchy: #/definitions/hierarchy company: #/definitions/company startDate: type: string description: Data de início format: date pulseResult: type: object properties: id: type: string description: Identificador único da entidade. pulse: #/definitions/pulse dimension: #/definitions/dimension leader: #/definitions/employee pulseAnswer: #/definitions/answerTicket satisfaction: type: number description: Resultado da resposta format: double question: #/definitions/question branchOfficeHistorical: type: object required: – startDate – branchOffice – employee properties: id: type: string description: Identificador único da entidade. startDate: type: string description: Data de início format: date branchOffice: #/definitions/company employee: #/definitions/employee idg5: type: string description: Código do histórico de filial na g5 npsAnswer: type: object properties: id: type: string description: Identificador do resultado pulseAnswer: #/definitions/answerTicket pulse: #/definitions/pulse satisfaction: type: integer description: Stisfação da resposta pulseResultDimension: type: object required: – id – pulse – dimension – satisfaction – satisfactionDifference properties: id: type: string description: Id do resultado pulse: #/definitions/pulse dimension: #/definitions/dimension satisfaction: type: number description: Satisfação format: double satisfactionDifference: type: number description: Diferença da satistação atual para o último pulso format: double pulseResultLeaderDimension: type: object required: – id – pulse – dimension – leader – satisfaction – satisfactionDifference – departmentSatisfaction – departmentSatisfactionDifference properties: id: type: string description: Id do resultado pulse: #/definitions/pulse dimension: #/definitions/dimension leader: #/definitions/employee satisfaction: type: number description: Satisfação format: double satisfactionDifference: type: number description: Diferença da satistação atual para o último pulso format: double departmentSatisfaction: type: number description: Satisfação da dimensão no departamento format: double departmentSatisfactionDifference: type: number description: Diferença da satistação atual do departamento para o último pulso format: double emailLoggerErrorSend: type: object required: – dateSend – errorMessage properties: id: type: string description: Identificador único da entidade. dateSend: type: string description: Data da tentátiva de envio format: date-time pulse: #/definitions/pulse employeeId: type: string description: Id do colaborador da tentativa de envio email: type: string description: Endereço de email usado na tentativa de envio errorMessage: type: string description: Mensagem de erro. Pode conter apenas a mensagem ou o stack trace completo. importEmployeeResult: type: object required: – success – exception – createAt properties: id: type: string description: Identificador único da entidade. success: type: string description: Json colaboradores executados com sucesso exception: type: string description: Json colaboradores não importados createAt: type: string description: Data de criação format: date-time notifyUserEventPayload: type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority 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 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