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

integracao

43 views 0 08/07/2025 Atualizado em 02/03/2026 integrador

2.0info: 2.4.0 integracao x-senior-domain: erpx_intxt x-senior-domain-path: erpx_intxt x-senior-service-path: integracao 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/erpx_intxtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integracao/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/queries/getPrepareEnvironmentProgress: post: description: Retorna o progresso da preparação do ambiente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – environmentStatus properties: environmentStatus: type: string allOf: – #/definitions/environmentStatus description: Status da fila de preparação de ambiente errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o progresso da preparação do ambiente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – environmentStatus properties: environmentStatus: type: string allOf: – #/definitions/environmentStatus description: Status da fila de preparação de ambiente errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/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 /integracao/queries/exportIntegrationProcess: 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 /integracao/queries/exportMigracaoBases: 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 /integracao/queries/exportEnvironmentStepInfo: 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 /integracao/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 /integracao/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 /integracao/actions/importIntegrationProcess: 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 /integracao/actions/importMigracaoBases: 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 /integracao/actions/importEnvironmentStepInfo: 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 /integracao/signals/processSuccessDocuments: post: description: Registrar o retorno de sucesso da integração\n### Resources\n- res://senior.com.br/erpx_intxt/integracao – Processar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/recIntegrationDocument minimum: 1 description: Lista – Código do documento processado com sucesso responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/processErrorDocuments: post: description: Registrar o retorno de erro da integração\n### Resources\n- res://senior.com.br/erpx_intxt/integracao – Processar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/recIntegrationDocument minimum: 1 description: Lista – Código do documento processado com erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/createIntegrationRole: post: description: Criar uma Role default para Integração XT com todas as permissões necessárias tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/prepareEnvironmentSeniorX: post: description: Prepara o ambiente SeniorX para integração tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: moduloIntegracao: type: string allOf: – #/definitions/enumModuloIntegracao description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/events/initialLoadDefaultBaseFinished: post: description: Evento informando a realizaçao da carga de um domínio x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: Domínio service: type: string description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integracao/events/importIntegrationProcessEvent: 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 /integracao/events/exportIntegrationProcessEvent: 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 /integracao/events/importMigracaoBasesEvent: 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 /integracao/events/exportMigracaoBasesEvent: 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 /integracao/events/importEnvironmentStepInfoEvent: 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 /integracao/events/exportEnvironmentStepInfoEvent: 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 /integracao/entities/integrationProcess: 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/integrationProcess responses: 200: description: The created resource schema: #/definitions/integrationProcess 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/integrationProcess responses: 200: description: The created resource schema: #/definitions/integrationProcess 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/integrationProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/entities/integrationProcess/{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/editIntegrationProcess responses: 200: description: Ok schema: #/definitions/editIntegrationProcess 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/integrationProcess responses: 200: description: Ok schema: #/definitions/integrationProcess 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/integrationProcess 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 /integracao/entities/integrationProcess/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationProcess responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/entities/migracaoBases: 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/migracaoBases responses: 200: description: The created resource schema: #/definitions/migracaoBases 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/migracaoBases responses: 200: description: The created resource schema: #/definitions/migracaoBases 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/migracaoBases 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/entities/migracaoBases/{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/editMigracaoBases responses: 200: description: Ok schema: #/definitions/editMigracaoBases 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/migracaoBases responses: 200: description: Ok schema: #/definitions/migracaoBases 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/migracaoBases 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 /integracao/entities/migracaoBases/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/migracaoBases responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/entities/environmentStepInfo: 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/environmentStepInfo responses: 200: description: The created resource schema: #/definitions/environmentStepInfo 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/environmentStepInfo responses: 200: description: The created resource schema: #/definitions/environmentStepInfo 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/environmentStepInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integracao/entities/environmentStepInfo/{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/editEnvironmentStepInfo responses: 200: description: Ok schema: #/definitions/editEnvironmentStepInfo 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/environmentStepInfo responses: 200: description: Ok schema: #/definitions/environmentStepInfo 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/environmentStepInfo 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 /integracao/entities/environmentStepInfo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/environmentStepInfo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Status do serviço: * `UP` – Up * `DOWN` – Down enumSituacaoIntegracao: type: string enum: – PENDENTE – INTEGRANDO – INTEGRADO – ERRO description: Situação da integração: * `PENDENTE` – Pendente * `INTEGRANDO` – Integrando * `INTEGRADO` – Integrado * `ERRO` – Erro enumTypeIntegration: type: string enum: – MOVIMENTO_ESTOQUE – GRAVAR_ENGENHARIA description: Tipo de integração: * `MOVIMENTO_ESTOQUE` – Movimentação de Estoque * `GRAVAR_ENGENHARIA` – Gravar engenharia enumStatusMigracaoBase: type: string enum: – AGUARDANDO – PROCESSANDO – FINALIZADO description: Situação migração base: * `AGUARDANDO` – Aguardando * `PROCESSANDO` – Processando * `FINALIZADO` – Finalizado environmentStepStatus: type: string enum: – SKIPPED – IN_PROGRESS – DONE – ERROR description: Status do passo da preparação de ambiente: * `SKIPPED` – Pulado * `IN_PROGRESS` – Em progresso * `DONE` – Finalizado * `ERROR` – Erro environmentStep: type: string enum: – EDOCS_TENANT – CONFIGURED_ROLES – SARA_BOT – SCHEMAS_CREATION – SCHEMAS_INITIAL_LOAD – CREATE_DATACENTER – REPORTS_DATABASE – ENTITIES_TO_FND – ENTITIES_REPLICATION – FUNCTIONS_UPDATE – SET_DUPLICATION_IDS_TABLES – ENTITIES_DUPLICATION – PERSON_CREATION – ADMIN_USER_PERMISSIONS – ERPX_MENU description: Steps da preparação de ambiente: * `EDOCS_TENANT` – Criação do tenant no eDocs * `CONFIGURED_ROLES` – Criação dos papéis configurados * `SARA_BOT` – Criação do bot da Sara * `SCHEMAS_CREATION` – Criação dos schemas * `SCHEMAS_INITIAL_LOAD` – Carga inicial nos databases * `CREATE_DATACENTER` – Criação do Datacenter * `REPORTS_DATABASE` – Habilitação do banco de dados de relatórios * `ENTITIES_TO_FND` – Envio das empresas e filiais do Wizard para o schema erpx_fnd * `ENTITIES_REPLICATION` – Replicação das empresas e filiais do erpx_fnd para outros databases * `FUNCTIONS_UPDATE` – Atualiza as funções nos databases se necessário * `SET_DUPLICATION_IDS_TABLES` – Busca nos databases as tabelas referenciadas, salva as replicadas e cria a tabela duplication_ids * `ENTITIES_DUPLICATION` – Duplica os dados de empresa e filial * `PERSON_CREATION` – Criação e parametrização de pessoa (e001pes) por filial * `ADMIN_USER_PERMISSIONS` – Define as permissões padrões dos usuários admin (Entidades e099usu…) * `ERPX_MENU` – Criação do menu do ERPX environmentStatus: type: string enum: – NOT_STARTED – IN_PROGRESS – DONE – ERROR description: Status da preparação de ambiente: * `NOT_STARTED` – Não iniciado * `IN_PROGRESS` – Em progresso * `DONE` – Finalizado * `ERROR` – Erro enumModuloIntegracao: type: string enum: – MANUFATURA_MANUFATURA – FINANCAS_ERPBANKING – AGRO_AGRONEGOCIO description: Módulos de integração: * `MANUFATURA_MANUFATURA` – Manufatura * `FINANCAS_ERPBANKING` – Finanças ERP Banking * `AGRO_AGRONEGOCIO` – Agronegócio userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recIntegrationDocument: description: Documento de integração type: object required: – integrationDocumentId – code – typeIntegration properties: integrationDocumentId: type: string description: Id do documento para rastreamento da integração code: type: string description: Documento e202opeId: type: string description: Operação do estoque typeIntegration: type: string allOf: – #/definitions/enumTypeIntegration description: Tipo da integração message: type: string description: Mensagem – obrigatório quando ocorreu erro role: description: Papel type: object required: – name – domainsServices properties: name: type: string description: Nome domainsServices: type: array items: type: object allOf: – #/definitions/roleDomainServices minimum: 1 description: Domínios e serviços roleDomainServices: description: Domínio e serviços do papel configurado type: object required: – domain properties: domain: type: string description: Domínio services: type: array items: type: string description: Serviços (se não for passado nenhum serviço será dado permissão a todos os serviços do domínio) integrationProcess: description: Integração de Processos type: object required: – includedOn properties: id: type: string format: uuid description: Identificador único da tabela integrationDomain: type: string maxLength: 50 description: Dominio integrationService: type: string maxLength: 50 description: Serviço endpoint: type: string maxLength: 250 description: Endpoint status: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Situação integrationPayload: type: string description: Payload observation: type: string description: Observação includedOn: type: string format: date-time description: Data de inclusão alteredOn: type: string format: date-time description: Data de alteração editIntegrationProcess: type: object required: – id allOf: – #/definitions/integrationProcess migracaoBases: description: Migração de bases type: object required: – dominio – servico – primitiva – status properties: id: type: string format: uuid description: Id dominio: type: string maxLength: 50 description: Domínio servico: type: string maxLength: 50 description: Serviço primitiva: type: string maxLength: 100 description: Primitiva status: type: string allOf: – #/definitions/enumStatusMigracaoBase description: Situação editMigracaoBases: type: object required: – id allOf: – #/definitions/migracaoBases environmentStepInfo: description: Steps sequenciais da preparação de ambiente type: object required: – step properties: id: type: string format: uuid description: Id step: type: string allOf: – #/definitions/environmentStep description: Step status: type: string allOf: – #/definitions/environmentStepStatus description: Status errorMessage: type: string maxLength: 1000 description: Mensagem do erro editEnvironmentStepInfo: type: object required: – id allOf: – #/definitions/environmentStepInfo notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

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