Gateway (gateway)

2.0info: 1.11.3 Gateway description: BI ETL em Senio X x-senior-domain: BI x-senior-domain-path: bi x-senior-service-path: gateway 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/bisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gateway/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço 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 do serviço checks: type: object allOf: – #/definitions/checkDTO description: Itens verificados 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 responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status do serviço checks: type: object allOf: – #/definitions/checkDTO description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/queries/commandsToDo: post: description: Retorna os comandos a serem executados pelo cliente do gateway tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID da instância responses: 200: description: Ok schema: type: object properties: commands: type: string format: byte description: Comandos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os comandos a serem executados pelo cliente do gateway tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: ID da instância in: query required: true type: string responses: 200: description: Ok schema: type: object properties: commands: type: string format: byte description: Comandos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/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 /gateway/queries/exportCommand: 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 /gateway/queries/exportInstance: 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 /gateway/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 /gateway/actions/prepare: post: description: Perara o ambiente do gateway tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: redo: type: boolean description: Recriar o usuário/aplicação caso já exista generateScript: type: boolean description: Gerar script necessário para executar e instalar o serviço applicationName: type: string description: Nome da aplicação a ser configurada para utilizar o gateway username: type: string description: Nome do usuário a ser configurado para utilizar o gateway responses: 200: description: Ok schema: type: object required: – application properties: application: type: object allOf: – #/definitions/applicationDTO description: Dados de aplicação user: type: object allOf: – #/definitions/userDTO description: Dados de usuário scriptParamns: type: string description: Parametros de configuração do bat scriptURL: type: string description: URL de download do bat 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/commandExecute: post: description: Enviar um comando para executar no cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – command properties: id: type: string description: ID ticket: type: string description: ID do ticket connection: type: object allOf: – #/definitions/dbConnectionDTO description: Conexão commandType: type: string allOf: – #/definitions/commandType description: Tipo de comando command: type: string description: Comando parameters: type: string format: byte description: Parametros datePeriod: type: object allOf: – #/definitions/datePeriod description: Periodo needResult: type: boolean description: Arquivo de resposta necessário default: true attachLogs: type: boolean description: Incluir logs default: false encoding: type: string description: Ecoding utilizado no processamento default: UTF-8 responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/commandStarted: post: description: Notifica que a execução de um commando foi iniciada. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID instance: type: object allOf: – #/definitions/instanceData description: Instância responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/commandStatus: post: description: Verifica o status da execução de um command. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 200: description: Ok schema: type: object required: – stage – rowCount – lastUpdate properties: stage: type: string allOf: – #/definitions/stage description: Estágio url: type: string description: URL para download do arquivo rowCount: type: integer format: int64 description: Contagem de linhas lastUpdate: type: string format: date-time description: Última atualização 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/commandCancel: post: description: Verifica o status da execução de um command. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 200: description: Ok schema: type: object required: – cancelledDate properties: cancelledDate: type: string format: date-time description: Data de cancelamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/commandDone: post: description: Commando executado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – success – rowCount properties: ticket: type: string description: ID do ticket id: type: string description: ID success: type: boolean description: Sucesso rowCount: type: integer format: int64 description: Contagem de linhas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/commandClear: post: description: Elimina os arquivos intermediarios gerados pelo comando tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/connectionStart: post: description: Notifica o servidor que esta escutando tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – soKind – clientVersion – hostname – servicePort properties: ticket: type: string description: ID do ticket id: type: string description: ID soKind: type: string allOf: – #/definitions/soKind description: Sistema operacional clientVersion: type: string maxLength: 255 description: Versão do cliente hostname: type: string maxLength: 255 description: Nome da maquina servicePort: type: integer format: int64 description: Porta do serviço responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/clientUpdate: post: description: Incializa atualização do cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: ID responses: 200: description: Ok schema: type: object required: – needUpdate properties: needUpdate: type: boolean description: Update é necessário currentVersion: type: string description: Versão atual targetVersion: type: string description: Versão que será aplicada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/actions/importCommand: 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 /gateway/actions/importInstance: 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 /gateway/signals/commandExecuting: post: description: Gateway sinaliza que esta executando o commando. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gateway/signals/connectionEnd: post: description: Notifica o servidor que parou de escutar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gateway/signals/connectionAlive: post: description: Notifica o servidor que a conexão esta viva tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gateway/signals/connectionCheck: post: description: Pede ao servidor que envie uma mensagem de teste tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: ticket: type: string description: ID do ticket id: type: string description: ID responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gateway/events/executeCommand: post: description: Notifica o cliente remoto que há uma execução pendente x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – ticket – command – checkSignalInterval – url – version properties: id: type: string description: ID ticket: type: string description: ID do ticket connection: type: object allOf: – #/definitions/dbConnectionDTO description: Conexão commandType: type: string allOf: – #/definitions/commandType description: Tipo de comando command: type: string description: Comando parameters: type: string format: byte description: Parametros datePeriod: type: object allOf: – #/definitions/datePeriod description: Periodo needResult: type: boolean description: Arquivo de resposta necessário default: true attachLogs: type: boolean description: Incluir logs default: false encoding: type: string description: Encoding utilizado no processamento default: UTF-8 checkSignalInterval: type: integer format: int64 description: Intervalo de tempo para envio de prova de vida url: type: string description: URL para upload do arquivo type: string description: Versão da URL responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /gateway/events/importCommandEvent: 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 /gateway/events/exportCommandEvent: 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 /gateway/events/importInstanceEvent: 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 /gateway/events/exportInstanceEvent: 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 /gateway/entities/command: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/command responses: 200: description: The created resource schema: #/definitions/command 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/command responses: 200: description: The created resource schema: #/definitions/command 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 responses: 200: description: Ok schema: type: array items: #/definitions/command 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/entities/command/{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/command responses: 200: description: Ok schema: #/definitions/command 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/command responses: 200: description: Ok schema: #/definitions/command 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/command 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 /gateway/entities/command/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/command responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/entities/instance: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/instance responses: 200: description: The created resource schema: #/definitions/instance 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/instance responses: 200: description: The created resource schema: #/definitions/instance 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 responses: 200: description: Ok schema: type: array items: #/definitions/instance 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /gateway/entities/instance/{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/instance responses: 200: description: Ok schema: #/definitions/instance 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/instance responses: 200: description: Ok schema: #/definitions/instance 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/instance 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 /gateway/entities/instance/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/instance responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Status do Healthcheck type: string enum: – UP – DOWN stage: description: Estágio da carga type: string enum: – Preparing – Waiting – Started – Executing – Done – Cancelled – Error – Failed – Invalid connectionType: description: Tipo de conexão type: string enum: – Banco_de_Dados – Web_Services dataBaseKind: description: Tipo de execução da atualização type: string enum: – SqlServer – PostgreSQL – Oracle – Other – External commandType: description: Tipo de comando type: string enum: – SQL – SOAP – SHELL – HTTP – AUTOTEST connectionStatus: description: Status da conexão type: string enum: – Starting – Ending – Ok – WebSocketError – Checking – Inactive – Error – NeedUpdate soKind: description: Tipo de sistema operacional type: string enum: – Windows – Linux 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 checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckDTO description: Status datePeriod: description: Periodo de datas type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data de incial do período endDate: type: string format: date description: Data de final do período dbConnectionDTO: description: Conexão com banco de dados type: object required: – dataBaseKind – name – server – port – username – password properties: dataBaseKind: type: string allOf: – #/definitions/dataBaseKind description: Tipo de banco de dados enabled: type: boolean description: Ativa default: true name: type: string maxLength: 255 description: Nome da conexão server: type: string maxLength: 255 description: Servidor port: type: integer format: int64 description: Porta minimum: 1 username: type: string maxLength: 255 description: Usuário password: type: string maxLength: 255 description: Senha connectionUrl: type: string maxLength: 255 description: url de conexão userDTO: description: Dados de usuário type: object required: – username properties: username: type: string description: Nome do usuário para poder utilizar o gateway password: type: string description: Senha do usuário secret: true applicationDTO: description: Dados de aplicação type: object required: – key properties: key: type: string description: Nome do usuário para poder utilizar o gateway secret: type: string description: Senha do usuário secret: true instanceData: description: Dados da instância type: object required: – id – websocket properties: id: type: string description: ID websocket: type: boolean description: Recebeu a requisição por WebSocket command: description: Comando remoto type: object required: – command – stage – success – rowCount – tries properties: id: type: string format: uuid description: PK ticket: type: string format: uuid description: ID do ticket commandType: type: string allOf: – #/definitions/commandType description: Tipo de comando command: type: string maxLength: 64000 description: Comando url: type: string maxLength: 64000 description: URL para upload do arquivo blobVersion: type: string maxLength: 255 description: Versão da URL stage: type: string allOf: – #/definitions/stage description: Estagio success: type: boolean description: Sucesso rowCount: type: integer format: int64 description: Contagem de linhas needResult: type: boolean description: Arquivo de resposta necessário default: true attachLogs: type: boolean description: Incluir logs default: false tries: type: integer format: int64 description: Tentativas instance: type: object allOf: – #/definitions/instance description: Instância createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. instance: description: Instância type: object required: – clientVersion – username – hostname – servicePort – lastConnection – connectionStatus properties: id: type: string format: uuid description: PK soKind: type: string allOf: – #/definitions/soKind description: Sistema operacional clientVersion: type: string maxLength: 255 description: Versão do cliente username: type: string maxLength: 255 description: Usuário associado hostname: type: string maxLength: 255 description: Nome da maquina servicePort: type: integer format: int64 description: Porta do serviço lastConnection: type: string format: date-time description: Ultima conexão connectionStatus: type: string allOf: – #/definitions/connectionStatus description: Status da conexão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. 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