2.0info: 6.5.0 esocial2edoc description: Serviço do e-Social para o eDoc. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: esocial2edoc 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/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /esocial2edoc/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/heathcheckDTO 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/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 /esocial2edoc/queries/exportEdocsConfiguration: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial2edoc/queries/exportGeneralConfiguration: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial2edoc/queries/exportLayoutProcess: post: description: tags: – Queries x-senior-visibility: PUBLIC 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 /esocial2edoc/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /esocial2edoc/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/actions/importEdocsConfiguration: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial2edoc/actions/importGeneralConfiguration: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial2edoc/actions/importLayoutProcess: post: description: tags: – Actions x-senior-visibility: PUBLIC 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 /esocial2edoc/signals/layoutsProcessWorkBatch: post: description: Realiza o envio de um lote de layout do e-Social para o e-Doc. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – layoutSummaryBatch properties: layoutSummaryBatch: type: array items: type: object allOf: – #/definitions/layoutSummary minimum: 1 description: Lista de Ids da situação do layout no eSocial. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial2edoc/signals/returnGovernmentIntegration: post: description: Endpoint que quando ativado busca as informações de retorno referentes aos eventos eSocial que foram enviados ao eDocs tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial2edoc/signals/saveEdocsConfigurationAsync: post: description: Salva uma configuração do eDocs de modo assincrono tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – edocsConfiguration properties: edocsConfiguration: type: object allOf: – #/definitions/edocsConfiguration description: Configuração do eDocs que será salva responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial2edoc/signals/deleteEdocsConfigurationAsync: post: description: Delete uma configuração do eDocs de modo assincrono tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companySettingId properties: companySettingId: type: string description: Configuração do eDocs que será deletada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /esocial2edoc/events/importEdocsConfigurationEvent: 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 /esocial2edoc/events/exportEdocsConfigurationEvent: 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 /esocial2edoc/events/importGeneralConfigurationEvent: 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 /esocial2edoc/events/exportGeneralConfigurationEvent: 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 /esocial2edoc/events/importLayoutProcessEvent: 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 /esocial2edoc/events/exportLayoutProcessEvent: 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 /esocial2edoc/entities/edocsConfiguration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/edocsConfiguration responses: 200: description: The created resource schema: #/definitions/edocsConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/edocsConfiguration responses: 200: description: The created resource schema: #/definitions/edocsConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/edocsConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/entities/edocsConfiguration/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/edocsConfiguration responses: 200: description: Ok schema: #/definitions/edocsConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/edocsConfiguration responses: 200: description: Ok schema: #/definitions/edocsConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/edocsConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /esocial2edoc/entities/edocsConfiguration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/edocsConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/entities/generalConfiguration: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalConfiguration responses: 200: description: The created resource schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalConfiguration responses: 200: description: The created resource schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/entities/generalConfiguration/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalConfiguration responses: 200: description: Ok schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalConfiguration responses: 200: description: Ok schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/generalConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /esocial2edoc/entities/generalConfiguration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/generalConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/entities/layoutProcess: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutProcess responses: 200: description: The created resource schema: #/definitions/layoutProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/layoutProcess responses: 200: description: The created resource schema: #/definitions/layoutProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/layoutProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /esocial2edoc/entities/layoutProcess/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/layoutProcess responses: 200: description: Ok schema: #/definitions/layoutProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/layoutProcess responses: 200: description: Ok schema: #/definitions/layoutProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/layoutProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /esocial2edoc/entities/layoutProcess/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/layoutProcess responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: certSubscriptionType: description: Tipo de inscrição type: string enum: – CNPJ – CPF – EMPTY_STATE environmentIdType: description: Tipo de identificação do ambiente. type: string enum: – PRODUCTION – RESTRICT_PRODUCTION heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN layoutType: description: Tipo do layout do eSocial. type: string enum: – S2210 – S2220 – S2240 – S3000 processStatusType: description: Status do processo. type: string enum: – TO_PROCESS – ERROR_XML_GENERATION – EDOC_SUBMISSION_ERROR – EDOC_RETURN_FETCHING_ERROR – ACCEPTED_BY_EDOC – REFUSED_BY_EDOC – GOVERNMENT_CRITICISM – GOVERNMENT_RECEIPT_NUMBER returnStatus: description: Status da ultima tentativa de retorno do governo type: string enum: – NO_RETURN – GENERIC_ERROR – VALID_RETURN subscriptionType: description: Tipo de inscrição. type: string enum: – CNPJ – CPF – CAEPF – CNO 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 – 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: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status layoutSummary: description: Resumo do evento type: object required: – layoutSituationId – environmentIdType – employerDocumentNumber – employerDocumentType – xml – layoutType – configurationId properties: layoutSituationId: type: string maxLength: 36 description: Id da entidade layoutSituation no eSocial que originou esse resumo de evento eventId: type: string maxLength: 36 description: Id do evento eSocial environmentIdType: type: string allOf: – #/definitions/environmentIdType description: Tipo do ambiente employerDocumentNumber: type: string maxLength: 15 description: Número de inscrição do empregador employerDocumentType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição do empregador xml: type: string description: XML do evento eSocial layoutType: type: string allOf: – #/definitions/layoutType description: Tipo do evento eSocial configurationId: type: string maxLength: 36 description: Identificador da configuração. edocsConfiguration: description: Configuração de empresa para comunicação com o eDocs type: object required: – externalId properties: id: type: string format: uuid description: Id da entidade. externalId: type: string description: Id da entidade de companySetting no eSocial que originou essa configuração status: type: boolean description: Flag indicando se a configuração está ativa ou não urlEDoc: type: string maxLength: 500 description: URL eDocs. userEDoc: type: string maxLength: 100 description: Usuário eDocs. passEDoc: type: string maxLength: 100 description: Senha eDocs. urlEDocHomologation: type: string maxLength: 500 description: URL eDocs Homologação. userEDocHomologation: type: string maxLength: 100 description: Usuário eDocs Homologação. passEDocHomologation: type: string maxLength: 100 description: Senha eDocs Homologação. subscriptionNumberCert: type: string maxLength: 15 description: Número de inscrição do certificado digital. subscriptionTypeCert: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital.\n 1 – CNPJ\n 2 – CPF subscriptionNumberCertHomolog: type: string maxLength: 15 description: Número de inscrição do certificado digital Homologação. subscriptionTypeCertHomolog: type: string allOf: – #/definitions/certSubscriptionType description: Tipo inscrição do certificado digital Homologação.\n 1 – CNPJ\n 2 – CPF generalConfiguration: description: Configurações gerais do sistema type: object required: – returnGovernmentIntegration properties: id: type: string format: uuid description: Id da entidade returnGovernmentIntegration: type: boolean description: Flag indicando se o endpoint returnGovernmentIntegration deve ser executado layoutProcess: description: Processo de envio do layout. type: object required: – processDate – layoutSituationId – processStatusType – environmentIdType – employerDocumentNumber – employerDocumentType – configurationId properties: id: type: string format: uuid description: Id do processo. processDate: type: string format: date-time description: Data e hora do processamento. layoutSituationId: type: string maxLength: 36 description: Id da situação do layout. eventId: type: string maxLength: 36 description: Identificador do evento. processStatusType: type: string allOf: – #/definitions/processStatusType description: Status do processo. receiptNumber: type: string description: Número de recibo. layoutMessage: type: string description: Mensagem do layout (Críticas / Erros do e-Doc ou Governo). environmentIdType: type: string allOf: – #/definitions/environmentIdType description: Tipo de ambiente. employerDocumentNumber: type: string maxLength: 15 description: Número de inscrição do empregador employerDocumentType: type: string allOf: – #/definitions/subscriptionType description: Tipo de inscrição do empregador returnStatus: type: string allOf: – #/definitions/returnStatus description: Último retorno do governo configurationId: type: string maxLength: 36 description: Identificador da configuração. 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