2.0info: 3.57.0 Integration Backend description: Serviço de integração HCM x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: integration 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: /integration/queries/isIntegrationFileFinished: post: description: Retorna se a integração via arquivo foi finalizada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processName – batchQuantity – dateWhen properties: processName: type: string description: Nome do processo batchQuantity: type: integer format: int64 description: Quantidade de lotes da integração dateWhen: type: string format: date-time description: Data/hora de inicio responses: 200: description: Ok schema: type: object required: – isFinished – fileIds properties: isFinished: type: boolean description: Indica se a integração foi finalizada fileIds: type: array items: type: string minimum: 1 description: Lista com o file_id dos arquivos de output da integração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se a integração via arquivo foi finalizada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processName description: Nome do processo in: query required: true type: string – name: batchQuantity description: Quantidade de lotes da integração in: query required: true type: integer format: int64 – name: dateWhen description: Data/hora de inicio in: query required: true type: string format: date-time responses: 200: description: Ok schema: type: object required: – isFinished – fileIds properties: isFinished: type: boolean description: Indica se a integração foi finalizada fileIds: type: array items: type: string minimum: 1 description: Lista com o file_id dos arquivos de output da integração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/getDatabaseMetrics: post: description: Retorna a porcentagem de uso do Banco de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – usagePercentage properties: usagePercentage: type: integer format: int64 description: Porcentagem de uso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a porcentagem de uso do Banco de dados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – usagePercentage properties: usagePercentage: type: integer format: int64 description: Porcentagem de uso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/ post: description: Retorna informações sobre a versão tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/keyValue minimum: 1 description: Propriedades da versão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações sobre a versão tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/keyValue minimum: 1 description: Propriedades da versão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/queries/existsOnMeta: post: description: Retorna se um registro G7 possui referência na meta. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metaValue – metaGroup properties: metaValue: type: string description: Id na G7 metaGroup: type: string description: Agrupador da coleção/entidade responses: 200: description: Ok schema: type: object required: – metaKey – exists – success properties: metaKey: type: string description: id na G7 exists: type: boolean description: Retorna true caso exista o canditato e falso caso contrário. success: type: boolean description: Indica se conseguiu verificar o registro na meta corretamente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se um registro G7 possui referência na meta. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: metaValue description: Id na G7 in: query required: true type: string – name: metaGroup description: Agrupador da coleção/entidade in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metaKey – exists – success properties: metaKey: type: string description: id na G7 exists: type: boolean description: Retorna true caso exista o canditato e falso caso contrário. success: type: boolean description: Indica se conseguiu verificar o registro na meta corretamente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/integrationCount: post: description: Verifica se há registros na tabela a ser integrada\n### Resources\n- res://senior.com.br/hcm/integration/queries/integrationCount\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName properties: tableName: type: string description: Nome da tabela para query responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Número de registros existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se há registros na tabela a ser integrada\n### Resources\n- res://senior.com.br/hcm/integration/queries/integrationCount\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tableName description: Nome da tabela para query in: query required: true type: string responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Número de registros existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/metaCount: post: description: Retorna a quantidade de registros na meta referentes à coleção informada.\nCaso não seja informada uma coleção, será retornado o total geral de registros.\n### Resources\n- res://senior.com.br/hcm/integration/queries/metaCount\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: metaGroup: type: string description: Nome da coleção/grupo responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Número de registros existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de registros na meta referentes à coleção informada.\nCaso não seja informada uma coleção, será retornado o total geral de registros.\n### Resources\n- res://senior.com.br/hcm/integration/queries/metaCount\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: metaGroup description: Nome da coleção/grupo in: query type: string responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Número de registros existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/metaLargeCollections: post: description: Retorna uma lista com as coleções consideradas grandes em relação ao número de registros.\nSerão retornadas todas as coleções onde o númerdo de registros for maior ou igual ao campo size\n### Resources\n- res://senior.com.br/hcm/integration/queries/metaLargeCollections\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Quantidade de registros para que a coleção/grupo seja considerada grande responses: 200: description: Ok schema: type: object required: – metaGroupList properties: metaGroupList: type: array items: type: string minimum: 1 description: Lista de coleções/grupos consideradas grandes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com as coleções consideradas grandes em relação ao número de registros.\nSerão retornadas todas as coleções onde o númerdo de registros for maior ou igual ao campo size\n### Resources\n- res://senior.com.br/hcm/integration/queries/metaLargeCollections\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: size description: Quantidade de registros para que a coleção/grupo seja considerada grande in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – metaGroupList properties: metaGroupList: type: array items: type: string minimum: 1 description: Lista de coleções/grupos consideradas grandes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/metaPagedList: post: description: Lista todas as informações do grupo informado por parâmetro\n- res://senior.com.br/hcm/integration/queries/metaPagedList\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metaGroup – pageSize properties: metaGroup: type: string description: Nome do grupo a ser listado nextKey: type: string description: Chave para o registro inicial a ser listado. Se for nulo, retornará a primeira página pageSize: type: integer format: int64 description: Quantidade de registros a serem retornados por página responses: 200: description: Ok schema: type: object required: – compressedData properties: compressedData: type: string format: byte description: Informação compactada e codificada em Base64. O formato original da informação é pagedMeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as informações do grupo informado por parâmetro\n- res://senior.com.br/hcm/integration/queries/metaPagedList\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: metaGroup description: Nome do grupo a ser listado in: query required: true type: string – name: nextKey description: Chave para o registro inicial a ser listado. Se for nulo, retornará a primeira página in: query type: string – name: pageSize description: Quantidade de registros a serem retornados por página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – compressedData properties: compressedData: type: string format: byte description: Informação compactada e codificada em Base64. O formato original da informação é pagedMeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/externalUserAccountListQuery: post: description: Lista os registros da tabela UserAccount do HCM oriundos de uma integração com sistema terceiro. Serve como referência para a utilização das primitivas createExternalUserAccount e deleteExternalUserAccount.\nEssa rotina é importante pois viabiliza a utilização das telas do HCM, visto que servirá para listar os vinculos de usuários da plataforma Senior X, teoricamente criados por uma aplicação terceira, com uma pessoa/colaborador do HCM.\n### Resources:\n- res://senior.com.br/hcm/integration/actions/externalUserAccount – VISUALIZAR\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – page properties: page: type: object allOf: – #/definitions/pagination description: Paginação userAccountSearch: type: string description: Busca por usuário (useraccount.username) employeeSearch: type: string description: Busca por colaborador (person.fullname) responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/pagedExternalUserAccountListQuery description: Retorno da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/verifyAdmin: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isAdmin properties: isAdmin: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isAdmin properties: isAdmin: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/isTenantNovasoft: post: description: Retorna a informação se o tenant em questão é da Novasoft ou HCM XT\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isNovasoft properties: isNovasoft: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a informação se o tenant em questão é da Novasoft ou HCM XT\n tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isNovasoft properties: isNovasoft: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/queries/exportIntegrationFileProcess: 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 /integration/queries/exportIntegrationFileProcessBatch: 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 /integration/queries/exportMeta: 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 /integration/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 /integration/actions/integrationLogicalDeleteBatch: post: description: Apaga de forma lógica um lote de entidade pelo id\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatch\n- DELETE\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – columnName – collectionName – jsonText properties: tableName: type: string description: Nome da tabela columnName: type: string description: Nome da coluna que representa o id externo collectionName: type: string description: Collection name da tabela meta jsonText: type: string description: Json da dos dados a serem atualizados hasTranslations: type: boolean description: Indica se o fluxo possui tradução default: false responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/integrationBatchData minimum: 1 description: Resultado da ação de deleção o lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/setExternalIds: post: description: Atualiza os registro informados defindo o identificador externo.\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatch\n- INSERT\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – columnName – collectionName – data properties: tableName: type: string description: Nome da tabela columnName: type: string description: Nome da coluna que representa o id externo collectionName: type: string description: Collection name da tabela meta data: type: array items: type: object allOf: – #/definitions/idWithExternalId minimum: 1 description: Registros a serem atualizados responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/integrationBatchData minimum: 1 description: Resultado da ação de deleção o lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/changeExternalId: post: description: Atualiza os registro informados defindo o identificador externo.\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatch\n- INSERT\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – columnName – externalId – newExternalId – comparisionType properties: tableName: type: string description: Nome da tabela columnName: type: string description: Nome da coluna que representa o id externo externalId: type: string description: Identificador externo do registro newExternalId: type: string description: novo identificador externo do registro comparisionType: type: string allOf: – #/definitions/ComparisionType description: Tipo de comparação responses: 200: description: Ok schema: type: object required: – updated properties: updated: type: integer format: int64 description: Quantidade de registros alterados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/integrationDeleteBatch: post: description: Apaga um lote de entidade pelo id\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatch\n- DELETE\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – columnName – collectionName properties: tableName: type: string description: Nome da tabela columnName: type: string description: Nome da coluna que representa o id externo collectionName: type: string description: Collection name da tabela meta externalIds: type: array items: type: string description: Identificadores externos a serem apagados hasTranslations: type: boolean description: Indica se o fluxo possui tradução default: false responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/integrationBatchData minimum: 1 description: Resultado da ação de deleção o lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/integrationBatch: post: description: Salva um lote de entidades\n\n### Resources:\n\n- res://senior.com.br/hcm/integration/actions/integrationBatch\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/integrationBatchRecordIn responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationBatchRecordOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/integrationBatchTimeTracking: post: description: Salva um lote da entidade EmployeeTimeTrackingSituation\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatchTimeTracking\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/integrationBatchRecordIn responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationBatchRecordOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/integrationDeleteAll: post: description: Primitiva responsável por remover os registros de uma tabela e da respectiva meta.\nEle cria uma transação na lista toda, então só deleta caso der certo o delete de todas as coleções.\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – collections properties: collections: type: array items: type: string allOf: – #/definitions/deleteAllCollections minimum: 1 description: Lista de coleções a serem removida, o enum é utilizado para filtrar apenas as opções que queremos\nque possam ter esse comportamento, obrigatoriamente a coleção precisa ter o mesmo nome da tabela\n responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/integrationBatchWageTypeRegister: post: description: Salva um lote da entidade WageTypeRegister\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatchWageTypeRegister\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/integrationBatchRecordIn responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationBatchRecordOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/integrationBatchHistoricalLeave: post: description: Salva um lote da entidade HistoricalLeave\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatchHistoricalLeave\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/integrationBatchRecordIn responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationBatchRecordOut 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/externalIdMigration: post: description: Realiza a migração dos registros que já foram integrados e não possuem o external_id populados\n### Resources:\n- res://senior.com.br/hcm/integration/actions/integrationBatch\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – collectionName – columnName properties: tableName: type: string description: Nome da tabela collectionName: type: string description: Nome da coleção na meta columnName: type: string description: Nome da coluna do id externo newRoutine: type: boolean description: Indica qual rotina de migração responses: 200: description: Ok schema: type: object required: – success – errorMessage properties: success: type: boolean description: Indica se a migração foi bem sucedida errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/createExternalUserAccount: post: description: Realiza a criação de um registro na tabela UserAccount do HCM com base nas informações de um usuário que foi criado por fora do Integrador do HCM (geralmente por uma aplicação terceira).\nEssa rotina é importante pois viabiliza a utilização das telas do HCM, visto que servirá para vincular um usuário da plataforma Senior X, teoricamente criado por uma aplicação terceira, com uma pessoa/colaborador do HCM.\n### Resources:\n- res://senior.com.br/hcm/integration/actions/externalUserAccount – INCLUIR\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – input properties: input: type: array items: type: object allOf: – #/definitions/externalUserAccount minimum: 1 description: Informações dos usuários que devem ser criados responses: 200: description: Ok schema: type: object required: – output properties: output: type: array items: type: object allOf: – #/definitions/externalUserAccountOperationOutput minimum: 1 description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/deleteExternalUserAccount: post: description: Realiza a remoção de um lote de registros da tabela UserAccount do HCM com base nas informações de usuários que foram criados por fora do Integrador do HCM (geralmente por uma aplicação terceira).\nEssa rotina é importante pois inviabilizará a utilização das telas do HCM, visto que servirá para desvincular um usuário da plataforma Senior X, teoricamente criado por uma aplicação terceira, com uma pessoa/colaborador do HCM.\n### Resources:\n- res://senior.com.br/hcm/integration/actions/externalUserAccount – EXCLUIR\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – usernames properties: usernames: type: array items: type: string minimum: 1 description: Nomes do usuários que devem ser removidos responses: 200: description: Ok schema: type: object required: – output properties: output: type: array items: type: object allOf: – #/definitions/externalUserAccountOperationOutput minimum: 1 description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/metaOrphanRemove: post: description: Endpoint responsável por remover os registros órfãos da tabela meta tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – group – tableName properties: group: type: string description: CollectionName na tabela meta tableName: type: string description: Nome da tabela G7 do group correspondente responses: 200: description: Ok schema: type: object required: – hasRecords properties: hasRecords: type: boolean description: Retorna se registros foram removidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/updateEndDateFromPreviousHistoric: post: description: Atualiza o Historico Anterior tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – historics – deletedIds – employeeHistoric properties: historics: type: array items: type: object allOf: – #/definitions/historicInfo minimum: 1 description: Informações do Historico deletedIds: type: array items: type: string minimum: 1 description: Lista de IDs que serão removidos employeeHistoric: type: string allOf: – #/definitions/employeeHistoric description: Historico do colaborador responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a operação foi bem sucedida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/sendTelemetryEmail: post: description: Envia o e-mail de telemetria tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – emailContent – emailSubject properties: occultRecipients: type: array items: type: string description: Lista de endereços de e-mail que irão receber o e-mail de maneira oculta recipients: type: array items: type: string description: Lista de endereços de e-mail que irão receber o e-mail de maneira direta emailContent: type: string description: Conteúdo do e-mail emailSubject: type: string description: Título do e-mail emailAdditionalInfo: type: object allOf: – #/definitions/additionalEmailInformation description: Informações para footer do e-mail attachment: type: string format: byte description: Arquivo do e-mail tenantPriority: type: integer format: int64 description: Indicação de prioridade do Tenant responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se o envio foi bem sucedido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/sendEmailToBlacklist: post: description: Envia um email para a blacklist da plataforma tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: Email a ser enviado para a blacklist responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se o envio foi bem sucedido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/removeDuplicatedRecord: post: description: Realiza a exclusão de um registro da G7 caso não esteja na meta e exista outro registro referenciando o registros G5 informado. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – collectionName – g7Id – g5Id properties: tableName: type: string description: Nome da tabela collectionName: type: string description: Collection name da tabela meta g7Id: type: string description: Id G7 g5Id: type: string description: Id G5 responses: 200: description: Ok schema: type: object required: – success – statusMessage properties: success: type: boolean description: Indica se a exclusão foi bem sucedida statusMessage: type: string description: Mensagem com o status do processo de exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/insertOnMeta: post: description: Insere um dado na tabela meta tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metaGroup – metaKey – metaValue properties: metaGroup: type: string description: Agrupador da coleção/entidade metaKey: type: string description: Id G5 metaValue: type: string description: Id G7 responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se conseguiu inserir corretamente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/deleteOnMeta: post: description: Deleta da tabela meta também da meta local do Integrador HCM tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – collectionName – metaValue properties: collectionName: type: string description: Agrupador da coleção/entidade metaValue: type: string description: Id SenioX responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/requestUploadFile: post: description: Solicitação para realizar o upload de um arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/requestUploadData description: Retorno do upload de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/commitFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do commit de um arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/requestAccessFile: post: description: Solicitação para acessar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos) default: 30 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/requestAccessData description: Retorno do acesso do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/deleteFile: post: description: Solicitação para apagar um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /) responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno de delete do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/importIntegrationFileProcess: 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 /integration/actions/importIntegrationFileProcessBatch: 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 /integration/actions/importMeta: 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 /integration/signals/clearExternalIdMigrationCache: post: description: Remove do cache de migrações concluidas uma derminada tabela tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tableName properties: tableName: type: string description: Nome da tabela responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/sendToCloudSearch: post: description: Insere registro no CloudSearch (Recurso de busca de pessoas da AWS) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tableName – initialCharge – jsonText – dtoKeys properties: tableName: type: string description: Tabela da entidade initialCharge: type: boolean description: Informa se é uma carga inicial jsonText: type: string description: Json da entidade dtoKeys: type: array items: type: string minimum: 1 description: Lista com o nome de todas as propriedades do dto responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/integrationFileBatch: post: description: Integração de dados via arquivo tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – input properties: input: type: object allOf: – #/definitions/integrationBatchRecordIn description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/createArea: post: description: Cria a area para operações do blob-service tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: domainName: type: string description: serviceName: type: string description: areaSecret: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/events/integrationEvent: post: description: Evento de criação/edição/exclusão de uma tabela x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ids – operationType – tableName – isSync properties: ids: type: array items: type: string minimum: 1 description: Identificadores dos registros operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação tableName: type: string description: Tabela cujo dado foi modificado isSync: type: boolean description: Indica se é um evento de sincronia responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/importIntegrationFileProcessEvent: 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 /integration/events/exportIntegrationFileProcessEvent: 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 /integration/events/importIntegrationFileProcessBatchEvent: 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 /integration/events/exportIntegrationFileProcessBatchEvent: 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 /integration/events/importMetaEvent: 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 /integration/events/exportMetaEvent: 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 /integration/entities/integrationFileProcessBatch: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integrationFileProcessBatch responses: 200: description: The created resource schema: #/definitions/integrationFileProcessBatch 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/integrationFileProcessBatch responses: 200: description: The created resource schema: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/integrationFileProcessBatch/{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/integrationFileProcessBatch responses: 200: description: Ok schema: #/definitions/integrationFileProcessBatch 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/integrationFileProcessBatch responses: 200: description: Ok schema: #/definitions/integrationFileProcessBatch 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/integrationFileProcessBatch 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 /integration/entities/integrationFileProcess/{parentId}/integrationFileProcessBatch: post: 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/integrationFileProcessBatch responses: 200: description: The created resources schema: type: array items: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/integrationFileProcessBatch responses: 200: description: The created resources schema: type: array items: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: array items: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/integrationFileProcess/{parentId}/integrationFileProcessBatch/{id}: put: 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/integrationFileProcessBatch responses: 200: description: Ok schema: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/integrationFileProcessBatch responses: 200: description: Ok schema: #/definitions/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/integrationFileProcessBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /integration/entities/integrationFileProcessBatch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationFileProcessBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN processStatus: description: Status do lote da integração via arquivo type: string enum: – PROCESSING – FINISHED employeeHistoric: description: Históricos do Colaborador type: string enum: – HISTORICAL_COMPANY_BRANCH – HISTORICAL_COST_CENTER – HISTORICAL_DEPARTMENT – HISTORICAL_EMPLOYMENT_RELATIONSHIP – HISTORICAL_ESOCIAL_CATEGORY – HISTORICAL_EXPENSE_NATURE – HISTORICAL_IRRF – HISTORICAL_JOB_POSITION – HISTORICALLEAVE – HISTORICAL_SALARY – HISTORICAL_SALARY_PREMIUM – HISTORICAL_SEFIP_CATEGORY – HISTORICAL_SYNDICATE – HISTORICAL_SYNDICATE_UNION_CONTRIBUTION – HISTORICAL_TELEWORK – HISTORICAL_TEMPORARY_CONTRACT – HISTORICAL_TRANSPORTATION_VOUCHER_SCALE – HISTORICAL_TRAINEE – HISTORICAL_WORKSHIFT – HISTORICAL_WORKSTATION – HISTORICAL_WORK_ENVIRONMENT – HISTORICAL_BADGE operationType: description: Tipo de operação. type: string enum: – INSERT – UPDATE – DELETE ComparisionType: description: Tipo de comparação. type: string enum: – STARTS_WITH – CONTAINS – EQUALS – END_WITH RemotePendency: description: Pendencias remotas do Integrador HCM type: string enum: – DELETE_LOCAL_META_RECORD deleteAllCollections: description: Opcões de coleções a usarem a API de integrationDeleteAll type: string enum: – NH_HIERARCHY_ITEM – NH_HIERARCHY – NH_HIERARCHY_REVISION – NH_HIERARCHY_TYPE ColumnName: description: Nomes possíveis para a coluna da tabela que possui o campo com o id do sistema legado type: string enum: – EXTERNAL_ID – ORIGIN_ID orderByType: description: Tipo de ordenação type: string enum: – ASC – DESC userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR historicInfo: description: Informações do historico type: object required: – employeeId – dateWhen properties: employeeId: type: string description: Id do colaborador dateWhen: type: string format: date description: Data do histórico checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status additionalEmailInformation: description: Informações complementares referentes ao Integrador do HCM para o e-mail type: object properties: configMemoryUsage: type: string description: Configuração de memória do serviço memoryUsage: type: string description: Quantidade de memória alocada pelo integrador host: type: string description: Host cloudIBM: type: string description: CloudIBM versionG5Database: type: string description: Versão do banco de dados G5 versionIntegration: type: string description: Versão do integrador integrationBatchRecordIn: description: Entrada do payload da estrutura do integrationBatch type: object required: – tableName – columnName – initialCharge – dtoKeys properties: tableName: type: string description: Tabela da entidade columnName: type: string description: Nome da coluna com o id externo initialCharge: type: boolean description: Informa se é uma carga inicial jsonText: type: string description: Json da entidade dtoKeys: type: array items: type: string minimum: 1 description: Lista com o nome de todas as propriedades do dto collectionName: type: string description: Collection name da tabela meta isSync: type: boolean description: Indica se os dados vem a partir de uma sincronia fileId: type: string description: fileID dateWhenFile: type: string format: date-time description: Data e hora da execução do fluxo por arquivo integrationBatchRecordOut: description: Retorno da ação de salvar o lote type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/integrationBatchData minimum: 1 description: Resultado da ação de salvar o lote entityEvent: description: Retorno do evento por entidade type: object required: – ids – isSync properties: ids: type: array items: type: string minimum: 1 description: Identificadores afetados isSync: type: boolean description: Indica se foi um evento de sincronia idWithExternalId: description: Mapeamento de id e externalId type: object required: – id – externalId properties: id: type: string description: Identificador. externalId: type: string description: Identificador externo. keyValue: description: Retorno simples de chave-valor type: object required: – key – value properties: key: type: string description: nome do campo. value: type: string description: Valor selecionado. integrationBatchData: description: Resultado da integração em lotes type: object required: – id – g5Id – created – success – errorMessage properties: id: type: string description: Id da entidade g5Id: type: string description: Identificador na g5 created: type: boolean description: Registro criado success: type: boolean description: Informa se a ação foi realizada com sucesso errorMessage: type: string description: Mensagem de erro externalUserAccountOperationOutput: description: Resultado de uma operação que foi realizada type: object required: – username – success properties: username: type: string description: Nome do usuário success: type: boolean description: Retorna se a operação foi realizada com sucesso errorMessage: type: string description: Mensagem que contém o motivo da operação não ter funcionado – Se for o caso externalUserAccount: description: Representa o vínculo de um usuário da plataforma SeniorX com um colaborador do HCM. Utilizado exclusivamente para integração com sistemas externos. type: object required: – username – personIdentifier – employeeIdentifier properties: username: type: string description: Nome do usuário – Exatamente como criado na plataforma Senior X personIdentifier: type: string description: Identificador da pessoa (CODPES ou PersonId) employeeIdentifier: type: string description: Identificador do colaborador (NUMEMP;TIPCOL;NUMCAD ou EmployeeId) employeeName: type: string description: Nome do colaborador pagedExternalUserAccountListQuery: description: Retorno paginado da consulta de vínculos de usuários da plataforma SeniorX com colaboradores do HCM. Utilizado exclusivamente para integração com sistemas externos. allOf: – #/definitions/paged – type: object required: – externalUserAccounts properties: externalUserAccounts: type: array items: type: object allOf: – #/definitions/externalUserAccount minimum: 1 description: Contratos da entidade UserAccount perante a persistência fora do Integrador do HCM pagedMeta: description: type: object required: – records – isMoreItensAvailable properties: records: type: array items: type: object allOf: – #/definitions/metaKeyRecord minimum: 1 description: Registros referentes à meta nextKey: type: string description: Próximo registro a ser listado isMoreItensAvailable: type: boolean description: Indica se existem mais itens a serem listados metaKeyRecord: description: type: object required: – metaKey – metaValue properties: metaKey: type: string description: Valor do campos meta_key (chave da G5) metaValue: type: string description: Valor do campo meta_value (chave da g7) requestUploadData: description: Dados de retorno da solicitação de upload de um arquivo allOf: – #/definitions/resultBaseData – type: object required: – fileId – version – locationURI properties: fileId: type: string description: Identificador único do arquivo type: string description: Versão do arquivo locationURI: type: string description: URI onde o upload deve ser realizado requestAccessData: description: Dados de retorno do acesso do arquivo allOf: – #/definitions/resultBaseData – type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download resultBaseData: description: Retorno base para os endpoints discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso warning: type: boolean description: Flag para indicar sucesso com alerta default: false message: type: string description: Mensagem de retorno default: _discriminator: type: string description: paged: description: Retorno paginado discriminator: _discriminator type: object required: – countResult – numberPages – _discriminator properties: countResult: type: integer format: int64 description: Quantidade de registros encontrados numberPages: type: integer format: int64 description: Quantidade de páginas da consulta (incluindo a atual) _discriminator: type: string description: pagination: description: Dados da paginação type: object required: – current – size – orderBy properties: current: type: integer format: int64 description: Página atual, inicia em 1 size: type: integer format: int64 description: Quantidade de registros por página, inicia em 1 orderBy: type: string allOf: – #/definitions/orderByType description: Ordenar por integrationFileProcess: description: Entidade responsável por fazer controle dos processos de integração via arquivo type: object required: – id – processName – integrationFileProcessBatch – dateWhen properties: id: type: string format: uuid description: Identificador unico processName: type: string description: Nome do fluxo integrationFileProcessBatch: type: array items: type: object allOf: – #/definitions/integrationFileProcessBatch minimum: 1 description: Lotes dateWhen: type: string format: date-time description: Data e hora que o fluxo foi iniciado integrationFileProcessBatch: description: Entidade responsável por fazer controle dos lotes do processo de integração via arquivo type: object required: – id – status properties: id: type: string format: uuid description: Identificador unico integrationFileProcess: type: object allOf: – #/definitions/integrationFileProcess description: processo status: type: string allOf: – #/definitions/processStatus description: Indicação da finalização do lote fileId: type: string description: Identificador do arquivo para solicitar o arquivo meta: description: Entidade responsável por fazer a junção dos IDs HCM XT – SeniorX type: object required: – id – metaGroup – metaKey – metaValue properties: id: type: string maxLength: 32 description: Identificador do registro metaGroup: type: string maxLength: 255 description: Agrupador da coleção/entidade metaKey: type: string maxLength: 255 description: Id do HCM XT metaValue: type: string description: Id do SeniorX notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE