2.0info: 2.7.0 career_questionnaire x-senior-domain: hcm_career x-senior-domain-path: hcm_career x-senior-service-path: career_questionnaire 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/hcm_careersecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /career_questionnaire/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 /career_questionnaire/queries/retrieveCareerQuestionnaire: post: description: Retorna as informações do questionário de carreira tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId properties: questionnaireId: type: string description: Identificador único do questionário responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do questionário de carreira tags: – Queries x-senior-visibility: PRIVATE parameters: – name: questionnaireId description: Identificador único do questionário in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getTalentPoolQuestionnaireByName: post: description: Retorna os grupos de talento de acordo com o nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: talentPoolName: type: string description: Nome do grupo page: type: object allOf: – #/definitions/pagination description: Paginação dos dados orderBy: type: object allOf: – #/definitions/ordination description: Dados de ordenação responses: 200: description: Ok schema: type: object allOf: – #/definitions/talentPoolQuestionnairePagedList 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/retrieveCareerQuestionnairesStatus: post: description: Retorna os questionários de carreira contendo nome, status e data de publicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: type: string description: Parte do nome do questionário status: type: string allOf: – #/definitions/questionnaireStatus description: Status do questionário page: type: object allOf: – #/definitions/pagination description: Paginação dos dados responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnairesStatusPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getCareerQuestionnaireEmployees: post: description: Retorna os colaboradores sem considerar os demitidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: name: type: string description: Nome do colaborador registerNumber: type: string description: Código do colaborador orderBy: type: array items: type: object allOf: – #/definitions/ordination description: Ordenação dos campos page: type: object allOf: – #/definitions/pagination description: Paginação dos dados responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireEmployeesPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getQuestionnaireDetails: post: description: Retorna o questionário com as perguntas e opções de respostas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId properties: questionnaireId: type: string description: Identificador do questionário responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o questionário com as perguntas e opções de respostas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: questionnaireId description: Identificador do questionário in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getAllQuestionnaires: post: description: Retorna os questionários com titulo e orientações para a tela dos Meus Questionários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: object allOf: – #/definitions/pagination description: Paginação dos dados responses: 200: description: Ok schema: type: object allOf: – #/definitions/questionnairesPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getCareerQuestionnairesTracking: post: description: Retorna uma lista com os nomes dos questionários de carreira para a tela de questionários da organização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: type: string description: Nome do questionário status: type: string allOf: – #/definitions/questionnaireStatus description: Status do questionário talentPoolIds: type: array items: type: string description: Ids dos grupos de talentos a serem filtrados employeeIds: type: array items: type: string description: Ids dos colaboradores a serem filtrados page: type: object allOf: – #/definitions/pagination description: Paginação dos dados responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireTrackPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getCareerTeamQuestionnairesTracking: post: description: Retorna uma lista com os nomes dos questionários de carreira para a tela de questionários da equipe tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – isDirect properties: type: string description: Nome do questionário status: type: string allOf: – #/definitions/questionnaireStatus description: Status do questionário employeeIds: type: array items: type: string description: Ids dos colaboradores a serem filtrados isDirect: type: boolean description: Indica se o filtro é para os descendentes diretos ou indiretos page: type: object allOf: – #/definitions/pagination description: Paginação dos dados responses: 200: description: Ok schema: type: object allOf: – #/definitions/careerQuestionnaireTrackPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getTrackCareerQuestionnaireEmployees: post: description: Retorna um DTO paginado dos colaboradores vinculados ao questionário na tela de acompanhamento de questionários enviados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – page properties: questionnaireId: type: string description: Identificador único do questionário talentPoolIds: type: array items: type: string description: Lista de IDs dos grupos de talentos conforme o filtro employeeIds: type: array items: type: string description: Lista de IDs dos colaboradores conforme o filtro page: type: object allOf: – #/definitions/pagination description: Paginação responses: 200: description: Ok schema: type: object allOf: – #/definitions/trackCareerQuestionnaireEmployeesPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getTrackQuestionnaireTeamEmployees: post: description: Retorna um DTO paginado dos colaboradores vinculados ao questionário na tela de questionários da equipe tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – isDirect – page properties: questionnaireId: type: string description: Identificador único do questionário employeeIds: type: array items: type: string description: Lista de IDs dos colaboradores conforme o filtro isDirect: type: boolean description: Indica se o filtro é para os descendentes diretos ou indiretos page: type: object allOf: – #/definitions/pagination description: Paginação responses: 200: description: Ok schema: type: object allOf: – #/definitions/trackCareerQuestionnaireEmployeesPagedDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/queries/getAnswersByQuestionnaireIdAndEmployeeId: post: description: Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – employeeId properties: questionnaireId: type: string description: Identificador do questionário. employeeId: type: string description: Identificador do colaborador. responses: 200: description: Ok schema: type: object allOf: – #/definitions/answeredQuestionnaireOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as respostas de determinado usuário para determinado questionário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: questionnaireId description: Identificador do questionário. in: query required: true type: string – name: employeeId description: Identificador do colaborador. in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/answeredQuestionnaireOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/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 /career_questionnaire/queries/exportTalentPool: 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 /career_questionnaire/queries/exportEmployee: 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 /career_questionnaire/queries/exportPerson: 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 /career_questionnaire/queries/exportTalentPoolEmployee: 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 /career_questionnaire/queries/exportQuestionnaireCareerAnswer: 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 /career_questionnaire/queries/exportTalentPoolQuestionnaire: 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 /career_questionnaire/queries/exportEmployeeQuestionnaire: 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 /career_questionnaire/queries/exportTenantSetting: 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 /career_questionnaire/queries/exportCompany: 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 /career_questionnaire/queries/exportCostCenter: 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 /career_questionnaire/queries/exportUserRole: 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 /career_questionnaire/queries/exportUserRoleCompany: 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 /career_questionnaire/queries/exportUserRoleCostCenter: 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 /career_questionnaire/queries/exportUserRoleWorkstation: 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 /career_questionnaire/queries/exportAttachment: 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 /career_questionnaire/queries/exportHierarchy: 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 /career_questionnaire/queries/exportHierarchyItem: 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 /career_questionnaire/queries/exportWorkstation: 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 /career_questionnaire/queries/exportCompanyHierarchy: 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 /career_questionnaire/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 /career_questionnaire/actions/createOrEditCareerQuestionnaire: post: description: Cria ou edita um questionário de carreira tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/careerQuestionnaireDTO responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/actions/deleteCareerQuestionnaire: post: description: Exclui um questionário de carreira tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId properties: questionnaireId: type: string description: Identificador único do questionário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/actions/employeeQuestionnaireAnswers: post: description: Salva as respostas selecionadas das perguntas do questionário de carreira tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – answers properties: questionnaireId: type: string maxLength: 32 description: Identificador do questionário answers: type: array items: type: object allOf: – #/definitions/answer minimum: 1 description: Respostas do questionário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/actions/reopenQuestionnaire: post: description: Reabre o questionário de carreira para o colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – employeeId properties: questionnaireId: type: string description: Identificador único do questionário employeeId: type: string description: Identificador único do colaborador responses: 200: description: Ok schema: type: object required: – updated properties: updated: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/actions/importTalentPool: 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 /career_questionnaire/actions/importEmployee: 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 /career_questionnaire/actions/importPerson: 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 /career_questionnaire/actions/importTalentPoolEmployee: 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 /career_questionnaire/actions/importQuestionnaireCareerAnswer: 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 /career_questionnaire/actions/importTalentPoolQuestionnaire: 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 /career_questionnaire/actions/importEmployeeQuestionnaire: 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 /career_questionnaire/actions/importTenantSetting: 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 /career_questionnaire/actions/importCompany: 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 /career_questionnaire/actions/importCostCenter: 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 /career_questionnaire/actions/importUserRole: 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 /career_questionnaire/actions/importUserRoleCompany: 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 /career_questionnaire/actions/importUserRoleCostCenter: 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 /career_questionnaire/actions/importUserRoleWorkstation: 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 /career_questionnaire/actions/importAttachment: 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 /career_questionnaire/actions/importHierarchy: 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 /career_questionnaire/actions/importHierarchyItem: 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 /career_questionnaire/actions/importWorkstation: 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 /career_questionnaire/actions/importCompanyHierarchy: 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 /career_questionnaire/signals/batchNotifyTrackCareerQuestionnaireEmployees: post: description: Notifica em lote os colaboradores do questionário conforme os filtros na tela de acompanhamento de questionários de carreira tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – questionnaireId – notificationContent properties: questionnaireId: type: string description: Identificador único do questionário talentPoolIds: type: array items: type: string description: Lista de IDs dos grupos de talentos conforme o filtro employeeIds: type: array items: type: string description: Lista de IDs dos colaboradores conforme o filtro notificationContent: type: string maxLength: 240 description: Conteúdo da notificação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /career_questionnaire/signals/notifyTrackCareerQuestionnaireSelectedEmployees: post: description: Notifica os colaboradores selecionados na tela de acompanhamento de questionários de carreira tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employeeIds – notificationContent properties: employeeIds: type: array items: type: string minimum: 1 description: Lista de IDs dos colaboradores notificationContent: type: string maxLength: 240 description: Conteúdo da notificação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /career_questionnaire/events/importTalentPoolEvent: 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 /career_questionnaire/events/exportTalentPoolEvent: 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 /career_questionnaire/events/importEmployeeEvent: 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 /career_questionnaire/events/exportEmployeeEvent: 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 /career_questionnaire/events/importPersonEvent: 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 /career_questionnaire/events/exportPersonEvent: 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 /career_questionnaire/events/importTalentPoolEmployeeEvent: 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 /career_questionnaire/events/exportTalentPoolEmployeeEvent: 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 /career_questionnaire/events/importQuestionnaireCareerAnswerEvent: 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 /career_questionnaire/events/exportQuestionnaireCareerAnswerEvent: 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 /career_questionnaire/events/importTalentPoolQuestionnaireEvent: 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 /career_questionnaire/events/exportTalentPoolQuestionnaireEvent: 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 /career_questionnaire/events/importEmployeeQuestionnaireEvent: 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 /career_questionnaire/events/exportEmployeeQuestionnaireEvent: 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 /career_questionnaire/events/importTenantSettingEvent: 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 /career_questionnaire/events/exportTenantSettingEvent: 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 /career_questionnaire/events/importCompanyEvent: 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 /career_questionnaire/events/exportCompanyEvent: 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 /career_questionnaire/events/importCostCenterEvent: 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 /career_questionnaire/events/exportCostCenterEvent: 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 /career_questionnaire/events/importUserRoleEvent: 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 /career_questionnaire/events/exportUserRoleEvent: 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 /career_questionnaire/events/importUserRoleCompanyEvent: 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 /career_questionnaire/events/exportUserRoleCompanyEvent: 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 /career_questionnaire/events/importUserRoleCostCenterEvent: 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 /career_questionnaire/events/exportUserRoleCostCenterEvent: 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 /career_questionnaire/events/importUserRoleWorkstationEvent: 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 /career_questionnaire/events/exportUserRoleWorkstationEvent: 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 /career_questionnaire/events/importAttachmentEvent: 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 /career_questionnaire/events/exportAttachmentEvent: 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 /career_questionnaire/events/importHierarchyEvent: 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 /career_questionnaire/events/exportHierarchyEvent: 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 /career_questionnaire/events/importHierarchyItemEvent: 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 /career_questionnaire/events/exportHierarchyItemEvent: 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 /career_questionnaire/events/importWorkstationEvent: 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 /career_questionnaire/events/exportWorkstationEvent: 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 /career_questionnaire/events/importCompanyHierarchyEvent: 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 /career_questionnaire/events/exportCompanyHierarchyEvent: 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 /career_questionnaire/entities/company: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/company/{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/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /career_questionnaire/entities/company/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/attachment: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/attachment responses: 200: description: The created resource schema: #/definitions/attachment 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/attachment responses: 200: description: The created resource schema: #/definitions/attachment 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/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/attachment/{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/editAttachment responses: 200: description: Ok schema: #/definitions/editAttachment 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/attachment responses: 200: description: Ok schema: #/definitions/attachment 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/attachment 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 /career_questionnaire/entities/attachment/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/attachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/hierarchy: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hierarchy responses: 200: description: The created resource schema: #/definitions/hierarchy 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/hierarchy responses: 200: description: The created resource schema: #/definitions/hierarchy 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/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/hierarchy/{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/editHierarchy responses: 200: description: Ok schema: #/definitions/editHierarchy 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/hierarchy responses: 200: description: Ok schema: #/definitions/hierarchy 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/hierarchy 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 /career_questionnaire/entities/hierarchy/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/hierarchy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/workstation/{parentId}/hierarchyItens: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/hierarchyItem responses: 200: description: The created resources schema: type: array items: #/definitions/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/hierarchyItem responses: 200: description: The created resources schema: type: array items: #/definitions/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /career_questionnaire/entities/workstation/{parentId}/hierarchyItens/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editHierarchyItem responses: 200: description: Ok schema: #/definitions/editHierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hierarchyItem responses: 200: description: Ok schema: #/definitions/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim directionType: type: string enum: – ASC – DESC description: Tipo de ordenação: * `ASC` – Ascendente * `DESC` – Descendente questionnaireStatus: type: string enum: – RELEASED – WAITING_RELEASE – DONE description: Status do questionário: * `RELEASED` – Liberado * `WAITING_RELEASE` – Aguardando liberação * `DONE` – Finalizado employeeType: type: string enum: – EMPTY – EMPLOYEE – THIRDPARTY – PARTNER description: Tipo de colaborador: * `EMPTY` – Sem registro * `EMPLOYEE` – Colaborador * `THIRDPARTY` – Terceiro * `PARTNER` – Parceiro groupType: type: string enum: – PERSON – TALENT description: Tipo do grupo de pessoas: * `PERSON` – Tipo pessoa * `TALENT` – Tipo talento groupVisibility: type: string enum: – RH – RH_E_GESTOR description: Visibilidade do grupo de pessoas: * `RH` – Visibilidade somente RH * `RH_E_GESTOR` – Visibilidade RH e Gestor careerQuestionType: type: string enum: – CHECKBOX – RADIO – TEXT – LEVEL description: Tipo da questão: * `CHECKBOX` – Múltipla escolha * `RADIO` – Escolha única * `TEXT` – Texto livre * `LEVEL` – Nota 0 à 10 scopeType: type: string enum: – COMPANY_SCOPE – BRANCH_SCOPE – COSTCENTER_SCOPE description: Tipo de abrangência: * `COMPANY_SCOPE` – Escopo por empresa * `BRANCH_SCOPE` – Escopo por filial * `COSTCENTER_SCOPE` – Escopo por centro de custo courseSituation: type: string enum: – ALL – COMPLETE_ONLY – COMPLETE_AND_IN_PROGRESS description: Situação cursos no calculo da aderência: * `ALL` – Todos * `COMPLETE_ONLY` – Somente Completos * `COMPLETE_AND_IN_PROGRESS` – Completos e em andamento questionnaireAnswerSituation: type: string enum: – NOT_ANSWERED – ANSWERED – REOPENED description: Situação indicando se o questionário foi respondido: * `NOT_ANSWERED` – Não respondido * `ANSWERED` – Respondido * `REOPENED` – Reaberto 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 ordination: description: Dados da ordenação type: object required: – field properties: field: type: string description: Campo que será ordenado order: type: string allOf: – #/definitions/directionType description: Tipo da ordenação paged: description: Retorno paginado discriminator: _discriminator type: object required: – totalElements – numberPages – _discriminator properties: totalElements: type: integer format: int64 description: Indica quantos registros foram encontrados numberPages: type: integer format: int64 description: Indica o número de páginas da consulta (incluindo a atual) _discriminator: type: string description: pagination: description: Dados da paginação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página de inicio size: type: integer format: int64 description: Quantidade de registros por página checkDTO: description: DTO do 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 careerQuestionnaireDTO: description: DTO do questionário de carreira type: object required: – title – orientation – publishDate properties: id: type: string description: Identificador único do questionário type: string maxLength: 200 description: Nome do questionário orientation: type: string maxLength: 4000 description: Orientações para preenchimento do questionário publishDate: type: string format: date description: Data de liberação termDate: type: string format: date description: Data final employeeQuestionnaires: type: array items: type: object allOf: – #/definitions/employeeQuestionnaireDTO description: Colaboradores vinculados ao questionário talentPoolQuestionnaires: type: array items: type: object allOf: – #/definitions/talentPoolQuestionnaireDTO description: Grupos de talentos vinculados ao questionário hasResponse: type: boolean description: Verifica se o questionário possui resposta questions: type: array items: type: object allOf: – #/definitions/careerQuestionDTO description: Contrato das questões careerQuestionnaireStatusDTO: description: Questionário de carreira contendo nome, status e data de publicação type: object required: – id – title properties: id: type: string description: Identificador do questionário type: string description: Nome do questionário publishDate: type: string format: date description: Data de publicação status: type: string allOf: – #/definitions/questionnaireStatus description: Status do questionário hasResponse: type: boolean description: Verifica se o questionário possui resposta questionnaireTrackDTO: description: DTO contendo informações do questionário de carreira para a tela de acompanhamento type: object required: – id – title properties: id: type: string description: Identificador do questionário type: string description: Nome do questionário sentCount: type: integer format: int64 description: Quantidade de questionários enviados answeredCount: type: integer format: int64 description: Quantidade de questionários respondidos notAnsweredCount: type: integer format: int64 description: Quantidade de questionários não respondidos careerQuestionnairesStatusPagedDTO: description: Lista de questionários de carreira paginada allOf: – #/definitions/paged – type: object required: – questionnaires properties: questionnaires: type: array items: type: object allOf: – #/definitions/careerQuestionnaireStatusDTO minimum: 1 description: Lista de questionários de carreira careerQuestionnaireTrackPagedDTO: description: Lista de nomes de questionários de carreira paginada allOf: – #/definitions/paged – type: object required: – questionnaires properties: questionnaires: type: array items: type: object allOf: – #/definitions/questionnaireTrackDTO minimum: 1 description: Lista de nomes de questionários de carreira employeeQuestionnaireDTO: description: DTO do colaborador vinculado ao questionário de carreira type: object required: – employee properties: id: type: string description: Identificador único do vinculo entre colaborador e questionário employee: type: object allOf: – #/definitions/employeeDTO description: Colaborador vinculado questionnaireId: type: string description: Identificador único do questionário employeeDTO: description: DTO do colaborador type: object properties: id: type: string description: Identificador único do colaborador employeeName: type: string description: Nome do colaborador companyNumber: type: integer format: int64 description: Número da empresa registerNumber: type: integer format: int64 description: Número de registro do contrato employeeType: type: string allOf: – #/definitions/employeeType description: Tipo de colaborador talentPoolQuestionnaireDTO: description: DTO do grupo de talentos vinculado ao questionário de carreira type: object required: – talentPool properties: id: type: string description: Identificador único do vinculo entre grupo de talentos e questionário talentPool: type: object allOf: – #/definitions/talentPoolDTO description: Grupo de talentos vinculado questionnaireId: type: string description: Identificador único do questionário talentPoolDTO: description: DTO do grupo de talentos type: object properties: id: type: string description: Identificador único do colaborador name: type: string description: Nome do grupo de talentos careerQuestionnaireEmployeeDTO: description: DTO do colaborador não demitidos type: object properties: id: type: string description: Identificador único do colaborador employeeName: type: string description: Nome completo do colaborador registerNumber: type: integer format: int64 description: Número de registro do contrato careerQuestionnaireEmployeesPagedDTO: description: Lista de colaboradores paginados allOf: – #/definitions/paged – type: object required: – employees properties: employees: type: array items: type: object allOf: – #/definitions/careerQuestionnaireEmployeeDTO minimum: 1 description: Lista de colaboradores talentPoolQuestionnairePagedList: description: allOf: – #/definitions/paged – type: object required: – talentPoolQuestionnaireList properties: talentPoolQuestionnaireList: type: array items: type: object allOf: – #/definitions/talentPool minimum: 1 description: Lista de Questionário de Carreira careerQuestionDTO: description: Contrato da questão do questionário type: object required: – description – required – sequence – type properties: id: type: string description: Identificador description: type: string description: Descrição required: type: boolean description: Indica a obrigatoriedade sequence: type: integer format: int64 description: Sequência de apresentação text: type: string description: Indica se a questão possui resposta em texto type: type: string allOf: – #/definitions/careerQuestionType description: Tipo da questão alternatives: type: array items: type: object allOf: – #/definitions/careerAlternativeDTO description: Alternativas de respostas careerAlternativeDTO: description: Contrato da alternativa da questão type: object required: – description – sequence properties: id: type: string description: Identificador description: type: string description: Descrição sequence: type: integer format: int64 description: Sequência de apresentação checked: type: boolean description: Indica se a alternativa foi assinalada questionnairesPagedDTO: description: Questionários contendo título e orientações allOf: – #/definitions/paged – type: object required: – questionnaires properties: questionnaires: type: array items: type: object allOf: – #/definitions/questionnaireDTO minimum: 1 description: Questionários questionnaireDTO: description: Questionário contendo título e orientações type: object required: – questionnaireId – title – isAnswered properties: questionnaireId: type: string description: Identificador do questionario type: string description: Título do questionário orientation: type: string description: Orientações do questionário isAnswered: type: boolean description: Informa se o questionário foi respondido answer: description: Resposta que será salva no career-questionnaire type: object required: – questionId properties: questionId: type: string maxLength: 32 description: Identificador da questão alternativesId: type: array items: type: string description: Identificador das alternativas text: type: string description: Resposta do tipo texto livre trackCareerQuestionnaireEmployeesPagedDTO: description: Lista paginada dos colaboradores vinculados ao questionário na tela de acompanhamento de questionários enviados allOf: – #/definitions/paged – type: object properties: employees: type: array items: type: object allOf: – #/definitions/trackCareerQuestionnaireEmployeeDTO description: Lista de colaboradores trackCareerQuestionnaireEmployeeDTO: description: DTO do colaborador vinculado ao questionário na tela de acompanhamento de questionários enviados type: object properties: employeeId: type: string description: Identificador único do colaborador employeeName: type: string description: Nome completo do colaborador registerNumber: type: integer format: int64 description: Número de registro do contrato photo: type: string description: Foto do colaborador questionnaireAnswerSituation: type: string allOf: – #/definitions/questionnaireAnswerSituation description: Situação indicando se o questionário foi respondido answeredQuestionnaireOutput: description: Respostas de um questionário type: object required: – id – questions properties: id: type: string description: Identificador do questionário. questions: type: array items: type: object allOf: – #/definitions/answeredQuestion minimum: 1 description: Questões com respostas. answeredQuestion: description: Questões com respostas. type: object required: – id – description – type – sequence – text – level properties: id: type: string description: Identificador único da questão. description: type: string description: Descrição da questão. type: type: string allOf: – #/definitions/careerQuestionType description: Tipo da questão. sequence: type: integer format: int64 description: Sequência em que essa questão deve ser apresentada. alternatives: type: array items: type: object allOf: – #/definitions/answeredAlternative description: Alternativas dessa questão. text: type: string description: Texto respondido quando do tipo texto livre. level: type: integer format: int64 description: Resposta de nível, se for o caso. answeredAlternative: description: Alternativas das questões. type: object required: – id – description – sequence – checked properties: id: type: string description: Identificador único da alternativa. description: type: string description: Descrição da alternativa. sequence: type: integer format: int64 description: Sequência em que essa alternativa deve ser apresentada. checked: type: boolean description: Indica que a alternativa foi selecionada. Quando do tipo única escolha ou escolha livre. talentPool: description: Grupo de talentos. type: object properties: id: type: string description: Identificador único do grupo de talentos. name: type: string description: Nome do grupo de talentos groupType: type: string allOf: – #/definitions/groupType description: Tipo de grupo groupVisibility: type: string allOf: – #/definitions/groupVisibility description: Visibilidade do grupo employee: description: Colaborador. type: object properties: id: type: string description: Identificador único do colaborador. person: type: object allOf: – #/definitions/person description: Relacionamento com a person. hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de demissão do colaborador (Se for o caso) companyNumber: type: integer format: int64 description: Número da empresa registerNumber: type: integer format: int64 description: Número de registro do contrato employeeType: type: string allOf: – #/definitions/employeeType description: Tipo de colaborador costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo employer: type: object allOf: – #/definitions/company description: Empresa person: description: Pessoa type: object required: – firstName – lastName properties: id: type: string description: Identificador único da pessoa firstName: type: string description: Primeiro nome middleName: type: string description: Segundo nome lastName: type: string description: Último nome userName: type: string description: Nome de usuário fullName: type: string description: Nome completo do colab thumbnailAttachment: type: string maxLength: 32 description: Identificador do anexo que contém o thumbnail da foto da pessoa attachment: type: string maxLength: 32 description: Identificador do anexo que contém a foto da pessoa talentPoolEmployee: description: Realiza a ligação entre um colaborador e um grupo de talentos. type: object required: – talentPool – employee properties: id: type: string description: Identificador único da ligação entre um colaborador e um grupo de talentos talentPool: type: object allOf: – #/definitions/talentPool description: Identificador do grupo de talentos. employee: type: object allOf: – #/definitions/employee description: Identificador do colaborador. exclusionDate: type: string format: date-time description: Data em que o colaborador foi removido do grupo. questionnaireCareerAnswer: description: Resposta do questionário de carreira. type: object required: – employee properties: id: type: string description: Identificador único da resposta do questionário de carreira employee: type: object allOf: – #/definitions/employee description: Identificador único do colaborador. answer: type: string description: Identificador único da resposta. resDate: type: string format: date-time description: Data da resposta do questionário questionnaire: type: string description: Identificador único do questionário. talentPoolQuestionnaire: description: Realiza a ligação entre um colaborador e o questionário de carreira. type: object required: – talentPool properties: id: type: string description: Identificador único da ligação entre um colaborador e o questionário de carreira. questionnaire: type: string description: Identificador único do questionário. talentPool: type: object allOf: – #/definitions/talentPool description: Grupo de talentos vinculado ao questionário. employeeQuestionnaire: description: Realiza a ligação entre um grupo de talentos e o questionário de carreira. type: object required: – employee properties: id: type: string description: Identificador único da ligação entre um grupo de talentos e o questionário de carreira. questionnaire: type: string description: Identificador único do questionário. employee: type: object allOf: – #/definitions/employee description: Colaborador vinculado ao questionário. tenantSetting: description: Configurações do tenant type: object required: – visiblePercentageOfAdherence – scopeType properties: id: type: string maxLength: 32 description: Id tenant visiblePercentageOfAdherence: type: boolean description: Visualizar o percentual de aderência situationsForCareerAdherence: type: string allOf: – #/definitions/courseSituation description: Situação dos cursos na aderência scopeType: type: string allOf: – #/definitions/scopeType description: Tipo de abrangência company: description: Empresa type: object required: – id properties: id: type: string description: Identificador único da empresa companyname: type: string description: Nome da empresa headquarter: type: string description: Empresa a qual a filial está ligada code: type: integer format: int64 description: Código da empresa tradingname: type: string description: Nome fantasia. editCompany: type: object required: – id allOf: – #/definitions/company costCenter: description: Centro de custo type: object required: – name – code – company properties: id: type: string maxLength: 32 description: Id do centro de custo name: type: string maxLength: 60 description: Nome code: type: string maxLength: 32 description: Código company: type: object allOf: – #/definitions/company description: Empresa vinculada userRole: description: Papéis do usuário type: object properties: id: type: string maxLength: 32 description: Id papel userRoleCompany: description: Papéis vinculados a empresa type: object required: – company properties: id: type: string maxLength: 32 description: Id do papel company: type: object allOf: – #/definitions/company description: Empresa vinculada userRoleCostCenter: description: Papéis vinculados a centros de custo type: object required: – costCenter properties: id: type: string maxLength: 32 description: Id do papel costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo vinculado userRoleWorkstation: description: Papéis vinculados ao colaborador type: object required: – employee properties: id: type: string maxLength: 32 description: Id do papel employee: type: object allOf: – #/definitions/employee description: Colaborador vinculado attachment: description: Anexo type: object required: – name properties: id: type: string maxLength: 32 description: Identificador único do anexo name: type: string description: Nome do anexo editAttachment: type: object required: – id allOf: – #/definitions/attachment hierarchy: description: Cadastro da hierarquia type: object required: – name properties: id: type: string maxLength: 32 description: Identificador da hierarquia name: type: string description: Nome da hierarquia editHierarchy: type: object required: – id allOf: – #/definitions/hierarchy hierarchyItem: description: Tabela da hierarquia do cargo e líder imediato type: object required: – hierarchy – parent – position properties: id: type: string maxLength: 32 description: Identificador da hierarquia hierarchy: type: string description: Hierarquia workstation: type: object allOf: – #/definitions/workstation description: Identificador do grupo de trabalho parent: type: object allOf: – #/definitions/hierarchyItem description: Identificador do líder imediato position: type: string description: Posicão editHierarchyItem: type: object required: – id allOf: – #/definitions/hierarchyItem workstation: description: Tabela do grupo de trabalho type: object required: – company – occupant properties: id: type: string maxLength: 32 description: ID do grupo de trabalho company: type: string description: Empresa ligada ao grupo de trabalho occupant: type: object allOf: – #/definitions/employee description: Empregado alocado no posto de trabalho hierarchyItens: type: array items: type: object allOf: – #/definitions/hierarchyItem description: hierarquia do cargo e líder companyHierarchy: description: Histórico de projetos type: object required: – company – hierarchy – startdate properties: id: type: string maxLength: 32 description: Identificador do hierarquia da empresa company: type: string description: Empresa hierarchy: type: string description: Hierarquia startdate: type: string format: date description: Data de início 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