2.0info: 1.13.1 salary_survey_analysis x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: salary_survey_analysis contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /salary_survey_analysis/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getJobPosition: post: description: Buscar cargos definidos para pesquisa salarial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pageConfig description: Paginação jobPositionFilter: type: string description: Filtro responses: 200: description: Ok schema: type: object required: – jobPositions – totalSize properties: jobPositions: type: array items: type: object allOf: – #/definitions/jobPositionDto minimum: 1 description: Lista de cargos totalSize: type: integer format: int64 description: Total de itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getCbo: post: description: Buscar CBOs definidos para pesquisa salarial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pageConfig description: Paginação cboName: type: string description: Filtro Nome do CBO cboCode: type: string description: Filtro codigo de CBO responses: 200: description: Ok schema: type: object required: – cboSet – totalSize properties: cboSet: type: array items: type: object allOf: – #/definitions/cboDTO minimum: 1 description: Retorno de cboName e cboCode totalSize: type: integer format: int64 description: Total de itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getAccept: post: description: buscar termo de aceite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – acceptedBy – acceptedAt properties: acceptedBy: type: string description: Nome usuario acceptedAt: type: string format: date description: Data de aceitação typeAccess: type: string description: Tipo de contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: buscar termo de aceite tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – acceptedBy – acceptedAt properties: acceptedBy: type: string description: Nome usuario acceptedAt: type: string format: date description: Data de aceitação typeAccess: type: string description: Tipo de contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getSeniority: post: description: Buscar Senioridades definidas para pesquisa salarial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pageConfig description: Paginação jobPositionNormalized: type: string description: Filtro Cargo Normalizado cboCode: type: string description: Filtro CBO responses: 200: description: Ok schema: type: object required: – seniorities – totalSize properties: seniorities: type: array items: type: string minimum: 1 description: Lista de cargos totalSize: type: integer format: int64 description: Total de itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getCompanySegments: post: description: Buscar segmentos de empresa definidos para pesquisa salarial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competences – localities properties: jobPositionsNormalized: type: array items: type: string description: Filtro Cargo Normalizado cboCodes: type: array items: type: string description: Filtro CBO nameFilter: type: string description: Filtro de texto competences: type: array items: type: string minimum: 1 description: Datas de referência localities: type: array items: type: string minimum: 1 description: Estados(Siglas) responses: 200: description: Ok schema: type: object required: – companySegments properties: companySegments: type: array items: type: string minimum: 1 description: Lista de cargos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getCompanySizes: post: description: Buscar os portes das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – companySizes properties: companySizes: type: array items: type: object allOf: – #/definitions/companySizeDTO minimum: 1 description: Lista com os portes das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar os portes das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – companySizes properties: companySizes: type: array items: type: object allOf: – #/definitions/companySizeDTO minimum: 1 description: Lista com os portes das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getReferencedDates: post: description: Buscar datas de referência para a pesquisa salarial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pageConfig description: Paginação filterDate: type: string description: Filtro de data responses: 200: description: Ok schema: type: object required: – referencedDates – totalSize properties: referencedDates: type: array items: type: string minimum: 1 description: Lista de tamanhos totalSize: type: integer format: int64 description: Total de itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getWorkshift: post: description: Busca as escalas de trabalho tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pageConfig description: Paginação jobPositionNormalized: type: string description: Filtro Cargo Normalizado cboCode: type: string description: Filtro CBO responses: 200: description: Ok schema: type: object required: – workshifts – totalSize properties: workshifts: type: array items: type: object allOf: – #/definitions/WorkshiftDtoOut minimum: 1 description: Lista de escalas totalSize: type: integer format: int64 description: Total de itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/salarySurveyCount: post: description: Totalizadores da pesquisa salarial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filters properties: filters: type: object allOf: – #/definitions/salarySurveyFilter description: Filtros responses: 200: description: Ok schema: type: object required: – resultCount – logUsageId properties: resultCount: type: array items: type: object allOf: – #/definitions/salarySurveyCountResult minimum: 1 description: Totalizadores logUsageId: type: string description: Identificador do log de uso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/salarySurveyComparity: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filters properties: filters: type: object allOf: – #/definitions/salarySurveyFilter description: Filtros responses: 200: description: Ok schema: type: object required: – salarySurveyData – invalidFilters properties: salarySurveyData: type: array items: type: object allOf: – #/definitions/salarySurveyAnalysisDataResult minimum: 1 description: Dados da pesquisa salarial invalidFilters: type: array items: type: object allOf: – #/definitions/invalidFilters minimum: 1 description: Filtros sem correspondência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/saveJobPositionCboCodeIgnorePreference: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – jobFilterJobIgnore properties: jobFilterJobIgnore: type: array items: type: object allOf: – #/definitions/jobFilterJobIgnore minimum: 1 description: Lista dos cargos ou CBOs a ignorar responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Status da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/jobDescriptionPollAiResult: post: description: Busca os status do processamento de uma thread de agente de IA tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – threadId – runId properties: threadId: type: string description: Identificador da thread runId: type: string description: Identificador da execução responses: 200: description: Ok schema: type: object required: – threadStatus properties: threadStatus: type: string allOf: – #/definitions/AiThreadStatus description: Status da thread 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os status do processamento de uma thread de agente de IA tags: – Queries x-senior-visibility: PRIVATE parameters: – name: threadId description: Identificador da thread in: query required: true type: string – name: runId description: Identificador da execução in: query required: true type: string responses: 200: description: Ok schema: type: object required: – threadStatus properties: threadStatus: type: string allOf: – #/definitions/AiThreadStatus description: Status da thread 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getJobDescriptionUserFeedback: post: description: Retorna o feedback do usuário logado para uma descrição de cargo gerada por IA tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – jobDescriptionId properties: jobDescriptionId: type: string description: Identificador da descrição do cargo gerada por IA responses: 200: description: Ok schema: type: object properties: aiJobDescriptionCustomerLvlConsistency: type: object allOf: – #/definitions/feedbackJobDescriptionDTO description: Feedback do usuário para descrição do cargo gerada por IA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o feedback do usuário logado para uma descrição de cargo gerada por IA tags: – Queries x-senior-visibility: PRIVATE parameters: – name: jobDescriptionId description: Identificador da descrição do cargo gerada por IA in: query required: true type: string responses: 200: description: Ok schema: type: object properties: aiJobDescriptionCustomerLvlConsistency: type: object allOf: – #/definitions/feedbackJobDescriptionDTO description: Feedback do usuário para descrição do cargo gerada por IA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportSalarySurveyData: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportJobPositionView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportSeniorityView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportCboView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportCompanySize: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportWorkshiftView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportSurveyLogUsage: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportSurveyContractValidation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportSurveyLogCustomerExtraction: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportSurveyLogProcessedFile: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportUserTermAcceptance: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportCsat: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportJobpositionStatsIgnored: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportAiJobDescription: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/exportAiJobDescriptionCustomerLvlConsistency: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/acceptTerm: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: termVersion: type: string description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/manualLoadData: post: description: Processamento manual do loadData tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – listJsons properties: listJsons: type: array items: type: string minimum: 1 description: Lista de arquivos JSON a serem processados responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: object allOf: – #/definitions/fileProcessingResultDTO minimum: 1 description: Lista de resultados do processamento de arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/listJsonsInBucket: post: description: List jsons no AWS s3 bucket tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – files properties: files: type: array items: type: string minimum: 1 description: Lista de arquivos JSON no bucket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/logSurveyExtraction: post: description: Fazer o log de extração de dados da pesquisa salarial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId – dataCount properties: tenantId: type: string description: Id do Tenant dataCount: type: integer format: int64 description: Quantidade de dados responses: 200: description: Ok schema: type: object required: – batchId properties: batchId: type: string description: Id do lote registrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/generateJobDescriptionAI: post: description: Gera via agente uma descrição para um cargo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filters properties: filters: type: object allOf: – #/definitions/jobDescriptionFilter description: Filtros da pesquisa salarial responses: 200: description: Ok schema: type: object properties: aiJobDescription: type: object allOf: – #/definitions/AiJobDescriptionResponseDto description: Dados da descrição do cargo gerada aiThread: type: object allOf: – #/definitions/AiThreadDto description: Dados do thread de processamento do agente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/jobDescriptionCommitAiResult: post: description: Busca o resultado final da geração da descrição do cargo via IA e armazena no banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – threadId – filters – generationTime properties: threadId: type: string description: Identificador da thread filters: type: object allOf: – #/definitions/jobDescriptionFilter description: Filtros da pesquisa salarial generationTime: type: integer format: int64 description: Tempo gasto para geração da descrição do cargo em milissegundos responses: 200: description: Ok schema: type: object required: – aiJobDescription properties: aiJobDescription: type: object allOf: – #/definitions/AiJobDescriptionResponseDto description: Dados da descrição do cargo gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/activateProduct: post: description: Ativa o produto para um tenant com data de expiração – Cria recurso do agente, persiste em tenantexportcontrol e cria um customer_contract tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractType – tenants – expirationDate properties: contractType: type: string allOf: – #/definitions/validationType description: Tipo de contrato tenants: type: array items: type: string minimum: 1 description: Tenants a ativar expirationDate: type: string format: date description: Data de expiração do contrato responses: 200: description: Ok schema: type: object properties: activedTenants: type: array items: type: string description: Tentants ativados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importSalarySurveyData: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importJobPositionView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importSeniorityView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importCboView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importCompanySize: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importWorkshiftView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importSurveyLogUsage: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importSurveyContractValidation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importSurveyLogCustomerExtraction: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importSurveyLogProcessedFile: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importUserTermAcceptance: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importCsat: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importJobpositionStatsIgnored: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importAiJobDescription: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/actions/importAiJobDescriptionCustomerLvlConsistency: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/signals/loadData: post: description: Carregar dados da pesquisa salarial processados e categorizados do bucket S3 tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/signals/collectUserExperience: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – score properties: score: type: integer format: int64 description: Score logUsageId: type: string description: Identificador do uso comment: type: string description: Comentário responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/signals/logSurveyDataLakeSent: post: description: Fazer o log de envio de dados da pesquisa salarial para o Datalake tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – batchId properties: batchId: type: string description: Id do Tenant dataCountSent: type: integer format: int64 description: Quantidade de dados enviados dataCountSentError: type: integer format: int64 description: Quantidade de dados com falha ao enviar errorMsg: type: string description: Mensagem de erro hcmInvalidDataCount: type: integer format: int64 description: Dados classificados com erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importSalarySurveyDataEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportSalarySurveyDataEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importJobPositionViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportJobPositionViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importSeniorityViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportSeniorityViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importCboViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportCboViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importCompanySizeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportCompanySizeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importWorkshiftViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportWorkshiftViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importSurveyLogUsageEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportSurveyLogUsageEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importSurveyContractValidationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportSurveyContractValidationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importSurveyLogCustomerExtractionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportSurveyLogCustomerExtractionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importSurveyLogProcessedFileEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportSurveyLogProcessedFileEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importUserTermAcceptanceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportUserTermAcceptanceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importCsatEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportCsatEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importJobpositionStatsIgnoredEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportJobpositionStatsIgnoredEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importAiJobDescriptionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportAiJobDescriptionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/importAiJobDescriptionCustomerLvlConsistencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/events/exportAiJobDescriptionCustomerLvlConsistencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/entities/aiJobDescriptionCustomerLvlConsistency: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/aiJobDescriptionCustomerLvlConsistency responses: 200: description: The created resource schema: #/definitions/aiJobDescriptionCustomerLvlConsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/aiJobDescriptionCustomerLvlConsistency responses: 200: description: The created resource schema: #/definitions/aiJobDescriptionCustomerLvlConsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/aiJobDescriptionCustomerLvlConsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/entities/aiJobDescriptionCustomerLvlConsistency/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAiJobDescriptionCustomerLvlConsistency responses: 200: description: Ok schema: #/definitions/editAiJobDescriptionCustomerLvlConsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/aiJobDescriptionCustomerLvlConsistency responses: 200: description: Ok schema: #/definitions/aiJobDescriptionCustomerLvlConsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/aiJobDescriptionCustomerLvlConsistency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /salary_survey_analysis/entities/aiJobDescriptionCustomerLvlConsistency/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/aiJobDescriptionCustomerLvlConsistency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim remunerationType: type: string enum: – FIXED – BONUS_HAZARD – BONUS_INSALUBRITY – BONUS_FUNCTION – TOTAL description: Tipo de remuneração: * `FIXED` – Fixo * `BONUS_HAZARD` – Bonus Periculosidade * `BONUS_INSALUBRITY` – Bonus Insalubridade * `BONUS_FUNCTION` – Bonus por função * `TOTAL` – Total validationType: type: string enum: – TRIAL – FULL description: Tipo de validação de contrato: * `TRIAL` – TRIAL * `FULL` – FULL filterType: type: string enum: – CBO – JOBPOSITION description: Tipo de filtro: * `CBO` – CBO * `JOBPOSITION` – Cargo ignoreType: type: string enum: – MARKET – COMPANY AiThreadStatus: type: string enum: – QUEUED – IN_PROGRESS – REQUIRES_ACTION – CANCELLING – CANCELLED – PROCESSING – FAILED – ERROR – COMPLETED – EXPIRED – WAITING_CONFIRMATION description: Status do thread de agente de IA: * `QUEUED` – Está na fila * `IN_PROGRESS` – Em progresso * `REQUIRES_ACTION` – Precisa de ação do usuário * `CANCELLING` – Em processo de cancelamento * `CANCELLED` – Completamente cancelado * `PROCESSING` – Em processamento * `FAILED` – Falhou * `ERROR` – Erro * `COMPLETED` – Completado * `EXPIRED` – Expirado * `WAITING_CONFIRMATION` – Esperando confirmação do usuário userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error feedbackJobDescriptionDTO: description: Dados de feedback do usuário para descrição do cargo gerada por IA type: object required: – id – score properties: id: type: string description: Identificador único do registro score: type: integer format: int64 description: Nota para descrição gerada minimum: 1 maximum: 5 AiThreadDto: description: Dados do thread de agente de IA type: object required: – threadId – runId properties: threadId: type: string description: runId: type: string description: AiJobDescriptionResponseDto: description: Dados da descrição do cargo gerada type: object required: – jobDescriptionId – jobDescription properties: jobDescriptionId: type: string description: jobDescription: type: string description: WorkshiftDtoOut: description: Escala de trabalho type: object required: – workshift – formattedWorkshift properties: workshift: type: integer format: int64 description: Escala em minutos formattedWorkshift: type: string description: Escala em horas checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status pageConfig: description: Record referente a paginação type: object required: – page – size properties: page: type: integer format: int64 description: Número da página size: type: integer format: int64 description: Tamanho da página jobPositionDto: description: Record referente aos dados de JobPosition type: object required: – jobPositionId – jobPositionName – seniorities properties: jobPositionId: type: string description: Identificador único do cargo jobPositionName: type: string description: Nome do cargo seniorities: type: array items: type: object allOf: – #/definitions/seniorityDTO minimum: 1 description: cboDTO: description: Record referente aos dados de CBO type: object required: – cboCode – cboName – seniorities properties: cboCode: type: string description: Código do CBO cboName: type: string description: Nome do CBO seniorities: type: array items: type: object allOf: – #/definitions/seniorityDTO minimum: 1 description: seniorityDTO: description: Record referente aos dados de Senioridade type: object required: – seniorityId – seniorityName – seniorityDescription – cboCode – jobPositionId properties: seniorityId: type: string description: Identificador único da senioridade seniorityName: type: string description: Nome da senioridade seniorityDescription: type: string description: Descrição da senioridade cboCode: type: string description: CBO jobPositionId: type: string description: Cargo companySegmentDTO: description: Record referente aos dados de Segmento da empresa type: object required: – companySegmentId – companySegmentDescription properties: companySegmentId: type: string description: Identificador único do segmento companySegmentDescription: type: string description: Descrição do segmento companySizeDTO: description: Record referente aos dados de Tamanho da empresa type: object required: – companySizeId – companySizeDescription properties: companySizeId: type: string description: Identificador único do tamanho da empresa companySizeDescription: type: string description: Descrição do tamanho da empresa salarySurveyCountResult: description: type: object required: – jobPositionName – JobPositionSeniority – salarySurveyCountDTO properties: jobPositionName: type: string description: Nome do cargo JobPositionSeniority: type: string description: Senioridade salarySurveyCountDTO: type: object allOf: – #/definitions/salarySurveyCountDTO description: Lista referente aos dados de pesquisa salarial fileProcessingResultDTO: description: Record referente ao resultado do processamento de arquivos type: object required: – file – status – message properties: file: type: string description: Nome do arquivo status: type: string description: Status do processamento message: type: string description: Mensagem descritiva salarySurveyCountDTO: description: Record referente aos dados de totalizadores type: object required: – companyCount – occupantCount – jobPositionCount – jobPositionList – cboCount – cboList – localityCount – localityFoundList – localityNotFoundList properties: companyCount: type: integer format: int64 description: Quantidade de empresas occupantCount: type: integer format: int64 description: Quantidade de ocupantes jobPositionCount: type: integer format: int64 description: Quantidade de cargos encontrados jobPositionList: type: array items: type: string minimum: 1 description: Lista de cargos encontrados cboCount: type: integer format: int64 description: Quantidade de CBOs cboList: type: array items: type: string minimum: 1 description: Lista de CBOs encontrados localityCount: type: integer format: int64 description: Quantidade de localidades encontradas localityFoundList: type: array items: type: string minimum: 1 description: Lista de localidades encontradas localityNotFoundList: type: array items: type: string minimum: 1 description: Lista de localidades não encontradas salarySurveyFilter: description: type: object required: – localities – referenceDates properties: jobFilter: type: array items: type: object allOf: – #/definitions/jobFilter description: Filtro de cargo com senioridade localities: type: array items: type: string minimum: 1 description: Localidades referenceDates: type: array items: type: string minimum: 1 description: Data de referência segmentIds: type: array items: type: string description: Segmento da empresa companySizeId: type: string description: Id do tamanho da empresa companyName: type: string description: Nome da empresa seniority: type: string description: Senioridade contractType: type: string description: Tipo de contrato workshift: type: string description: Porte da empresa revenue: type: string description: faturmento da empresa headCount: type: string description: número de pessoas jobFilter: description: Record referente ao filtro de cargos type: object required: – filterType – jobCBO – seniority properties: filterType: type: string allOf: – #/definitions/filterType description: Tipo de filtro jobCBO: type: string description: Nome do cargo seniority: type: string description: Nível de senioridade do cargo salarySurveyAnalysisDataResult: description: type: object required: – jobPositionName – JobPositionSeniority – salarySurveyAnalysisData – marketJobPositionsCbos – companyJobPositionsCbos properties: jobPositionName: type: string description: Nome do cargo JobPositionSeniority: type: string description: Senioridade salarySurveyAnalysisData: type: array items: type: object allOf: – #/definitions/salarySurveyAnalysisData minimum: 1 description: Lista referente aos dados de pesquisa salarial marketJobPositionsCbos: type: array items: type: object allOf: – #/definitions/jobPositionCboStatsIncluded minimum: 1 description: Cargos ou CBOs do mercado companyJobPositionsCbos: type: array items: type: object allOf: – #/definitions/jobPositionCboStatsIncluded minimum: 1 description: Considerado nas estatísticas jobPositionCboStatsIncluded: description: Record referente aos dados de cargos e CBOs do mercado type: object required: – jobPositionCbo – statsIncluded properties: jobPositionCbo: type: string description: Cargo ou CBO statsIncluded: type: boolean description: Considerado nas estatísticas invalidFilters: description: Filtros invalidos type: object required: – filteredValue – filterType properties: filteredValue: type: string description: Valor filtrado filterType: type: string allOf: – #/definitions/filterType description: Tipo do filtro jobDescriptionFilter: description: type: object required: – jobFilter properties: jobFilter: type: object allOf: – #/definitions/jobFilter description: Filtro de cargo com senioridade segmentName: type: string description: Segmento da empresa salarySurveyAnalysisData: description: Record referente aos dados de análise da pesquisa salarial type: object required: – remunerationType – marketAverage – marketFirstQuartile – marketMedian – marketThirdQuartile – makertNinetyPercentile – marketmedian80 – marketmedian120 properties: remunerationType: type: string allOf: – #/definitions/remunerationType description: Tipo de remuneração average: type: number format: double description: Média marketAverage: type: number format: double description: Média mercado firstQuartile: type: number format: double description: Primeiro quartil marketFirstQuartile: type: number format: double description: Primeiro quartil percentual median: type: number format: double description: Mediana marketMedian: type: number format: double description: Mediana percentual thirdQuartile: type: number format: double description: Terceiro quartil marketThirdQuartile: type: number format: double description: Terceiro quartil percentual ninetyPercentile: type: number format: double description: Percentil 90 makertNinetyPercentile: type: number format: double description: Percentil 90 market median80: type: number format: double description: 80% da mediana marketmedian80: type: number format: double description: 80% da mediana do mercado median120: type: number format: double description: 120% da mediana marketmedian120: type: number format: double description: 120% da mediana do mercado jobFilterJobIgnore: description: Filtro de cargos para ignorar em consultas type: object required: – filterType – jobPositionNormalizedCboCode properties: filterType: type: string allOf: – #/definitions/filterType description: Tipo de filtro jobPositionNormalizedCboCode: type: string description: Nome do cargo normalizado ou CBO jobPositionCboCodeIgnore: type: array items: type: object allOf: – #/definitions/jobPositionCboCodeIgnore description: Cargos originais a ignorar seniority: type: string description: Senioridade jobPositionCboCodeIgnore: description: Cargos originais a ignorar type: object required: – jobPositionCboCode – ignoreOn properties: jobPositionCboCode: type: string description: Cargos originais a ignorar ignoreOn: type: string allOf: – #/definitions/ignoreType description: Enum mercado/company salarySurveyData: description: Dados da pesquisa salarial processadas com categoria type: object required: – id – sourceId – company – branchOffice – cnae – state – competence – jobPosition – jobPositionDescription – cboName – cboCode – cboDescription – hireDate – workShift – contractType – baseSalary – regionalMinimumSalary – socialMinimumSalary – spendingMoney – additionalFunctionPercentage – additionalFunctionValue – insalubrityPercentage – insalubrityValue – hazardPercentage – hazardValue – companySize – jobPositionNormalized – jobPositionClusterId – salaryType – icpBonus – icpAward – icpCashhandLingBonus – icpCommission – icpGratification – icpPplr – icpLongServicebonus – headCount – annualRevenue – seniorityName – segmentName – jobPositionDescClusterId – originalSalary – outlierType – protectedJobPosition properties: id: type: string description: Identificador único da pesquisa salarial sourceId: type: string description: Identificador externo company: type: string description: Empresa branchOffice: type: string description: Filial cnae: type: string description: Número do CNAE state: type: string description: Estado competence: type: string description: Competência jobPosition: type: string description: Cargo jobPositionDescription: type: string description: Descrição do cargo cboName: type: string description: Nome do CBO cboCode: type: string description: Código do CBO cboDescription: type: string description: Descrição do CBO hireDate: type: string format: date description: Data de admissão workShift: type: integer format: int64 description: Turno contractType: type: string description: Tipo de Contrato baseSalary: type: number format: double description: Salário base regionalMinimumSalary: type: number format: double description: Salário minímo regional socialMinimumSalary: type: number format: double description: Salário minímo spendingMoney: type: number format: double description: Adicional de gastos additionalFunctionPercentage: type: number format: double description: Percentual do adicional de função additionalFunctionValue: type: number format: double description: Valor do adicional de função insalubrityPercentage: type: number format: double description: Percentual do adicional de insalubridade insalubrityValue: type: number format: double description: Valor do adicional de insalubridade hazardPercentage: type: number format: double description: Percentual do adicional de periculosidade hazardValue: type: number format: double description: Valor do adicional de periculosidade companySize: type: object allOf: – #/definitions/companySize description: Tamanho da empresa jobPositionNormalized: type: string description: Titulo do cargo normalizado jobPositionClusterId: type: integer format: int64 description: ID do cargo normalizado salaryType: type: integer format: int64 description: Tipo de Salário icpBonus: type: number format: double description: Bônus ICP icpAward: type: number format: double description: Prêmio ICP icpCashhandLingBonus: type: number format: double description: Bônus por Manipulação de Caixa ICP icpCommission: type: number format: double description: Comissão ICP icpGratification: type: number format: double description: Gratificação ICP icpPplr: type: number format: double description: PPLR ICP icpLongServicebonus: type: number format: double description: Bônus de Longo Serviço ICP headCount: type: string description: Quantidade de Colaboradores annualRevenue: type: string description: Faturamento Anual seniorityName: type: string description: Nome da senioridade segmentName: type: string description: Nome do segmento jobPositionDescClusterId: type: integer format: int64 description: ID da categoria do cargo originalSalary: type: number format: double description: Salario Original outlierType: type: string description: Tipo de Outlier protectedJobPosition: type: string description: Cargo protegido jobPositionView: description: Cargo normalizado type: object required: – jobPositionNormalized properties: jobPositionNormalized: type: string description: Nome do cargo normalizado seniorityView: description: View senioridades type: object required: – jobPositionNormalized – cboCode – cboName – seniorityName properties: jobPositionNormalized: type: string description: Nome do cargo normalizado cboCode: type: string description: Código do CBO cboName: type: string description: Nome do CBO seniorityName: type: string description: Senioridade cboView: description: Materialized View de CBO type: object required: – cboName – cboCode properties: cboName: type: string description: Nome do CBO cboCode: type: string description: Código do CBO companySize: description: Tamanho da empresa type: object properties: id: type: string description: Identificador único do registo name: type: string description: Nome do tamanho da empresa description: type: string description: Descrição do tamanho da empresa startRange: type: integer format: int64 description: Inicio da faixa de funcionários endRange: type: integer format: int64 description: Fim da faixa de funcionários workshiftView: description: Materialized View Segmento da empresa type: object required: – jobPositionNormalized – cboCode – workshift – formattedWorkshift properties: jobPositionNormalized: type: string description: Nome do cargo normalizado cboCode: type: string description: Código do CBO workshift: type: integer format: int64 description: Escala em minutos formattedWorkshift: type: string description: Escala em horas surveyLogUsage: description: Logs da pesquisa salarial type: object required: – tenantId – userId – dateWhen – job – cbo – location – segment – headCount – revenue – competence – workshift – contractType – surveyType – result properties: id: type: string description: Identificador único do log tenantId: type: string description: Id do Tenant userId: type: string description: Id do usuário dateWhen: type: string format: date-time description: Data de criação do log job: type: string description: Cargo cbo: type: string description: CBO location: type: string description: Localização segment: type: string description: Segmento da empresa headCount: type: string description: Faixa de colaboradores revenue: type: string description: Faixa de faturamento competence: type: string description: Competência workshift: type: string description: Carga horária contractType: type: string description: Tipo de contrato surveyType: type: string description: Tipo de pesquisa result: type: string description: Resultado da pesquisa surveyContractValidation: description: type: object required: – tenantId – contractType – expirationDate – jobPositionsNormalizedReleased – distinctJobsReleasedTotal – distinctJobsReleasedByMonth properties: id: type: string format: uuid description: Identificador único do log tenantId: type: string description: Id do Tenant contractType: type: string allOf: – #/definitions/validationType description: Tipo de Contrato expirationDate: type: string format: date-time description: Data de expiração do contrato jobPositionsNormalizedReleased: type: string description: Lista de Cargos distinctJobsReleasedTotal: type: integer format: int64 description: Quantidade distinta total de cargos liberados distinctJobsReleasedByMonth: type: integer format: int64 description: Quantidade distinta de cargos liberados no mês surveyLogCustomerExtraction: description: type: object required: – tenantId – dateWhen – dataCount – hcmInvalidDataCount – dataCountSent – dataCountSentError properties: id: type: string description: tenantId: type: string description: Id do Tenant dateWhen: type: string format: date-time description: Data de criação do log dataCount: type: integer format: int64 description: Quantidade de dados esperados hcmInvalidDataCount: type: integer format: int64 description: Quantidade de dados inconsistentes filtrados no hcm dataCountSent: type: integer format: int64 description: Quantidade de dados enviados dataCountSentError: type: integer format: int64 description: Quantidade de dados com falha ao enviar errorMsg: type: string description: Mensagem de erro surveyLogProcessedFile: description: type: object required: – tenantId – dateWhen – fileName properties: id: type: string description: Identificador único do log tenantId: type: string description: Id do Tenant dateWhen: type: string format: date-time description: Data de criação do log fileName: type: string description: Nomme do arquivo processado userTermAcceptance: description: type: object required: – tenant – acceptedBy – acceptedAt properties: id: type: string description: Id do tenant tenant: type: string description: Tenant acceptedBy: type: string description: Nome do usuário sem dominio acceptedAt: type: string format: date-time description: Data de aceite termVersion: type: string description: Versão do termo de aceite csat: description: type: object required: – tenantId – username – dateWhen – logUsage – note properties: id: type: string description: Identificador único do registro tenantId: type: string description: Id do Tenant username: type: string description: Id do usuário dateWhen: type: string format: date-time description: Data de criação do registro logUsage: type: object allOf: – #/definitions/surveyLogUsage description: Id do log de uso note: type: integer format: int64 description: Nota comment: type: string description: Comentário jobpositionStatsIgnored: description: type: object required: – id – tenant – filterType – jobPositionNormalizedCboCode – jobPositionCboCodeIgnore – seniority – ignoreOn properties: id: type: string description: Identificador tenant: type: string description: Tenant filterType: type: string allOf: – #/definitions/filterType description: Tipo JobPosition / CboCode jobPositionNormalizedCboCode: type: string description: Cargo ou CBO agrupador do filtro jobPositionCboCodeIgnore: type: string description: JobPosition a ignorar seniority: type: string description: Senioridade ignoreOn: type: string description: enum mercado/company aiJobDescription: description: Descrição do Cargo gerada por IA type: object required: – jobCboName – seniorityName – jobDescription – tenant – generationTime properties: id: type: string format: uuid description: Identificador único do registro jobCboName: type: string description: Cargo ou CBO referente seniorityName: type: string description: Senioridade do cargo companySegmentName: type: string description: Segmento da empresa relacionado ao cargo jobDescription: type: string description: Descrição do cargo gerada por IA tenant: type: string description: Tenant generationTime: type: integer format: int64 description: Tempo de resposta da geração da IA em milissegundos reusageCount: type: integer format: int64 description: Contador de reuso da descrição gerada default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: aiJobDescriptionCustomerLvlConsistency: description: CSAT da descrição do cargo gerada por IA type: object required: – aiJobDescription – score properties: id: type: string format: uuid description: Identificador único do registro aiJobDescription: type: object allOf: – #/definitions/aiJobDescription description: Descrição do cargo gerada por IA score: type: integer format: int64 description: Nota para descrição gerada minimum: 1 maximum: 5 tenant: type: string description: Tenant createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAiJobDescriptionCustomerLvlConsistency: type: object required: – id allOf: – #/definitions/aiJobDescriptionCustomerLvlConsistency notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage