2.0info: 1.3.0-rework-fix-bf-32812bc5-SNAPSHOT yms_datalake description: Serviço de acesso as métricas extraida dos WMS x-senior-domain: yms x-senior-domain-path: yms x-senior-service-path: yms_datalake 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/ymssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /yms_datalake/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/serviceHealthStatus description: Status 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 responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status 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 /yms_datalake/queries/testTrino: post: description: uso exclusivo pra ver se o trino funciona tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – sucess properties: sucess: type: boolean description: sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: uso exclusivo pra ver se o trino funciona tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – sucess properties: sucess: type: boolean description: sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /yms_datalake/queries/getDashboardInfo: post: description: Busca as informações de um evento do ano corrente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – salesEventId properties: tags: type: array items: type: object allOf: – #/definitions/tagDto description: Filto de tags salesEventId: type: string description: Evento que quer buscar as informacoes responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/dashboardMetrics description: Dados sobre a black friday do ano corrente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /yms_datalake/queries/availableTags: post: description: Busca informacões de tags tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tags properties: tags: type: array items: type: object allOf: – #/definitions/tagDto minimum: 1 description: Lista de tags que existem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca informacões de tags tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tags properties: tags: type: array items: type: object allOf: – #/definitions/tagDto minimum: 1 description: Lista de tags que existem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /yms_datalake/queries/getSalesEvent: post: description: Listar eventos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/salesEvent minimum: 1 description: Eventos cadastrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar eventos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/salesEvent minimum: 1 description: Eventos cadastrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /yms_datalake/queries/getToggleTenants: post: description: Busca as opereções logisticas que não estão sendo exibidas no board tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/logisticOperationData description: Lista das informacoes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as opereções logisticas que não estão sendo exibidas no board tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/logisticOperationData description: Lista das informacoes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /yms_datalake/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 /yms_datalake/queries/exportSalesEvent: 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 /yms_datalake/queries/exportEventPeriod: 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 /yms_datalake/queries/exportCompanyPerfomance: 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 /yms_datalake/queries/exportCompany: 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 /yms_datalake/queries/exportTag: 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 /yms_datalake/queries/exportCompanyFilter: 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 /yms_datalake/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 /yms_datalake/actions/toggleVisibility: post: description: Altera a visibilidade uma operação logistica no dashboard administrativo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyIdentificationNumber properties: companyIdentificationNumber: type: string description: id da empresa responses: 200: description: Ok schema: type: object required: – visible properties: visible: type: boolean description: Retorna a visibilidade aplicada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /yms_datalake/actions/importSalesEvent: 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 /yms_datalake/actions/importEventPeriod: 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 /yms_datalake/actions/importCompanyPerfomance: 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 /yms_datalake/actions/importCompany: 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 /yms_datalake/actions/importTag: 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 /yms_datalake/actions/importCompanyFilter: 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 /yms_datalake/events/importSalesEventEvent: 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 /yms_datalake/events/exportSalesEventEvent: 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 /yms_datalake/events/importEventPeriodEvent: 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 /yms_datalake/events/exportEventPeriodEvent: 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 /yms_datalake/events/importCompanyPerfomanceEvent: 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 /yms_datalake/events/exportCompanyPerfomanceEvent: 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 /yms_datalake/events/importCompanyEvent: 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 /yms_datalake/events/exportCompanyEvent: 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 /yms_datalake/events/importTagEvent: 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 /yms_datalake/events/exportTagEvent: 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 /yms_datalake/events/importCompanyFilterEvent: 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 /yms_datalake/events/exportCompanyFilterEvent: 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 definitions: serviceHealthStatus: type: string enum: – UP – DOWN description: Define o Status do serviço: * `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 fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck tagDto: description: Tag de uma unidade logística type: object required: – title properties: type: string description: Título da tag dashboardMetrics: description: Dados para o Dashboard type: object required: – year – periods – clients properties: year: type: integer format: int64 description: Ano de referência periods: type: array items: type: object allOf: – #/definitions/dashboardDataPeriod minimum: 1 description: Periodos fixos clients: type: array items: type: object allOf: – #/definitions/dashboardDataClient minimum: 1 description: Clientes dashboardDataPeriod: description: Dados do periodo allOf: – #/definitions/dashboardData – type: object required: – thisYear – lastYear properties: type: string description: Titulo do cliente thisYear: type: object allOf: – #/definitions/periodReference description: Periodo desse ano lastYear: type: object allOf: – #/definitions/periodReference description: Ano passado dashboardDataClient: description: Dados do cliente allOf: – #/definitions/dashboardData – type: object properties: tenant: type: string description: Tenant do cliente companyName: type: string description: Nome da Empresa lastUpdate: type: string format: date-time description: Data de ultima atualização dashboardData: description: Dados sobre a Black Friday discriminator: _discriminator type: object required: – totalOrders – totalItems – _discriminator properties: totalOrders: type: integer format: int64 description: Total de pedidos no ultimo ano totalItems: type: integer format: int64 description: Total de Itens no ultimo ano yoyOrders: type: number format: double description: Percentual de pedidos ano a ano yoyItems: type: number format: double description: Percentual de itens ano a ano _discriminator: type: string description: periodReference: description: Periodo de referência type: object required: – start – end properties: start: type: string format: date description: Quando comeca o periodo end: type: string format: date description: Quando termina o periodo eventResumee: description: Resumo do evento type: object required: – year – totalOrders – totalItems – yoyGrowthOrders – yoyGrowthItems properties: year: type: integer format: int64 description: Ano totalOrders: type: integer format: int64 description: Número de notas totalItems: type: integer format: int64 description: Número de produtos yoyGrowthOrders: type: number format: double description: YOY do crescimento da quantidade de notas yoyGrowthItems: type: number format: double description: YOY do crescimento da quantidade de Itens logisticOperationData: description: Dados de uma operação logistica type: object required: – tenant – companyName properties: tenant: type: string description: Tenant companyName: type: string description: Nome salesEvent: description: Entidade que representa um evento de vendas type: object required: – name properties: id: type: string format: uuid description: Id do evento de vendas name: type: string description: Nome do evento de vendas eventPeriod: description: Entidade que representa um período do evento de vendas type: object required: – salesEvent – main – year – name – startDate properties: id: type: string format: uuid description: Id do período do evento salesEvent: type: object allOf: – #/definitions/salesEvent description: Evento main: type: boolean description: se é o principal periodo year: type: integer format: int64 description: ano name: type: string description: Nome do período do evento. Ex: Semana da blackFriday startDate: type: string format: date description: Data do início do período endDate: type: string format: date description: Data do fim do período companyPerfomance: description: Entidade que representa um dia da perfomance do cliente type: object required: – logisticOperationId – datePerfomance – totalItems – totalOrders properties: id: type: string format: uuid description: Id da perfomance do cliente logisticOperationId: type: string format: uuid description: Cliente ao qual irá consultar a performance datePerfomance: type: string format: date description: Data de vizualização da perfomance totalItems: type: integer format: int64 description: Total de itens totalOrders: type: integer format: int64 description: Total de pedidos totalInvoicing: type: string description: Faturamento total company: description: Cadastro de empresa type: object required: – name – active – companyIdentificationNumber – companyIdentificationType – tags properties: id: type: string format: uuid description: Identificador único do registro name: type: string description: Nome da empresa active: type: boolean description: Ativo companyIdentificationNumber: type: string description: Identificação da empresa companyIdentificationType: type: string description: Tipo de identificação da empresa tags: type: array items: type: object allOf: – #/definitions/tag minimum: 1 description: Tags ativa dessa empresa tag: description: Cadastro de tags type: object required: – title – companies properties: id: type: string format: uuid description: Identificador único do registro type: string description: Nome da empresa companies: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: Empresas com a tag companyFilter: description: Filtros pessoas type: object required: – username – company properties: id: type: string format: uuid description: Identificador único do registro username: type: string description: Nome da usuário company: type: object allOf: – #/definitions/company description: Empresa para filtrar fora 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 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