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

client_area_integration_bifrost

36 views 0 24/07/2020 Atualizado em 07/03/2023 integrador

2.0info: 8.2.0 client_area_integration_bifrost description: Serviço de controle de integração x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: client_area_integration_bifrost contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /client_area_integration_bifrost/queries/checkResetDatabaseSchemaAvailable: post: description: Verifica se o reinício da base de dados está disponível. Notar que a permissão do usuário para a execução da primitiva (@see resetDatabaseSchema) não é considerada.\n O reinício da base de dados está disponível desde que não hajam cargas iniciais iniciadas a mais de 30 dias. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – available properties: available: type: boolean description: Indicativo da disponibilidade para reiniciar a base de dados default: description: Error response schema: #/definitions/genericError get: description: Verifica se o reinício da base de dados está disponível. Notar que a permissão do usuário para a execução da primitiva (@see resetDatabaseSchema) não é considerada.\n O reinício da base de dados está disponível desde que não hajam cargas iniciais iniciadas a mais de 30 dias. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – available properties: available: type: boolean description: Indicativo da disponibilidade para reiniciar a base de dados default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/retrieveResetKey: post: description: Recuperar chave para execução do reinício da base de dados. A validade da chave gerada é de 5 minutos e somente pode ser usada para o mesmo inquilino e usuário. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – key – tenant properties: key: type: string description: Chave gerada para ser usada nas chamadas de reinício da base de dados tenant: type: string description: Inquilino para o qual a chave foi gerada default: description: Error response schema: #/definitions/genericError get: description: Recuperar chave para execução do reinício da base de dados. A validade da chave gerada é de 5 minutos e somente pode ser usada para o mesmo inquilino e usuário. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – key – tenant properties: key: type: string description: Chave gerada para ser usada nas chamadas de reinício da base de dados tenant: type: string description: Inquilino para o qual a chave foi gerada default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/searchSyncPendency: post: description: Retorna as pendências de replicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – offset – size properties: id: type: string description: Filtro por identificador da pendência e quando informado os demais filtros são desconsiderados hubs: type: array items: type: string description: Filtro por nome dos hubs sourceIdents: type: array items: type: string description: Filtro pelo identificador da origem statuses: type: array items: type: string allOf: – #/definitions/enumSyncPendencyStatus description: Filtro por estado das pendências includedOnInterval: type: object allOf: – #/definitions/recDateTimeInterval description: Intervalo de filtro por data/hora de inclusão da pendência lastProcessedOnInterval: type: object allOf: – #/definitions/recDateTimeInterval description: Intervalo de filtro por data/hora do último processamento da pendência payload: type: string description: Filtro pelo conteúdo da mensagem sequenceOrderInit: type: integer format: int64 description: Filtro de sequência (maior ou igual) sequenceOrderEnd: type: integer format: int64 description: Filtro de sequência (menor ou igual) sourceSequenceInit: type: integer format: int64 description: Filtro de sequência na origem (maior ou igual) sourceSequenceEnd: type: integer format: int64 description: Filtro de sequência na origem (menor ou igual) syncOperations: type: array items: type: string allOf: – #/definitions/enumSyncPendencyOperation description: Filtro pela operação offset: type: integer format: int64 description: Posição do registro inicial minimum: 0 size: type: integer format: int64 description: Quantidade de registros a ser retornada minimum: 1 maximum: 100 responses: 200: description: Ok schema: type: object required: – totalElements properties: pendencies: type: array items: type: object allOf: – #/definitions/recSyncPendency description: Lista de pendências de replicação totalElements: type: integer format: int64 description: Quantidade total de registros default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getSyncPendencyFailures: post: description: Retorna as falhas de uma pendência de replicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – syncPendencyId properties: syncPendencyId: type: string description: Identificador da pendência de replicação responses: 200: description: Ok schema: type: object properties: failures: type: array items: type: object allOf: – #/definitions/recSyncPendencyFailure description: Falhas da pendência default: description: Error response schema: #/definitions/genericError get: description: Retorna as falhas de uma pendência de replicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: syncPendencyId description: Identificador da pendência de replicação in: query required: true type: string responses: 200: description: Ok schema: type: object properties: failures: type: array items: type: object allOf: – #/definitions/recSyncPendencyFailure description: Falhas da pendência default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getSyncPendencyRejection: post: description: Retorna os detalhes da rejeição da pendência de replicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – syncPendencyId properties: syncPendencyId: type: string description: Identificador da pendência de replicação responses: 200: description: Ok schema: type: object required: – details properties: details: type: string description: Detalhes da rejeição default: description: Error response schema: #/definitions/genericError get: description: Retorna os detalhes da rejeição da pendência de replicação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: syncPendencyId description: Identificador da pendência de replicação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – details properties: details: type: string description: Detalhes da rejeição default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getHubs: post: description: Retorna o nome de todos os hubs tratados na integração tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: hubs: type: array items: type: string description: Lista com o nome de todos os hubs default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome de todos os hubs tratados na integração tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: hubs: type: array items: type: string description: Lista com o nome de todos os hubs default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getSourceIdents: post: description: Retorna os identificadores de origem da tabela de pendências de replicação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: sourceIdents: type: array items: type: string description: Identificadores de origem da tabela de pendências de replicação default: description: Error response schema: #/definitions/genericError get: description: Retorna os identificadores de origem da tabela de pendências de replicação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: sourceIdents: type: array items: type: string description: Identificadores de origem da tabela de pendências de replicação default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getInitialLoadControls: post: description: Busca os controles de carga inicial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: initialLoadControlGroups: type: array items: type: object allOf: – #/definitions/recInitialLoadControlGroup description: Lista de agrupamentos de controles de carga inicial default: description: Error response schema: #/definitions/genericError get: description: Busca os controles de carga inicial tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: initialLoadControlGroups: type: array items: type: object allOf: – #/definitions/recInitialLoadControlGroup description: Lista de agrupamentos de controles de carga inicial default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getInitialLoadPendenciesAndGeneralFault: post: description: Busca as pendências de um controle de carga inicial, bem como dados de falha geral.\n Notar que as pendências de controle de carga inicial só existem para os registro de carga inicial que falharam em algum momento\n (mesmo que atualmente estejam integrados corretamento) – registro que foram integrados corretamente já na primeira tentativa, não possuem uma pendência registrada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – initialLoadControlId properties: initialLoadControlId: type: string description: Identificador do controle de carga inicial page: type: object allOf: – #/definitions/recPage description: Pagina usada para paginação responses: 200: description: Ok schema: type: object required: – totalElements properties: initialLoadPendencies: type: array items: type: object allOf: – #/definitions/recInitialLoadPendency description: Lista de pendências do controle de carga inicial generalFault: type: object allOf: – #/definitions/recInitialLoadGeneralFault description: Registro de falha geral totalElements: type: integer format: int64 description: Total de elementos default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getInitialLoadPendencyExecutions: post: description: Busca os registros de execução de pendência de carga inicial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – initialLoadPendencyId properties: initialLoadPendencyId: type: string description: Identificador da pendência de carga inicial responses: 200: description: Ok schema: type: object required: – pendencyExecutions properties: pendencyExecutions: type: array items: type: object allOf: – #/definitions/recInitialLoadPendencyExecution minimum: 1 description: Lista de registros de execução da pendência de carga inicial default: description: Error response schema: #/definitions/genericError get: description: Busca os registros de execução de pendência de carga inicial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: initialLoadPendencyId description: Identificador da pendência de carga inicial in: query required: true type: string responses: 200: description: Ok schema: type: object required: – pendencyExecutions properties: pendencyExecutions: type: array items: type: object allOf: – #/definitions/recInitialLoadPendencyExecution minimum: 1 description: Lista de registros de execução da pendência de carga inicial default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getBifrostInfo: post: description: Retorna as informações do Bifrost tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – version – domainLabel – ownerServiceLabel properties: type: string description: Versão do Bifrost domainLabel: type: string description: Título do domínio do Bifrost (traduzido) ownerServiceLabel: type: string description: Título do serviço hospedeiro do Bifrost (traduzido) default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do Bifrost tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – version – domainLabel – ownerServiceLabel properties: type: string description: Versão do Bifrost domainLabel: type: string description: Título do domínio do Bifrost (traduzido) ownerServiceLabel: type: string description: Título do serviço hospedeiro do Bifrost (traduzido) default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getUrlUpload: post: description: Obter URL para upload do arquivo CSV tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – id – url – fileName – fileVersion properties: id: type: string description: Id do arquivo url: type: string description: URL para upload do arquivo fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo default: description: Error response schema: #/definitions/genericError get: description: Obter URL para upload do arquivo CSV tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fileName description: Nome do arquivo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – url – fileName – fileVersion properties: id: type: string description: Id do arquivo url: type: string description: URL para upload do arquivo fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getCSVModel: post: description: Retorna o modelo de CSV esperado para realizar a carga inicial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – initialLoadName properties: initialLoadName: type: string description: Nome da carga inicial responses: 200: description: Ok schema: type: object required: – csvModel properties: csvModel: type: string description: Modelo do CSV em base64 default: description: Error response schema: #/definitions/genericError get: description: Retorna o modelo de CSV esperado para realizar a carga inicial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: initialLoadName description: Nome da carga inicial in: query required: true type: string responses: 200: description: Ok schema: type: object required: – csvModel properties: csvModel: type: string description: Modelo do CSV em base64 default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/queries/getCSVInitialLoadDefinitions: post: description: Retorna as definições de carga inicial por CSV tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – csvInitialLoadDefinitions properties: csvInitialLoadDefinitions: type: array items: type: object allOf: – #/definitions/recCSVInitialLoadDefinition minimum: 1 description: Definições de carga inicial por CSV default: description: Error response schema: #/definitions/genericError get: description: Retorna as definições de carga inicial por CSV tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – csvInitialLoadDefinitions properties: csvInitialLoadDefinitions: type: array items: type: object allOf: – #/definitions/recCSVInitialLoadDefinition minimum: 1 description: Definições de carga inicial por CSV default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/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: 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: default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/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 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 default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/actions/ignorePendency: post: description: Ignora (para que não seja mais processada) uma pendência de replicação que esteja pendente ou com falha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pendência de replicação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/actions/resetDatabaseSchema: post: description: Reinicia o esquema da base de dados. É necessário que se tenha obtido anteriormente a chave de execução através da primitiva (@see retrieveResetKey).\n A execução desta primitiva obedece a mesma regra de disponibilidade descrita na primitiva (@see checkResetDatabaseSchemaAvailable). tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – key properties: key: type: string description: Chave recebida para autorização de execução de reinício da base de dados responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/actions/partialResetDatabaseSchema: post: description: Reinicia o esquema da base de dados utilizando scripts personalizados. É necessário que se tenha obtido anteriormente a chave de execução através da primitiva (@see retrieveResetKey). tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – key properties: key: type: string description: Chave recebida para autorização de execução de reinício da base de dados responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/actions/reprocessFailedPendencies: post: description: Reprocessa uma lista de pendências de replicação com falha. O processamento das pendências é individual e caso ocorra exceção, está é logada e a próxima é processada. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – syncPendencyIds properties: syncPendencyIds: type: array items: type: string minimum: 1 description: Lista de identificadores únicos das pendências de replicação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/actions/saveFile: post: description: Confirma a gravação do arquivo no serviço na versão em que ocorreu o upload tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName – fileVersion properties: fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/processHub: post: description: Inicia o processamento das pendências de replicação de um hub de integração tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – hubName properties: hubName: type: string description: Nome do hub de integração responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/reprocessAutomaticEligibleFailedPendencies: post: description: Reprocessamento das pendências de replicação com falha elegíveis para reprocessamento automático.\n Os critérios de elegibilidade são: situação de falha e número de tentativas menor que cinco.\n As execuções de reprocessamento irão obedecer o seguinte escalonamento:\n – Segunda tentativa: 1 minuto após a tentativa anterior.\n – Terceira tentativa: 15 minutos após a tentativa anterior.\n – Quarta tentativa: 1 hora após a tentativa anterior.\n – Quinta tentativa: 12 horas após a tentativa anterior. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/processAllInitialsLoad: post: description: Inicia processo de carga inicial, avaliando quais cargas iniciais ou complementares ainda estão pendentes. Caso não haja qualquer carga inicial ou complementar pendente de execução, nada é feito tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/updateIntegrationConfiguration: post: description: Atualiza as configurações de integração tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/continueInitialLoad: post: description: Continua uma carga inicial que não tenha sido processada, mas já tenha recebido os dados – situação que geralmente ocorre quando a carga inicial recebe os dados, mas não pode ser executada por causa de dependências não finalizadas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – name – complementVersion properties: name: type: string description: Nome da carga inicial complementVersion: type: string description: Versão da carga inicial responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/cleanOldSyncPendencies: post: description: Limpa pendências de replicação antigas da base de dados tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/countTenantFailures: post: description: Realiza a contagem de falhas de integração no bifrost de determinado tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area_integration_bifrost/signals/processCSVInitialLoad: post: description: Realiza a carga inicial apartir de um arquivo CSV tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – name – fileName – fileVersion properties: name: type: string description: Nome da carga inicial fileName: type: string description: Nome do arquivo CSV fileVersion: type: string description: Versão do arquivo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: enumSyncPendencyStatus: description: Estado de pendência de replicação type: string enum: – Pending – Blocked – Accepted – Rejected – Failed – Overfailed – Ignored enumSyncPendencyOperation: description: Operação de pendência de replicação type: string enum: – Event – Insert – Update – Delete enumInitialLoadControlStatus: description: Situações dos controles de carga inicial type: string enum: – Pending – WaitingData – DataReceived – Processing – Success – Failed – GeneralFault enumInitialLoadPendencyStatus: description: Situações da pendência de carga inicial type: string enum: – Accepted – Rejected – Failed – Locked enumInitialLoadPendencyExecutionStatus: description: Situações de execução de processamento type: string enum: – Accepted – Rejected – Failed recPage: description: Pagina para paginacao type: object required: – limit – offset properties: limit: type: integer format: int64 description: Limite da pagina offset: type: integer format: int64 description: deslocação da pagina recSyncPendency: description: Pendência de replicação type: object required: – id – hub – sourceName – sourceIdent – status – syncOperation – payload – attempts – includedOn properties: id: type: string description: Identificador hub: type: string description: Nome do hub sequenceOrder: type: integer format: int64 description: Sequencia sourceName: type: string description: Nome da origem da pendência sourceIdent: type: string description: Identificação advinda da origem da pendência status: type: string allOf: – #/definitions/enumSyncPendencyStatus description: Estado da pendência syncOperation: type: string allOf: – #/definitions/enumSyncPendencyOperation description: Operação da pendência payload: type: string description: Conteúdo da pendência attempts: type: integer format: int64 description: Quantidade de tentativas de processamento includedOn: type: string format: date-time description: Data/Hora de inclusão da pendência lastProcessedOn: type: string format: date-time description: Data/Hora do último processamento sourceSequence: type: integer format: int64 description: Sequência da pendência na origem recSyncPendencyFailure: description: Falha da pendência de replicação type: object required: – id – syncPendencyId – attemptNumber – message – occurredOn properties: id: type: string description: Identificador de falha da pendência syncPendencyId: type: string description: Identificador da pendência de replicação attemptNumber: type: integer format: int64 description: Número da tentativa de processamento message: type: string description: Mensagem da falha details: type: string description: Detalhes da falha occurredOn: type: string format: date-time description: Data/Hora da ocorrência da falha recDateTimeInterval: description: Intervalo de tempo type: object required: – init – end properties: init: type: string format: date-time description: Data e hora inicial end: type: string format: date-time description: Data e hora final recInitialLoadControlGroup: description: Agrupamento de controles de carga inicial de mesmo nome type: object required: – name – initialLoadControls properties: name: type: string description: Nome do controle de carga inicial initialLoadControls: type: array items: type: object allOf: – #/definitions/recInitialLoadControl minimum: 1 description: Controles de cargas iniciais recInitialLoadControl: description: Controle de carga inicial type: object required: – id – name – complementVersion – status – includedOn properties: id: type: string description: Identificador do controle da carga inicial name: type: string description: Nome do controle da carga inicial complementVersion: type: string description: Versão da carga complementar status: type: string allOf: – #/definitions/enumInitialLoadControlStatus description: Situação do controle da carga inicial dataInfo: type: string description: Informações sobre a origem dos dados da carga inicial recordAmount: type: integer format: int64 description: Quantidade de registros processados pela carga inicial includedOn: type: string format: date-time description: Data/Hora de inclusão do controle da carga inicial dataReceivedOn: type: string format: date-time description: Data/hora do recebimento dos dados para carga inicial processStartedOn: type: string format: date-time description: Data/hora do início do processamento da carga inicial (após o recebimento de dados e resolução das dependências) processFinishedOn: type: string format: date-time description: Data/hora do fim do processamento da carga inicial recInitialLoadPendency: description: Pendência de controle de carga inicial type: object required: – id – payload – status – attempts – includedOn properties: id: type: string description: Identificador da pendência de controle de carga inicial payload: type: string description: Conteúdo da pendência status: type: string allOf: – #/definitions/enumInitialLoadPendencyStatus description: Situação da pendência de controle de carga inicial attempts: type: integer format: int64 description: Número de tentativas de execução includedOn: type: string format: date-time description: Data/hora da inclusão do controle de carga inicial recInitialLoadGeneralFault: description: Registro de falha geral da carga inicial type: object required: – id – message – occurredOn properties: id: type: string description: Identificador da falha geral message: type: string description: Mensagem da falha details: type: string description: Detalhes da falha occurredOn: type: string format: date-time description: Data/Hora da ocorrência recInitialLoadPendencyExecution: description: Registro de execução de pendência de carga inicial type: object required: – id – attemptNumber – status – processStartedOn – processFinishedOn – processUser properties: id: type: string description: Identificador da execução de pendência de carga inicial attemptNumber: type: integer format: int64 description: Número da tentativa de execução status: type: string allOf: – #/definitions/enumInitialLoadPendencyExecutionStatus description: Situação da execução processStartedOn: type: string format: date-time description: Data/hora do início de processamento da pendência processFinishedOn: type: string format: date-time description: Data/hora do final de processamento da pendência processUser: type: string description: Usuário que requisitou o processamento da pendência message: type: string description: Mensagem da falha details: type: string description: Detalhes da falha recCSVInitialLoadDefinition: description: Registro de definição de carga inicial por CSV type: object required: – name – description properties: name: type: string description: Nome da definição de carga inicial description: type: string description: Descrição da definição de carga inicial basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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