Mais pesquisados:Customização, Tutorial, Documentação

signer

80 views 0 04/11/2022 Atualizado em 05/08/2024 integrador

2.0info: 1.2.2 signer description: HCM – Signer x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: signer 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: /signer/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/queries/getCertificateList: post: description: Retorna certificados pelo filtro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – certificateFilter properties: certificateFilter: type: object allOf: – #/definitions/certificateFilterDTO description: filtro do certificado responses: 200: description: Ok schema: type: object required: – count – totalPages – certificateToList properties: count: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de páginas certificateToList: type: array items: type: object allOf: – #/definitions/certificateToListDTO minimum: 1 description: certificado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/queries/getStatusSignature: post: description: Retorna status da pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketID properties: ticketID: type: string description: Id da pendência responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/pendencyStatus description: Status da pendência message: type: string description: Mensagem de erro urlDocumentSigned: type: string description: URL do documento assinado no S3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna status da pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticketID description: Id da pendência in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/pendencyStatus description: Status da pendência message: type: string description: Mensagem de erro urlDocumentSigned: type: string description: URL do documento assinado no S3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/queries/getStatusSignatureXT: post: description: Retorna status da pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – token – ticketID properties: token: type: string description: Token JWT ticketID: type: string description: Id da pendência responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/pendencyStatus description: Status da pendência message: type: string description: Mensagem de erro urlDocumentSigned: type: string description: URL do documento assinado no S3 default: description: Error response schema: #/definitions/genericError get: description: Retorna status da pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: token description: Token JWT in: query required: true type: string – name: ticketID description: Id da pendência in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/pendencyStatus description: Status da pendência message: type: string description: Mensagem de erro urlDocumentSigned: type: string description: URL do documento assinado no S3 default: description: Error response schema: #/definitions/genericError /signer/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 /signer/queries/exportCertificate: 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 /signer/queries/exportPendency: 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 /signer/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 /signer/actions/saveCertificate: post: description: Salvar Certificado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – certificate properties: certificate: type: object allOf: – #/definitions/certificateDTO description: Certificado responses: 200: description: Ok schema: type: object required: – certificateId properties: certificateId: type: string description: Certificado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/actions/getSignedUrlFile: post: description: Recupera uma URL assinada e temporária para o arquivo assinado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId – fileName – ticketID properties: clientId: type: string description: Id do cliente fileName: type: string description: Nome do arquivo ticketID: type: string description: ID da pendência responses: 200: description: Ok schema: type: object required: – signedUrl properties: signedUrl: type: string description: Url arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/actions/requestICPSignature: post: description: Requisição de assinatura de documento para sistemas X tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashDocument – fileSize – fileName – certificateType – signatureType – signaturePattern – requesterOrigen – userGeneration properties: hashDocument: type: string description: Hash da identidade do documento fileSize: type: number format: double description: Tamanho do arquivo fileName: type: string description: Nome do arquivo certificateType: type: string allOf: – #/definitions/certificateType description: Tipo de certificado signatureType: type: string allOf: – #/definitions/signatureType description: Tipo de Assinatura signaturePattern: type: string allOf: – #/definitions/signaturePattern description: Padrão ICP-Brasil a ser utilizado requesterOrigen: type: string description: Origem da requisição userGeneration: type: string description: Usuário que requisitou responses: 200: description: Ok schema: type: object required: – ticketID – uploadURL properties: ticketID: type: string description: Ticket uploadURL: type: string description: Caminho do arquivo assinado no S3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/actions/requestICPSignatureXT: post: description: Requisição de assinatura de documentos para sistemas XT tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – token – codcli – userGeneration – hashDocument – fileName – signatureType – signaturePattern properties: token: type: string description: token JWT codcli: type: string description: Cliente codcli userGeneration: type: string description: Usuário que está gravando a pendência hashDocument: type: string description: Hash da identidade do documento fileSize: type: number format: double description: Tamanho do arquivo fileName: type: string description: nome do arquivo certificateType: type: string allOf: – #/definitions/certificateType description: Tipo do certificado signatureType: type: string allOf: – #/definitions/signatureType description: Tipo de Assinatura signaturePattern: type: string allOf: – #/definitions/signaturePattern description: Padrão ICP-Brasil a ser utilizado responses: 200: description: Ok schema: type: object required: – ticketID – uploadURL properties: ticketID: type: string description: Id da pendência uploadURL: type: string description: URL para upload no bucket default: description: Error response schema: #/definitions/genericError /signer/actions/confirmUploadSignature: post: description: Endpoint para Assinatura de leiaute dos modelos fiscais vindo do ambiente X tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketID properties: ticketID: type: string description: Identificador da pendência responses: 200: description: Ok schema: type: object required: – ticketID properties: ticketID: type: string description: Identificador do pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/actions/confirmBatchUploadSignature: post: description: Endpoint para Assinatura de leiaute dos modelos fiscais vindo do ambiente X tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketID properties: ticketID: type: string description: Identificador da pendência responses: 200: description: Ok schema: type: object required: – ticketID properties: ticketID: type: string description: Identificador do pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/actions/confirmUploadSignatureXT: post: description: Endpoint para Assinatura de leiaute dos modelos fiscais vindo do ambiente XT tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – token – ticketID properties: token: type: string description: Token de identificação JWT ticketID: type: string description: Identificador da pendência responses: 200: description: Ok schema: type: object required: – ticketID properties: ticketID: type: string description: Identificador do pendência default: description: Error response schema: #/definitions/genericError /signer/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 /signer/actions/importCertificate: 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 /signer/actions/importPendency: 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 /signer/events/ticketStatusUpdate: post: description: Evento com informações dos tickets x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticketID – fileName – pendencyStatus – requesterOrigen – requesterUser properties: ticketID: type: string description: Ticket urlDocumentSigned: type: string description: Url do documento assinado em caso da pendência estar assinada hashDocumentSigned: type: string description: Hash do documento assinado em caso da pendência estar assinada fileName: type: string description: Nome do arquivo pendencyStatus: type: string description: Status da pendência requesterOrigen: type: string description: Requerente original da ação que gerou a pendência requesterUser: type: string description: Nome do usuário da plataforma requisitante message: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /signer/events/importCertificateEvent: 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 /signer/events/exportCertificateEvent: 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 /signer/events/importPendencyEvent: 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 /signer/events/exportPendencyEvent: 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 /signer/entities/certificate: 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/certificate responses: 200: description: The created resource schema: #/definitions/certificate 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/certificate responses: 200: description: The created resource schema: #/definitions/certificate 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/certificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /signer/entities/certificate/{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/certificate responses: 200: description: Ok schema: #/definitions/certificate 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/certificate responses: 200: description: Ok schema: #/definitions/certificate 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/certificate 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 /signer/entities/certificate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/certificate 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 certificateType: description: Tipo de certificado type: string enum: – PHYSICAL_PERSON – LEGAL_PERSON signaturePattern: description: Padrão de Assinatura ICP-Brasil type: string enum: – CADES – PADES orderType: description: Valores de timeout type: string enum: – ASC – DESC signatureType: description: Tipo de assinatura type: string enum: – P7S_DETACHED – PDF pendencyStatus: description: Status da pendência type: string enum: – UPLOAD – PENDING – SIGNED – ERROR signatureOrigin: description: Origem da assinatura type: string enum: – XT – X 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: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status certificateFilterDTO: description: filtro da listagem de certificados type: object required: – pageInfoDto properties: filterDescription: type: string description: descrição do filtro initialDate: type: string format: date-time description: Data inicio do histórico finalDate: type: string format: date-time description: Data fim do histórico certificateType: type: string allOf: – #/definitions/certificateType description: Tipo de certificado pageInfoDto: type: object allOf: – #/definitions/pageInfoDto description: Paginação sort: type: object allOf: – #/definitions/sortDto description: Ordenação certificateToListDTO: description: Dados para listagem dos certificados type: object required: – id – description – initialDate – finalDate – certificateType properties: id: type: string description: ID description: type: string description: Descrição do certificado initialDate: type: string format: date-time description: Data inicio do histórico finalDate: type: string format: date-time description: Data fim do histórico certificateType: type: string allOf: – #/definitions/certificateType description: Tipo de certificado pageInfoDto: description: DTO de paginação type: object required: – pageSize – page properties: pageSize: type: integer format: int64 description: Quantidade de registros por pagina page: type: integer format: int64 description: Pagina atual sortDto: description: DTO de Ordenação type: object properties: field: type: string description: Campo order: type: string allOf: – #/definitions/orderType description: Ordenação certificateDTO: description: Representação do certificado type: object required: – description – initialDate – certificateType – certificate – password – validityTime properties: description: type: string description: Descrição initialDate: type: string format: date-time description: Data inicio do histórico finalDate: type: string format: date-time description: Data fim do histórico certificateType: type: string allOf: – #/definitions/certificateType description: Tipo de certificado certificate: type: string format: byte description: Arquivo do Certificado password: type: string description: Password certificado validityTime: type: string format: date-time description: Validade do certificado certificate: description: Certificado digital type: object required: – id – description – initialDate – certificateType – certificate – password – validityTime – salt – iv properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição do certificado initialDate: type: string format: date-time description: Data inicio do histórico finalDate: type: string format: date-time description: Data fim do histórico certificateType: type: string allOf: – #/definitions/certificateType description: Tipo de certificado certificate: type: string format: byte description: Certificado password: type: string description: Password certificado validityTime: type: string format: date-time description: Validade do certificado salt: type: string description: Salt iv: type: string format: byte description: IV createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pendency: description: Pendência da assinatura type: object required: – id – fileName – client – urlDocument – hashDocument – certificateType – signatureType – pendencyStatus – originSignature – dateGeneration – userGeneration – signaturePattern properties: id: type: string format: uuid description: Identificador único fileName: type: string description: Nome do arquivo client: type: string description: Cliente cocli ou tenant urlDocument: type: string description: URL do documento no S3 hashDocument: type: string description: Hash da identidade do documento urlDocumentSigned: type: string description: URL do documento assinado no S3 hashDocumentSigned: type: string description: Hash da identidade do documento assinado certificateType: type: string allOf: – #/definitions/certificateType description: Tipo do certificado signatureType: type: string allOf: – #/definitions/signatureType description: Tipo da assinatura pendencyStatus: type: string allOf: – #/definitions/pendencyStatus description: Status da pendência originSignature: type: string allOf: – #/definitions/signatureOrigin description: Origem da assinatura message: type: string description: Mensagem de erro fileSize: type: number format: double description: Tamanho do arquivo dateGeneration: type: string format: date-time description: Data da geração da pendência dateSignature: type: string format: date-time description: Data da assinatura da pendência userGeneration: type: string description: Usuário que está gravando a pendência signaturePattern: type: string allOf: – #/definitions/signaturePattern description: Padrão ICP-Brasil a ser utilizado requesterOrigen: type: string description: Requerente da ação geradora da pendência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação