hcm_java_compatibility_bridge

2.0info: 0.0.8 hcm_java_compatibility_bridge description: HCM Java Compatibility Bridge x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: hcm_java_compatibility_bridge contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /hcm_java_compatibility_bridge/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/healthcheckDTO 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/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/queries/getWorkstationGroupSubordinatesToActiveEmployee: post: description: Retorna os postos de trabalhos subordinados a um usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getWorkstationGroupSubordinatesToActiveEmployeeDTO responses: 200: description: Ok schema: type: object required: – workstationGroupIds properties: workstationGroupIds: type: array items: type: string minimum: 1 description: Postos de trabalhos subordinados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os postos de trabalhos subordinados a um usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: considerEmployer description: Indica se a empresa empregadora do colaborador associado ao usuário deve ser considera na busca in: query type: boolean – name: onlyDirects description: Considera apenas liderados diretos in: query type: boolean – name: onlyLeaders description: Considera apenas gestores in: query type: boolean – name: returnThemselves description: Considera se deve retornar o próprio posto do colaborador na busca in: query type: boolean responses: 200: description: Ok schema: type: object required: – workstationGroupIds properties: workstationGroupIds: type: array items: type: string minimum: 1 description: Postos de trabalhos subordinados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/queries/listEmployeeContractEvaluations: post: description: Retorna as avaliações de contrato de um colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Filtro a ser aplicado na consulta responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/employeeContractEvaluationDTO minimum: 1 description: Lista de avaliações de contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as avaliações de contrato de um colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro a ser aplicado na consulta in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/employeeContractEvaluationDTO minimum: 1 description: Lista de avaliações de contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/queries/generateContentIA: post: description: Realiza a geração de conteúdo customizado pela inteligência artificial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – prompt properties: prompt: type: string description: Prompt customizado que guiara a inteligência artificial. responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a geração de conteúdo customizado pela inteligência artificial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: prompt description: Prompt customizado que guiara a inteligência artificial. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/queries/getEmployee: post: description: Busca dados de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Tamanho da página offset: type: integer format: int64 description: Número da página displayFields: type: string description: Campos a serem exibidos filter: type: string description: Filtro a ser aplicado na consulta orderBy: type: string description: Ordenação a ser aplicada na consulta responses: 200: description: Ok schema: type: object allOf: – #/definitions/employeeResponsePaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca dados de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Tamanho da página in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: displayFields description: Campos a serem exibidos in: query type: string – name: filter description: Filtro a ser aplicado na consulta in: query type: string – name: orderBy description: Ordenação a ser aplicada na consulta in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/employeeResponsePaged 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hcm_java_compatibility_bridge/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 /hcm_java_compatibility_bridge/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/genericErrordefinitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim contractType: type: string enum: – EMPLOYEE – MANAGER – FARM_WORKER – RETIRED – TRAINEE – APRENDIZ – FIXED_DUE_DATE – RETIRED_MANAGER – PUBLIC_AGENT – TEACHER – COOPERATIVE_WORKER – DOMESTIC_WORKER – TEACHER_FIXED_DUE_DATE – THIRD_PARTY description: Tipo de Contrato: * `EMPLOYEE` – Colaborador/Empregado * `MANAGER` – Gestor * `FARM_WORKER` – Trabalhador Rural * `RETIRED` – Aposentado * `TRAINEE` – Estagiário * `APRENDIZ` – Aprendiz * `FIXED_DUE_DATE` – Data de Vencimento * `RETIRED_MANAGER` – Gerente Aposentado * `PUBLIC_AGENT` – Funcionário Público * `TEACHER` – Professor * `COOPERATIVE_WORKER` – Trabalhador Cooperativo * `DOMESTIC_WORKER` – Doméstico * `TEACHER_FIXED_DUE_DATE` – Professor com Data fixa * `THIRD_PARTY` – Terceiro employeeType: type: string enum: – EMPLOYEE – THIRDPARTY – PARTNER description: Tipo colaborador: * `EMPLOYEE` – Colaborador * `THIRDPARTY` – Terceiro * `PARTNER` – Parceiro employmentRelationshipType: type: string enum: – EMPREGADO_GERAL – EMPREGADO_TRABALHADOR_RURAL_POR_PEQUENO_PRAZO_DA_LEI_11_718_2008 – EMPREGADO_APRENDIZ – EMPREGADO_DOMESTICO – EMPREGADO_CONTRATO_A_TERMO_FIRMADO_NOS_TERMOS_DA_LEI_9601_98 – TRABALHADOR_TEMPORARIO_CONTRATO_NOS_TERMOS_DA_LEI_6019_74 – EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_SEM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS – EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_COM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS – EMPREGADO_CONTRATO_DE_TRABALHO_INTERMITENTE – TRABALHADOR_AVULSO_PORTUARIO – TRABALHADOR_AVULSO_NAO_PORTUARIO – SERVIDOR_PUBLICO_TITULAR_DE_CARGO_EFETIVO_MAGISTRADO_MINISTRO_DE_TRIBUNAL_DE_CONTAS_CONSELHEIRO_DE_TRIBUNAL_CONTAS_E_MEMBRO_DO_MINISTERIO_PUBLICO – SERVIDOR_PUBLICO_OCUPANTE_DE_CARGO_EXCLUSIVO_EM_COMISSAO – EXERCENTE_DE_MANDATO_ELETIVO – SERVIDOR_PUBLICO_EXERCENTE_DE_MANDATO_ELETIVO_INCLUSIVE_COM_EXERCICIO_DE_CARGO_EM_COMISSAO – SERVIDOR_PUBLICO_INDICADO_PARA_CONSELHO_OU_ORGAO_REPRESENTATIVO_NA_CONDICAO_DE_REPRESENTANTE_DO_GOVERNO_ORGAO_OU_ENTIDADE_DA_ADMINISTRACAO_PUBLICA – SERVIDOR_PUBLICO_CONTRATADO_POR_TEMPO_DETERMINADO_SUJEITO_A_REGIME_ADMINISTRATIVO_ESPECIAL_DEFINIDO_EM_LEI_PROPRIA – MILITAR – CONSCRITO – AGENTE_PUBLICO_OUTROS – SERVIDOR_PUBLICO_EVENTUAL – MINISTROS_JUIZES_PROCURADORES_PROMOTORES_OU_OFICIAIS_DE_JUSTICA_A_DISPOSICAO_DA_JUSTICA_ELEITORAL – AUXILIAR_LOCAL – SERVIDOR_PUBLICO_EXERCENTE_DE_ATIVIDADE_DE_INSTRUTORIA_CAPACITACAO_TREINAMENTO_CURSO_OU_CONCURSO_OU_CONVOCADO_PARA_PARECERES_TECNICOS_OU_DEPOIMENTOS – DIRIGENTE_SINDICAL_INFORMACAO_PRESTADA_PELO_SINDICATO – TRABALHADOR_CEDIDO_EXERCICIO_EM_OUTRO_ORGAO_JUIZ_AUXILIAR_INFORMACAO_PRESTADA_PELO_CESSIONARIO_DESTINO – CONTRIBUINTE_INDIVIDUAL_AUTONOMO_EM_GERAL_EXCETO_SE_ENQUADRADO_EM_UMA_DAS_DEMAIS_CATEGORIAS_DE_CONTRIBUINTE_INDIVIDUAL – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_PASSAGEIROS – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_CARGA – CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_COM_FGTS – CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_SEM_FGTS – CONTRIBUINTE_INDIVIDUAL_EMPRESARIOS_SOCIOS_E_MEMBRO_DE_CONSELHO_DE_ADMINISTRACAO_OU_FISCAL – CONTRIBUINTE_INDIVIDUAL_COOPERADO_QUE_PRESTA_SERVICOS_A_EMPRESA_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_COOPERADO_QUE_PRESTA_SERVICOS_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO – CONTRIBUINTE_INDIVIDUAL_COOPERADO_FILIADO_A_COOPERATIVA_DE_PRODUCAO – CONTRIBUINTE_INDIVIDUAL_MICRO_EMPREENDEDOR_INDIVIDUAL – CONTRIBUINTE_INDIVIDUAL_MAGISTRADO_CLASSISTA_TEMPORARIO_DA_JUSTICA_DO_TRABALHO_OU_DA_JUSTICA_ELEITORAL_QUE_SEJA_APOSENTADO_DE_QUALQUER_REGIME_PREVIDENCIARIO – CONTRIBUINTE_INDIVIDUAL_ASSOCIADO_ELEITO_PARA_DIRECAO_DE_COOPERATIVA_ASSOCIACAO_OU_ENTIDADE_DE_CLASSE_DE_QUALQUER_NATUREZA_OU_FINALIDADE_BEM_COMO_O_SINDICO_OU_ADM_DESDE_QUE_RECEBAM_REMUNERACAO – CONTRIBUINTE_INDIVIDUAL_MEMBRO_DE_CONSELHO_TUTELAR_NOS_TERMOS_DA_LEI_N_8_069_DE_13_DE_JULHO_DE_1990 – MINISTRO_DE_CONFISSAO_RELIGIOSA_OU_MEMBRO_DE_VIDA_CONSAGRADA_DE_CONGREGACAO_OU_DE_ORDEM_RELIGIOSA – ESTAGIARIO – MEDICO_RESIDENTE – BOLSISTA_NOS_TERMOS_DA_LEI_8958_1994 – PARTICIPANTE_DE_CURSO_DE_FORMACAO_COMO_ETAPA_DE_CONCURSO_PUBLICO_SEM_VINCULO_DE_EMPREGO_ESTATUTARIO – ATLETA_NAO_PROFISSIONAL_EM_FORMACAO_QUE_RECEBA_BOLSA – BENEFICIARIO_ENTE_PUBLICO – BENEFICIARIO_ENTE_PUBLICO_SOMENTE_CADASTRO_BENEFICIO – DEMITIDO_COM_DATA_ANTERIOR_A_SUCESSAO_CATEGORIA_EXCLUSIVA_SENIOR – NAO_SE_APLICA description: Tipo relacionamento do colaborador: * `EMPREGADO_GERAL` – Empregado geral * `EMPREGADO_TRABALHADOR_RURAL_POR_PEQUENO_PRAZO_DA_LEI_11_718_2008` – Empregado trabalhador rural por pequeno prazo da lei 11 718 2008 * `EMPREGADO_APRENDIZ` – Empregado aprendiz * `EMPREGADO_DOMESTICO` – Empregado domestico * `EMPREGADO_CONTRATO_A_TERMO_FIRMADO_NOS_TERMOS_DA_LEI_9601_98` – Empregado contrato a termo firmado nos termos da lei 9601 98 * `TRABALHADOR_TEMPORARIO_CONTRATO_NOS_TERMOS_DA_LEI_6019_74` – Trabalhador temporario contrato nos termos da lei 6019 74 * `EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_SEM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS` – Empregado contrato de trabalho verde e amarelo sem acordo para antecipacao mensal da multa rescisoria do fgts * `EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_COM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS` – Empregado contrato de trabalho verde e amarelo com acordo para antecipacao mensal da multa rescisoria do fgts * `EMPREGADO_CONTRATO_DE_TRABALHO_INTERMITENTE` – Empregado contrato de trabalho intermitente * `TRABALHADOR_AVULSO_PORTUARIO` – Trabalhador avulso portuario * `TRABALHADOR_AVULSO_NAO_PORTUARIO` – Trabalhador avulso nao portuario * `SERVIDOR_PUBLICO_TITULAR_DE_CARGO_EFETIVO_MAGISTRADO_MINISTRO_DE_TRIBUNAL_DE_CONTAS_CONSELHEIRO_DE_TRIBUNAL_CONTAS_E_MEMBRO_DO_MINISTERIO_PUBLICO` – Servidor publico titular de cargo efetivo magistrado ministro de tribunal de contas conselheiro de tribunal contas e membro do ministerio publico * `SERVIDOR_PUBLICO_OCUPANTE_DE_CARGO_EXCLUSIVO_EM_COMISSAO` – Servidor publico ocupante de cargo exclusivo em comissao * `EXERCENTE_DE_MANDATO_ELETIVO` – Exercente de mandato eletivo * `SERVIDOR_PUBLICO_EXERCENTE_DE_MANDATO_ELETIVO_INCLUSIVE_COM_EXERCICIO_DE_CARGO_EM_COMISSAO` – Servidor publico exercente de mandato eletivo inclusive com exercicio de cargo em comissao * `SERVIDOR_PUBLICO_INDICADO_PARA_CONSELHO_OU_ORGAO_REPRESENTATIVO_NA_CONDICAO_DE_REPRESENTANTE_DO_GOVERNO_ORGAO_OU_ENTIDADE_DA_ADMINISTRACAO_PUBLICA` – Servidor publico indicado para conselho ou orgao representativo na condicao de representante do governo orgao ou entidade da administracao publica * `SERVIDOR_PUBLICO_CONTRATADO_POR_TEMPO_DETERMINADO_SUJEITO_A_REGIME_ADMINISTRATIVO_ESPECIAL_DEFINIDO_EM_LEI_PROPRIA` – Servidor publico contratado por tempo determinado sujeito a regime administrativo especial definido em lei propria * `MILITAR` – Militar * `CONSCRITO` – Conscrito * `AGENTE_PUBLICO_OUTROS` – Agente publico outros * `SERVIDOR_PUBLICO_EVENTUAL` – Servidor publico eventual * `MINISTROS_JUIZES_PROCURADORES_PROMOTORES_OU_OFICIAIS_DE_JUSTICA_A_DISPOSICAO_DA_JUSTICA_ELEITORAL` – Ministros juizes procuradores promotores ou oficiais de justica a disposicao da justica eleitoral * `AUXILIAR_LOCAL` – Auxiliar local * `SERVIDOR_PUBLICO_EXERCENTE_DE_ATIVIDADE_DE_INSTRUTORIA_CAPACITACAO_TREINAMENTO_CURSO_OU_CONCURSO_OU_CONVOCADO_PARA_PARECERES_TECNICOS_OU_DEPOIMENTOS` – Servidor publico exercente de atividade de instrutoria capacitacao treinamento curso ou concurso ou convocado para pareceres tecnicos ou depoimentos * `DIRIGENTE_SINDICAL_INFORMACAO_PRESTADA_PELO_SINDICATO` – Dirigente sindical informacao prestada pelo sindicato * `TRABALHADOR_CEDIDO_EXERCICIO_EM_OUTRO_ORGAO_JUIZ_AUXILIAR_INFORMACAO_PRESTADA_PELO_CESSIONARIO_DESTINO` – Trabalhador cedido exercicio em outro orgao juiz auxiliar informacao prestada pelo cessionario destino * `CONTRIBUINTE_INDIVIDUAL_AUTONOMO_EM_GERAL_EXCETO_SE_ENQUADRADO_EM_UMA_DAS_DEMAIS_CATEGORIAS_DE_CONTRIBUINTE_INDIVIDUAL` – Contribuinte individual autonomo em geral exceto se enquadrado em uma das demais categorias de contribuinte individual * `CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_PASSAGEIROS` – Contribuinte individual transportador autonomo de passageiros * `CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_CARGA` – Contribuinte individual transportador autonomo de carga * `CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_COM_FGTS` – Contribuinte individual diretor nao empregado com fgts * `CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_SEM_FGTS` – Contribuinte individual diretor nao empregado sem fgts * `CONTRIBUINTE_INDIVIDUAL_EMPRESARIOS_SOCIOS_E_MEMBRO_DE_CONSELHO_DE_ADMINISTRACAO_OU_FISCAL` – Contribuinte individual empresarios socios e membro de conselho de administracao ou fiscal * `CONTRIBUINTE_INDIVIDUAL_COOPERADO_QUE_PRESTA_SERVICOS_A_EMPRESA_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO` – Contribuinte individual cooperado que presta servicos a empresa por intermedio de cooperativa de trabalho * `CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_COOPERADO_QUE_PRESTA_SERVICOS_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO` – Contribuinte individual transportador cooperado que presta servicos por intermedio de cooperativa de trabalho * `CONTRIBUINTE_INDIVIDUAL_COOPERADO_FILIADO_A_COOPERATIVA_DE_PRODUCAO` – Contribuinte individual cooperado filiado a cooperativa de producao * `CONTRIBUINTE_INDIVIDUAL_MICRO_EMPREENDEDOR_INDIVIDUAL` – Contribuinte individual micro empreendedor individual * `CONTRIBUINTE_INDIVIDUAL_MAGISTRADO_CLASSISTA_TEMPORARIO_DA_JUSTICA_DO_TRABALHO_OU_DA_JUSTICA_ELEITORAL_QUE_SEJA_APOSENTADO_DE_QUALQUER_REGIME_PREVIDENCIARIO` – Contribuinte individual magistrado classista temporario da justica do trabalho ou da justica eleitoral que seja aposentado de qualquer regime previdenciario * `CONTRIBUINTE_INDIVIDUAL_ASSOCIADO_ELEITO_PARA_DIRECAO_DE_COOPERATIVA_ASSOCIACAO_OU_ENTIDADE_DE_CLASSE_DE_QUALQUER_NATUREZA_OU_FINALIDADE_BEM_COMO_O_SINDICO_OU_ADM_DESDE_QUE_RECEBAM_REMUNERACAO` – Contribuinte individual associado eleito para direcao de cooperativa associacao ou entidade de classe de qualquer natureza ou finalidade bem como o sindico ou adm desde que recebam remuneracao * `CONTRIBUINTE_INDIVIDUAL_MEMBRO_DE_CONSELHO_TUTELAR_NOS_TERMOS_DA_LEI_N_8_069_DE_13_DE_JULHO_DE_1990` – Contribuinte individual membro de conselho tutelar nos termos da lei n 8 069 de 13 de julho de 1990 * `MINISTRO_DE_CONFISSAO_RELIGIOSA_OU_MEMBRO_DE_VIDA_CONSAGRADA_DE_CONGREGACAO_OU_DE_ORDEM_RELIGIOSA` – Ministro de confissao religiosa ou membro de vida consagrada de congregacao ou de ordem religiosa * `ESTAGIARIO` – Estagiario * `MEDICO_RESIDENTE` – Medico residente * `BOLSISTA_NOS_TERMOS_DA_LEI_8958_1994` – Bolsista nos termos da lei 8958 1994 * `PARTICIPANTE_DE_CURSO_DE_FORMACAO_COMO_ETAPA_DE_CONCURSO_PUBLICO_SEM_VINCULO_DE_EMPREGO_ESTATUTARIO` – Participante de curso de formacao como etapa de concurso publico sem vinculo de emprego estatutario * `ATLETA_NAO_PROFISSIONAL_EM_FORMACAO_QUE_RECEBA_BOLSA` – Atleta nao profissional em formacao que receba bolsa * `BENEFICIARIO_ENTE_PUBLICO` – Beneficiario ente publico * `BENEFICIARIO_ENTE_PUBLICO_SOMENTE_CADASTRO_BENEFICIO` – Beneficiario ente publico somente cadastro beneficio * `DEMITIDO_COM_DATA_ANTERIOR_A_SUCESSAO_CATEGORIA_EXCLUSIVA_SENIOR` – Demitido com data anterior a sucessao categoria exclusiva senior * `NAO_SE_APLICA` – Nao se aplica companyType: type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVE – DOMESTIC_WORKER – EMPLOYER_ESOCIAL genderType: type: string enum: – MALE – FEMALE description: Gênero da pessoa.: * `MALE` – Masculino * `FEMALE` – Feminino maritalStatusType: type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – CONCUBINAGE – SEPARATED – STABLE_UNION – OTHER description: Estado civil: * `SINGLE` – Solteiro * `MARRIED` – Casado * `DIVORCED` – Divociado * `WIDOWER` – Viúvo * `CONCUBINAGE` – Coabitação * `SEPARATED` – Separado * `STABLE_UNION` – União Estável * `OTHER` – Outros racialType: type: string enum: – NOT_INFORMED – WHITE – BLACK – BROWN – YELLOW – INDIAN description: Raça: * `NOT_INFORMED` – Não informado * `WHITE` – Branco/Caucasiano * `BLACK` – Preto * `BROWN` – Marrom/Castanho * `YELLOW` – Amarelo * `INDIAN` – Indígena emailType: type: string enum: – PERSONAL – PROFESSIONAL phoneContactType: type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – OTHER description: Tipo Contato Telefone: * `PERSONAL` – Pessoal/Residencial * `PROFESSIONAL` – Comercial/Profissional * `MOBILE` – Celular * `BUSINESS_FAX` – Fax Comercial/Profissional * `PERSONAL_FAX` – Fax Pessoal/Residencial * `OTHER` – Outro tipo de telefone para contato disabilityType: type: string enum: – PHYSICAL – HEARING – VISUAL – MENTAL – INTELLECTUAL – OTHER description: Tipo de deficiência: * `PHYSICAL` – Física * `HEARING` – Audição * `VISUAL` – Visual * `MENTAL` – Mental * `INTELLECTUAL` – Intelectual * `OTHER` – Outra stabilityType: type: string enum: – NOT_STABLE – ELECTED_CIPA – WORK_ACCIDENT – MATERNITY_ASSISTANCE – MILITARY_SERVICE – UNION_MANDATE – GOVERNMENT_EMPLOYEE – RETURN_HOLIDAYS – SICK_PAY – NEAR_RETIREMENT – COLLECTIVE_AGREEMENT – PREVIOUS_TIME_FGTS_OPTION – NOT_OPTING_FGTS – CIPA_EMPLOYER – MEMBER_OF_COMISSION_FOR_PRIOR_CONCILIATION – MEMBER_OF_FGTS_CURATOR_COUNCIL – MEMBER_OF_NATIONAL_COUNCIL_OF_SOCIAL_SECURITY – EDUCATION_AID – CONSUMER_COOPERATIVE – CREDIT_UNION – PERSON_WITH_DISABILITY – COOPERATIVE_OF_SYNDICATE – CIPATR – PATERNITY_LEAVE – ELECTORAL_MANDATE – CIPA_CANDIDATE – ELECT_ALTERNATE_CIPA – OTHER – ELECTED_EMPLOYEE_REPRESENTATIVES_COMMITTEE – JOURNEY_REDUCTION_COVID_19_25_50 – JOURNEY_REDUCTION_COVID_19_50_70 – JOURNEY_REDUCTION_COVID_19_70 – TEMPORARY_SUSPENSION_COVID_19 – GESTATION_PERIOD description: Tipo de estabilidade: * `NOT_STABLE` – Não estável * `ELECTED_CIPA` – Membro da CIPA * `WORK_ACCIDENT` – Acidente de trabalho * `MATERNITY_ASSISTANCE` – Auxílio maternidade * `MILITARY_SERVICE` – Serviço militar * `UNION_MANDATE` – Mandato da União * `GOVERNMENT_EMPLOYEE` – Funcionário público * `RETURN_HOLIDAYS` – Feriados de retorno * `SICK_PAY` – Auxílio doença * `NEAR_RETIREMENT` – Próximo da aposentádoria * `COLLECTIVE_AGREEMENT` – Acordo coletivo * `PREVIOUS_TIME_FGTS_OPTION` – Opção anterior do FGTS * `NOT_OPTING_FGTS` – Não optado por FGTS * `CIPA_EMPLOYER` – Empregador da CIPA * `MEMBER_OF_COMISSION_FOR_PRIOR_CONCILIATION` – Membro da comissão de conciliação prévia * `MEMBER_OF_FGTS_CURATOR_COUNCIL` – Membro de conselho do FGTS * `MEMBER_OF_NATIONAL_COUNCIL_OF_SOCIAL_SECURITY` – Membro do conselho nacional de segurança social * `EDUCATION_AID` – Auxílio educação * `CONSUMER_COOPERATIVE` – Cooperativa de consumidores * `CREDIT_UNION` – Cooperativa de crédito * `PERSON_WITH_DISABILITY` – Pessoa com deficiência * `COOPERATIVE_OF_SYNDICATE` – Cooperativa de sindicato * `CIPATR` – CIPATR * `PATERNITY_LEAVE` – Licença de paternidade * `ELECTORAL_MANDATE` – Mandato eleitoral * `CIPA_CANDIDATE` – Candidato da CIPA * `ELECT_ALTERNATE_CIPA` – Suplente da CIPA * `OTHER` – Outro * `ELECTED_EMPLOYEE_REPRESENTATIVES_COMMITTEE` – Eleito na Comissão de Representantes dos Empregados * `JOURNEY_REDUCTION_COVID_19_25_50` – Redução de Jornada (COVID-19) = ou 25% e 50% * `JOURNEY_REDUCTION_COVID_19_50_70` – Redução de Jornada (COVID-19) = ou 50% e 70% * `JOURNEY_REDUCTION_COVID_19_70` – Redução de Jornada (COVID-19) = ou 70% * `TEMPORARY_SUSPENSION_COVID_19` – Suspensão Temporária (COVID-19) * `GESTATION_PERIOD` – Período da Gestação 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Nome do status getWorkstationGroupSubordinatesToActiveEmployeeDTO: description: DTO da primitiva getWorkstationGroupSubordinatesToActiveEmployee type: object properties: considerEmployer: type: boolean description: Indica se a empresa empregadora do colaborador associado ao usuário deve ser considera na busca default: true onlyDirects: type: boolean description: Considera apenas liderados diretos default: true onlyLeaders: type: boolean description: Considera apenas gestores default: false returnThemselves: type: boolean description: Considera se deve retornar o próprio posto do colaborador na busca default: false employeeContractEvaluationDTO: description: DTO de retorno da primitiva listEmployeeContractEvaluations type: object required: – evaluatorName – evaluationStatus – evaluationDate – evaluationLimitDate properties: evaluatorName: type: string description: Nome do avaliador evaluationStatus: type: string description: Status da avaliação evaluationDate: type: string format: date description: Data da avaliação evaluationLimitDate: type: string format: date description: Data limite da avaliação employeeResponsePaged: description: Retorno paginado da primitiva getEmployee type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Indica quantos registros foram encontrados totalPages: type: integer format: int64 description: Indica o número de páginas da consulta (incluindo a atual) contents: type: array items: type: object allOf: – #/definitions/employeeResponse minimum: 1 description: Colaboradores encontrados employeeResponse: description: Colaborador type: object required: – contractType – hireDate – dismissalDate – employeeType – employmentrelationshiptype – jobPosition – department – costCenter – workShift – workstation properties: id: type: string maxLength: 32 description: ID do Colaborador contractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato do colaborador hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de demissão employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador registerNumber: type: integer format: int64 description: Número da matrícula na G5 (numcad) employmentrelationshiptype: type: string allOf: – #/definitions/employmentRelationshipType description: Tipo de relação de colaborador jobPosition: type: object allOf: – #/definitions/jobPositionRecord description: Cargo department: type: object allOf: – #/definitions/departmentRecord description: Departamento costCenter: type: object allOf: – #/definitions/costCenterRecord description: Centro de Custo workShift: type: object allOf: – #/definitions/workShiftRecord description: Turno de trabalho employer: type: object allOf: – #/definitions/companyRecord description: Empregador person: type: object allOf: – #/definitions/personRecord description: Dados da pessoa vinculada ao colaborador phoneContact: type: array items: type: object allOf: – #/definitions/phoneContactRecord description: Contato telefônico emails: type: array items: type: object allOf: – #/definitions/employeeEmailRecord description: Emails vinculado ao colaborador workstation: type: object allOf: – #/definitions/workstationRecord description: Posto de trabalho historicStability: type: array items: type: object allOf: – #/definitions/historicStabilityRecord description: Histórico de estabilidade jobPositionRecord: description: Cargo de trabalho type: object required: – codcar properties: id: type: string maxLength: 32 description: ID do Cargo name: type: string description: Nome do cargo codcar: type: string description: Código do Cargo departmentRecord: description: departamento type: object properties: id: type: string maxLength: 32 description: ID Departamento tableCode: type: integer format: int64 description: Tabela de organograma position: type: string description: Posição address: type: object allOf: – #/definitions/addressRecord description: Endereço code: type: string description: Código G5 do departamento/local (codloc) name: type: string description: Nome do departamento creationDate: type: string format: date description: Data de criação expirationDate: type: string format: date description: Data de expiração historicExpirationDate: type: string format: date description: Histórico data de expiração addressRecord: description: Endereço type: object required: – additional – neighborhood – address – city properties: id: type: string maxLength: 32 description: ID do endereço additional: type: string maxLength: 255 description: Informação adicional referente ao endereço. (e.g. Número do apartamento, Bloco do residencial, Ponto de referência) neighborhood: type: string maxLength: 255 description: Bairro/Distrito a qual pertence este endereço address: type: string maxLength: 255 description: Logradouro/Rua a qual pertence este endereço city: type: object allOf: – #/definitions/cityRecord description: Cidade a qual pertence este endereço cityRecord: description: Cidade type: object required: – name – state – code properties: id: type: string maxLength: 32 description: ID da Cidade name: type: string maxLength: 255 description: Nome da Cidade state: type: object allOf: – #/definitions/stateRecord description: Estado code: type: integer format: int64 description: Código G5 stateRecord: description: Estado type: object required: – abbreviation – name – code properties: id: type: string maxLength: 32 description: ID do Estado abbreviation: type: string description: Sigla name: type: string description: Nome do Estado code: type: integer format: int64 description: Código G5 costCenterRecord: description: Centro de Custo type: object required: – codccu properties: id: type: string maxLength: 32 description: ID da entidade name: type: string description: Nome do centro de custo codccu: type: string description: Código do centro de custo descriptionCode: type: string description: Descrição do código creationDate: type: string format: date description: Data de criação expirationDate: type: string format: date description: Data de expiração company: type: object allOf: – #/definitions/companyRecord description: Empresa companyRecord: description: Empresa type: object properties: id: type: string maxLength: 32 description: ID da empresa numemp: type: integer format: int64 description: Código da empresa tradingName: type: string description: Nome Social companyName: type: string description: Nome da Empresa cnpj: type: string description: CNPJ companyType: type: string allOf: – #/definitions/companyType description: Tipo da empresa cnae: type: string description: CNAE da empresa address: type: object allOf: – #/definitions/addressRecord description: Endereço da empresa headquarter: type: object allOf: – #/definitions/companyRecord description: Matriz workShiftRecord: description: turno de trabalho type: object required: – name – codesc – workload properties: id: type: string maxLength: 32 description: ID do turno name: type: string description: Descrição do turno codesc: type: integer format: int64 description: Código do turno workload: type: integer format: int64 description: Carga horária do turno (em min/mês) personRecord: description: Pessoa type: object required: – firstname – lastname – socialName – nickname – fullName – gender – maritalstatus – race – ethnicity – nationality – naturality – educationDegree properties: id: type: string maxLength: 32 description: ID da Pessoa firstname: type: string description: Primeiro nome da pessoa middlename: type: string description: Segundo nome da pessoa lastname: type: string description: Último nome da pessoa (Sobrenome) socialName: type: string description: Nome social nickname: type: string description: Apelido da pessoa fullName: type: string description: Nome completo birthday: type: string format: date description: Data de nascimento da pessoa gender: type: string allOf: – #/definitions/genderType description: Gênero da pessoa (Sexo) maritalstatus: type: string allOf: – #/definitions/maritalStatusType description: Estado Cívil da Pessoa race: type: string allOf: – #/definitions/racialType description: Raça ethnicity: type: object allOf: – #/definitions/ethnicityRecord description: Raça/Etnia cpf: type: string maxLength: 32 description: CPF (Cadastro de Pessoas Físicas) da pessoa nis: type: array items: type: object allOf: – #/definitions/nisRecord description: Programa Integração Social (pis) emails: type: array items: type: object allOf: – #/definitions/emailRecord description: E-mails da pessoa nationality: type: object allOf: – #/definitions/nationalityRecord description: Nacionalidade naturality: type: object allOf: – #/definitions/cityRecord description: Naturalidade educationDegree: type: object allOf: – #/definitions/educationDegreeRecord description: Grau de instrução da pessoa phoneContact: type: array items: type: object allOf: – #/definitions/phoneContactRecord description: Contato telefônico address: type: array items: type: object allOf: – #/definitions/addressRecord description: ID do endereço da pessoa disabilities: type: array items: type: object allOf: – #/definitions/personDisabilityRecord description: Deficiências ethnicityRecord: description: Raça/Etnia type: object required: – id – name – code properties: id: type: string maxLength: 32 description: Identificador da etnia name: type: string description: Nome da etnia code: type: integer format: int64 description: código de etnia nisRecord: description: Programa Integração Social (pis) type: object properties: id: type: string maxLength: 32 description: Id do documento number: type: string description: Número do documento registrationDate: type: string format: date description: Data de registro do documento emailRecord: description: Email da pessoa type: object required: – email – emailType properties: id: type: string maxLength: 32 description: ID do email email: type: string description: Email da pessoa emailType: type: string allOf: – #/definitions/emailType description: Tipo de email nationalityRecord: description: Nacionalidade type: object properties: id: type: string maxLength: 32 description: ID Nacionalidade name: type: string description: Nome Nacionalidade code: type: integer format: int64 description: Código G5 educationDegreeRecord: description: Grau de Educação type: object properties: id: type: string maxLength: 32 description: ID grau de educação name: type: string maxLength: 255 description: Nome Grau de Educação code: type: integer format: int64 description: Código de Grau de Instrução phoneContactRecord: description: TelefoneContato type: object required: – carrier – countryCode – localCode – number – extention – phoneContactType properties: id: type: string maxLength: 32 description: ID do telefone de contato carrier: type: string description: Operador countryCode: type: integer format: int64 description: Código do País localCode: type: integer format: int64 description: DDD number: type: string description: Número extention: type: string description: extensão phoneContactType: type: string allOf: – #/definitions/phoneContactType description: tipo do contato personDisabilityRecord: description: PessoaDeficiencia type: object required: – disability – mainDisability – isRehabilitated – dateWhen properties: id: type: string maxLength: 32 description: ID da entidade disability: type: object allOf: – #/definitions/disabilityRecord description: Dados da deficiência mainDisability: type: boolean description: Deficiência principal isRehabilitated: type: boolean description: é uma pessoa reabilitada dateWhen: type: string format: date description: Data da deficiência disabilityRecord: description: Deficiências type: object required: – code – name – type properties: id: type: string maxLength: 32 description: ID da entidade code: type: integer format: int64 description: Código da deficiência name: type: string description: Nome da deficiência type: type: string allOf: – #/definitions/disabilityType description: Tipo da deficiência employeeEmailRecord: description: Email colaborador type: object required: – id – email properties: id: type: string maxLength: 32 description: ID do email email: type: string description: E-mail da pessoal vinculada workstationRecord: description: Posto de trabalho type: object required: – id – workstationGroup properties: id: type: string maxLength: 32 description: ID da entidade workstationGroup: type: object allOf: – #/definitions/workstationGroupRecord description: Grupo de postos de trabalho hierarchyItem: type: object allOf: – #/definitions/hierarchyItemRecord description: Item da hierarquia do posto workstationGroupRecord: description: Grupo posto trabalho type: object required: – id – postra properties: id: type: string maxLength: 32 description: ID da entidade name: type: string description: Nome do grupo de trabalho postra: type: string description: Código do posto de Trabalho hierarchyItemRecord: description: Item Hierarquia type: object required: – id – parent properties: id: type: string maxLength: 32 description: ID do item parent: type: object allOf: – #/definitions/hierarchyItemRecord description: Superior historicStabilityRecord: description: Histórico de estabilidade type: object required: – id – startDate – endDate – stabilityType properties: id: type: string maxLength: 32 description: Identificador do histórico de estabilidade startDate: type: string format: date description: Data de início da estabilidade endDate: type: string format: date description: Data final da estabilidade stabilityType: type: string allOf: – #/definitions/stabilityType description: Tipo de estabilidade 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. 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