erp_dem

gde_integracao

22 views 22/10/2018 22/10/2018 integrador 0

2.0info: 1.10.1 gde_integracao x-senior-domain: erp_dem x-senior-domain-path: erp_dem x-senior-service-path: gde_integracao 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/erp_demsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gde_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: 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 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 /gde_integracao/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 /gde_integracao/actions/integrarPessoa: post: description: Integração de pessoa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacaoIntegracao properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada id: type: integer format: int64 description: tipo: type: string allOf: – #/definitions/enumTipoPessoa description: codigoEmpresa: type: integer format: int64 description: codigo: type: integer format: int64 description: nome: type: string description: fantasia: type: string description: responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Id de pessoa (sempre é zero na exclusão) default: description: Error response schema: #/definitions/genericError /gde_integracao/actions/integrarUnidadeMedida: post: description: Integração de unidade de medida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacaoIntegracao properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada id: type: integer format: int64 description: codigo: type: string description: descricao: type: string description: quantidadeDecimais: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Id da unidade de medida (sempre é zero na exclusão) default: description: Error response schema: #/definitions/genericError /gde_integracao/actions/integrarUnidadeMedidaConversao: post: description: Integração de unidade de medida conversão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacaoIntegracao properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada id: type: integer format: int64 description: unidadeMedidaOrigem: type: string description: unidadeMedida: type: string description: tipo: type: string allOf: – #/definitions/enumTipoFatorConversaoUnidadeMedida description: fatorConversao: type: string description: responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Id da unidade de medida conversão (sempre é zero na exclusão) default: description: Error response schema: #/definitions/genericError /gde_integracao/actions/integrarSKU: post: description: Integração de SKU tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacaoIntegracao – codigoEmpresa – codigo – descricao – codigoUnidadeMedida – tipo – situacao properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada id: type: integer format: int64 description: id do sku codigoEmpresa: type: integer format: int64 description: código da empresa do sku codigo: type: string description: código do sku descricao: type: string description: descrição do sku descricaoComplementar: type: string description: descrição complementar do sku codigoUnidadeMedida: type: string description: código da unidade de medida do sku tipo: type: string allOf: – #/definitions/enumTipoSKU description: tipo do sku situacao: type: string allOf: – #/definitions/enumSituacaoSKU description: situação do sku tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: tipo de reposicao do sku tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidade description: tipo da qualidade do sku leadTime: type: integer format: int64 description: leadtime do sku codigoFamilia: type: string description: código da familia do sku responses: 200: description: Ok schema: type: object required: – id – idVersao properties: id: type: integer format: int64 description: Id do SKU (sempre é zero na exclusão) idVersao: type: integer format: int64 description: Id da Versão do SKU (sempre é zero na exclusão) default: description: Error response schema: #/definitions/genericError /gde_integracao/actions/integrarSKUG7: post: description: Integração de SKU tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – skus properties: skus: type: array items: type: object allOf: – #/definitions/recIntegrarSKUG7 minimum: 1 description: Lista de sku responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gde_integracao/actions/integrarFamilia: post: description: Integração de Familia tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacaoIntegracao – codigoEmpresa – codigo properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada id: type: integer format: int64 description: id da familia codigoEmpresa: type: integer format: int64 description: código da empresa da família codigo: type: string description: código do sku descricao: type: string description: descrição do sku tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição controlaLote: type: boolean description: Controla lote controlaSerie: type: boolean description: Controla série responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Id da Familia (sempre é zero na exclusão) default: description: Error response schema: #/definitions/genericError definitions: enumOperacaoIntegracao: description: Enumerador de operação de integração type: string enum: – Insercao – Atualizacao – Exclusao enumTipoPessoa: description: Enumerador de tipo de pessoa type: string enum: – Empresa – Filial enumTipoSKU: description: Enumerador de tipo de produto type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufatura – EmFabricacao – Subproduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumSituacaoSKU: description: Enumerador de situação do SKU type: string enum: – Inativo – Ativo – Bloqueado enumTipoReposicao: description: Tipo de reposição type: string enum: – Produzido – Comprado – Servico enumTipoQualidade: description: type: string enum: – Normal – Refugo – SegundaQualidade – TerceiraQualidade enumSituacaoVersao: description: type: string enum: – Transitoria – Aprovada – Liberada – Substituida enumTipoFatorConversaoUnidadeMedida: description: type: string enum: – Multiplicacao – Divisao 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 recIntegrarSKUG7: description: type: object required: – operacaoIntegracao – codigoEmpresa – codigo – descricao – codigoUnidadeMedida – tipo – situacao properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada id: type: integer format: int64 description: id do sku sequenciaVersao: type: integer format: int64 description: sequencia da versão do sku codigoEmpresa: type: integer format: int64 description: código da empresa do sku codigo: type: string description: código do sku descricao: type: string description: descrição do sku descricaoVersao: type: string description: descrição da versão do sku descricaoComplementar: type: string description: descrição complementar do sku codigoUnidadeMedida: type: string description: código da unidade de medida do sku tipo: type: string allOf: – #/definitions/enumTipoSKU description: tipo do sku situacao: type: string allOf: – #/definitions/enumSituacaoSKU description: situação do sku situacaoVersao: type: string allOf: – #/definitions/enumSituacaoVersao description: situação da versão do sku tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: tipo de reposicao do sku tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidade description: tipo da qualidade do sku leadTime: type: integer format: int64 description: leadtime do sku codigoFamilia: type: string description: código da familia do sku notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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. 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