Gestão de Pessoas (hcm)

Integration Backend (integration)

122 views 26/02/2020 24/11/2020 integrador 0

2.0info: 3.9.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/ 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/getIdWithExternalId: post: description: Retorna as referências de id e id externo da tabela em questão de forma paginada\n ### Resources:\n – res://senior.com.br/hcm/integration/actions/integrationBatch\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tableName – columnName properties: tableName: type: string description: Nome da tabela para query. columnName: type: string description: Nome da coluna do id externo. lastExternalId: type: string description: Último identificador externo da pagina atual de resultados a ser considerado na página.\n Valor será nulo para a primeira página.\n responses: 200: description: Ok schema: type: object required: – list properties: list: type: array items: type: object allOf: – #/definitions/idWithExternalId minimum: 1 description: Lista de mapeamentos dos ids com os respectivos identificadores externos. lastExternalId: type: string description: Último identificador externa da pagina anterior de resultados a ser considerado na página atual.\n Valor será nulo para a primeira página.\n 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as referências de id e id externo da tabela em questão de forma paginada\n ### Resources:\n – res://senior.com.br/hcm/integration/actions/integrationBatch\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tableName description: Nome da tabela para query. in: query required: true type: string – name: columnName description: Nome da coluna do id externo. in: query required: true type: string – name: lastExternalId description: Último identificador externo da pagina atual de resultados a ser considerado na página.\n Valor será nulo para a primeira página.\n in: query type: string responses: 200: description: Ok schema: type: object required: – list properties: list: type: array items: type: object allOf: – #/definitions/idWithExternalId minimum: 1 description: Lista de mapeamentos dos ids com os respectivos identificadores externos. lastExternalId: type: string description: Último identificador externa da pagina anterior de resultados a ser considerado na página atual.\n Valor será nulo para a primeira página.\n 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/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/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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/migrate: post: description: Realiza a migração da base de dados tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status – errorMessage properties: status: type: boolean description: Status da migração errorMessage: type: string description: Mensagem de erro da migração 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/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 required: – tableName – columnName – initialCharge – jsonText – 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 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 salvar o lote 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 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/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/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/genericErrordefinitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN operationType: description: Tipo de operação. type: string enum: – INSERT – UPDATE – DELETE 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 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 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 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 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

Este artigo foi útil para você?

Leave A Comment