2.0info: 1.3.1 HCM – Descrição description: HCM – Descrição x-senior-domain: HCM – Descrição x-senior-domain-path: hcm_legacy_contract x-senior-service-path: extractor 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_contractsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /extractor/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/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 /extractor/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 /extractor/actions/extractEmployees: post: description: Faz a extração de dados do fluxo de colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractCompanyBranchHistories: post: description: Faz a extração de dados do fluxo de histórico de filial do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractJobPositionHistories: post: description: Faz a extração de dados do fluxo de histórico de cargo do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractPositionHistories: post: description: Faz a extração de dados do fluxo de histórico de posição do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractWorkshiftHistories: post: description: Faz a extração de dados do fluxo de histórico de escala tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractSyndicateHistories: post: description: Faz a extração de dados do fluxo de histórico de sindicato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractBadgeHistories: post: description: Faz a extração de dados do fluxo de histórico de crachá tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractEmploymentRelationshipHistories: post: description: Faz a extração de dados do fluxo de histórico de vínculo do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractEmployeeModules: post: description: Faz a extração de dados do fluxo de módulos do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/extractLeaveHistories: post: description: Faz a extração de dados do fluxo de histórico de afastamento do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operations properties: operations: type: array items: type: object allOf: – #/definitions/recordOperation minimum: 1 description: Operações ocorridas dos registros necessários para esse fluxo ser ativado. responses: 200: description: Ok schema: type: object required: – extractedData properties: extractedData: type: array items: type: object allOf: – #/definitions/extractedData minimum: 1 description: Resultado das extrações de dados. 401: description: Invalid Credentials 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 extractedDataStatusType: description: Situação da extração type: string enum: – SUCCESS – ERROR – CANCELED – INCOMPLETE 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: type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status recordOperation: description: Operação realizada em um registro type: object required: – pendencyId – entityId – tableName – operationType properties: pendencyId: type: string description: Identificador único da pendência entityId: type: string description: Identificador único da entidade tableName: type: string description: Nome da tabela operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação data: type: array items: type: object allOf: – #/definitions/columnDataItem description: Dados do registro extractedData: description: Dados extraidos type: object required: – pendencyId – entityId – tableName – operationType – statusType properties: pendencyId: type: string description: Identificador único da pendência entityId: type: string description: Identificador único da entidade tableName: type: string description: Nome da tabela operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação statusType: type: string allOf: – #/definitions/extractedDataStatusType description: Situação da extração message: type: string description: Mensagem completedData: type: array items: type: object allOf: – #/definitions/completedData description: Dados extra completados com essa integração completedData: description: Dados completados por essa integração type: object required: – flow – entityId – tableName – operationType properties: flow: type: string description: Fluxo entityId: type: string description: Identificador único da entidade tableName: type: string description: Nome da tabela operationType: type: string allOf: – #/definitions/operationType description: Tipo de operação columnDataItem: description: Dados específicos do registro alterado type: object required: – name properties: name: type: string description: Nome da coluna value: type: string description: Valor da coluna 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