2.0info: 1.5.1 HCM – Descrição description: HCM – Descrição x-senior-domain: HCM – Descrição x-senior-domain-path: hcm_legacy_integration x-senior-service-path: manager contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcm_legacy_integrationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /manager/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: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 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: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /manager/queries/isSyncActive: post: description: Verifica se o tenant possui a sincronia ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se o tenant possui a sincronia ativa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o tenant possui a sincronia ativa tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se o tenant possui a sincronia ativa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /manager/queries/getTenantsBySyncStatusType: post: description: Busca os tenants com a situação da sincronia informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – syncStatusTypes properties: syncStatusTypes: type: array items: type: string allOf: – #/definitions/syncStatusType minimum: 1 description: Situação da sincronia responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/tenantSyncStatusType description: Tenants resultantes junto com a situação da sincronia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /manager/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 /manager/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 /manager/actions/retryPendencies: post: description: Faz a retentativa de execução de pendências com erro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: ids: type: array items: type: string description: Identificadores das pendências que serão retentadas, caso nenhum seja fornecido, todas as pendências com status de erro serão retentadas forceProcessingRetry: type: boolean description: Forçar retentativa de pendências com o status processando default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /manager/actions/saveFlows: post: description: Faz o salvamento dos fluxos de um extrator de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: extractDomain: type: string maxLength: 255 description: Domínio de extração no HCM, por padrão é utilizado o serviço que chamou a primitiva extractService: type: string maxLength: 255 description: Serviço de extração no HCM, por padrão é utilizado o serviço que chamou a primitiva flows: type: array items: type: object allOf: – #/definitions/flowData description: Fluxos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /manager/signals/startSync: post: description: Inicia a sincronia para um tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /manager/signals/startSyncBulk: post: description: Inicia a sincronia para um lote de tenants tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Tenants responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /manager/signals/stopSync: post: description: Para a sincronia para um tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /manager/signals/stopSyncBulk: post: description: Para a sincronia para um lote de tenants tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Tenants responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /manager/events/tenantSyncStatusTypeChanged: post: description: É emitido quando um ou mais tenants possuem a sincronia desabilitada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenantSyncStatusType minimum: 1 description: Tenants responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN operationType: description: Tipo de operação. type: string enum: – INSERT – UPDATE – DELETE syncStatusType: description: Situação da sincronia type: string enum: – ACTIVE – INACTIVE – PROCESSING – ERROR 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: Dados referentes a checagem de saúde do serviço type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status flowData: description: Dados de um fluxo type: object required: – flowName – loadDomain – loadService – triggers properties: flowName: type: string maxLength: 255 description: Nome do fluxo loadDomain: type: string maxLength: 255 description: Domínio de carga no Foundation X loadService: type: string maxLength: 255 description: Serviço de carga no Foundation X batchSize: type: integer format: int64 description: Limite de pendências processadas por lote default: 100 triggers: type: array items: type: object allOf: – #/definitions/flowTriggerData minimum: 1 description: Gatilhos para a ativação do fluxo loadDefinitions: type: array items: type: object allOf: – #/definitions/flowLoadDefinitionData description: Filtro utilizado para a criação de pendências de carga do fluxo dependencies: type: array items: type: string description: Dependências para a execução do fluxo flowTriggerData: description: Gatilho para a ativação de um fluxo type: object required: – tableName – operationType – loadingPrimitive properties: tableName: type: string maxLength: 255 description: Nome da tabela com o dado alterado operationType: type: string allOf: – #/definitions/operationType description: Operação realizada extractionPrimitive: type: object allOf: – #/definitions/extractionPrimitive description: Primitiva de extração do HCM. Não deve ser informado caso um corpo fixo da requisição de carregamento seja informado. loadingPrimitive: type: object allOf: – #/definitions/loadingPrimitive description: Primitiva de carga no Foundation X integrateEvents: type: boolean description: Indicativo se eventos vindos do integrador HCM e/ou do serviço de polling devem ser considerados default: true childFlowTriggers: type: array items: type: object allOf: – #/definitions/childFlowTriggerData description: Gatilhos de fluxos filhos para a ativação postLoadingPrimitive: type: object allOf: – #/definitions/postLoadingPrimitive description: Primitiva pós carga no Foundation X eventName: type: string maxLength: 255 description: Evento de integração que deverá acionar esse fluxo. Como padrão é utilizado o integrationEvent. flowLoadDefinitionData: description: Filtro utilizado para a criação de pendências de carga do fluxo type: object required: – tableName – operationType – idsExtractionPrimitive properties: tableName: type: string maxLength: 255 description: Nome da tabela operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação idsExtractionPrimitive: type: string maxLength: 255 description: Primitiva de extração de ids do HCM extractionPrimitive: description: Primitiva de extração type: object required: – name properties: name: type: string maxLength: 255 description: Nome da primitiva loadingPrimitive: description: Primitiva de carregamento type: object required: – name properties: name: type: string maxLength: 255 description: Nome da primitiva async: type: boolean description: Se a primitiva é assícrona default: false fixedLoadingPayload: type: string description: Corpo fixo da requisição de carregamento. Não deve ser informado caso a primitiva de extração do HCM seja.\nDeve ser populado com um JSON válido, esse será usado como entrada para a primitiva de carregamento de dados.\nEsse JSON pode receber alguns valores dinâmicos com base nas propriedades da pendência vínculada.\nPropriedades atualemnte suportadas: entityId. childFlowTriggerData: description: Gatilho de fluxo filho type: object required: – flow – tableName – operationType properties: flow: type: string maxLength: 255 description: Nome do fluxo filho tableName: type: string maxLength: 255 description: Nome da tabela com o dado alterado operationType: type: string allOf: – #/definitions/operationType description: Operação realizada postLoadingPrimitive: description: Primitiva de pós carga type: object required: – name properties: name: type: string maxLength: 255 description: Nome da primitiva tenantSyncStatusType: description: Dados de um tenant com a situação da sincronia type: object required: – tenant – syncStatusType properties: tenant: type: string maxLength: 255 description: Tenant syncStatusType: type: string allOf: – #/definitions/syncStatusType description: Situação da sincronia 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