2.0info: 3.7.1 DATABASE description: Integrador – Database x-senior-domain: ERPX_INT x-senior-domain-path: erpx_int x-senior-service-path: database 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/erpx_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /database/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/queries/getTicketWithTasksAndWorks: post: description: Retorna o ticket de integração com suas tasks e os works de cada task tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketId properties: ticketId: type: string description: ID do ticket de integração responses: 200: description: Ok schema: type: object properties: ticket: type: object allOf: – #/definitions/ticketWithTasksAndWorks description: Ticket de integração com tasks e works 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o ticket de integração com suas tasks e os works de cada task tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticketId description: ID do ticket de integração in: query required: true type: string responses: 200: description: Ok schema: type: object properties: ticket: type: object allOf: – #/definitions/ticketWithTasksAndWorks description: Ticket de integração com tasks e works 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/queries/getTasksWithWorksByStatus: post: description: Retorna as tasks de um ticket agrupando os works pelo status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketId properties: ticketId: type: string description: ID do ticket de integração responses: 200: description: Ok schema: type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/taskWithWorksByStatus minimum: 1 description: Lista de tasks com works agrupados por status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as tasks de um ticket agrupando os works pelo status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticketId description: ID do ticket de integração in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/taskWithWorksByStatus minimum: 1 description: Lista de tasks com works agrupados por status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/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 /database/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/refreshFdw: post: description: Realiza a criação das referências do FDW tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object properties: migrationVersion: type: string description: Indica a versão do migration migrated: type: boolean description: Indica se já foi migrado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck integrationWorkRecord: description: Dados completos do IntegrationWork type: object required: – id – task – workStatus – subjectId properties: id: type: string description: ID do work task: type: string description: ID da task workStatus: type: string description: Status do work subjectId: type: string description: ID do subject subjectTable: type: string description: Tabela do subject workerPid: type: string description: PID do worker workStartDate: type: string format: date-time description: Data de início do work workEndDate: type: string format: date-time description: Data de fim do work workKeepAliveDate: type: string format: date-time description: Data de keep alive do work message: type: string description: Mensagem subjectOriginDoc: type: string description: Documento de origem do subject subjectOriginDocId: type: string description: ID do documento de origem do subject usuger: type: string description: Usuário de criação dthger: type: string format: date-time description: Data de criação usualt: type: string description: Usuário de alteração dthalt: type: string format: date-time description: Data de alteração integrationTaskRecord: description: Dados completos da IntegrationTask com seus works type: object required: – id – ticket – description – taskStatus – workerName – maxWorkers – maxRecordsPerWorker – taskStartDate properties: id: type: string description: ID da task ticket: type: string description: ID do ticket description: type: string description: Descrição da task taskStatus: type: string description: Status da task workerName: type: string description: Nome do worker maxWorkers: type: integer format: int64 description: Máximo de workers maxRecordsPerWorker: type: integer format: int64 description: Máximo de registros por worker taskStartDate: type: string format: date-time description: Data de início da task taskEndDate: type: string format: date-time description: Data de fim da task taskKeepAliveDate: type: string format: date-time description: Data de keep alive da task message: type: string description: Mensagem usuger: type: string description: Usuário de criação dthger: type: string format: date-time description: Data de criação usualt: type: string description: Usuário de alteração dthalt: type: string format: date-time description: Data de alteração ticketWithTasksAndWorks: description: Ticket de integração com tasks e works type: object required: – id – description – startDate – ticketStatus – tasks properties: id: type: string description: ID do ticket description: type: string description: Descrição do ticket startDate: type: string format: date-time description: Data de início endDate: type: string format: date-time description: Data de fim ticketStatus: type: string description: Status do ticket usuger: type: string description: Usuário de criação dthger: type: string format: date-time description: Data de criação usualt: type: string description: Usuário de alteração dthalt: type: string format: date-time description: Data de alteração tasks: type: array items: type: object allOf: – #/definitions/integrationTaskRecord minimum: 1 description: Tasks do ticket worksByStatus: description: Works agrupados por status type: object required: – status – count properties: status: type: string description: Status do work count: type: integer format: int64 description: Quantidade de works neste status taskWithWorksByStatus: description: Task com works agrupados por status type: object required: – id – ticket – description – taskStatus – workerName – maxWorkers – maxRecordsPerWorker – taskStartDate – worksByStatus properties: id: type: string description: ID da task ticket: type: string description: ID do ticket description: type: string description: Descrição da task taskStatus: type: string description: Status da task workerName: type: string description: Nome do worker maxWorkers: type: integer format: int64 description: Máximo de workers maxRecordsPerWorker: type: integer format: int64 description: Máximo de registros por worker taskStartDate: type: string format: date-time description: Data de início da task taskEndDate: type: string format: date-time description: Data de fim da task taskKeepAliveDate: type: string format: date-time description: Data de keep alive da task message: type: string description: Mensagem usuger: type: string description: Usuário de criação dthger: type: string format: date-time description: Data de criação usualt: type: string description: Usuário de alteração dthalt: type: string format: date-time description: Data de alteração worksByStatus: type: array items: type: object allOf: – #/definitions/worksByStatus minimum: 1 description: Works agrupados por status notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage