erp_sup

cot_cotacao

63 views 07/11/2018 05/11/2019 integrador 0

2.0info: 2.5.0 cot_cotacao description: Cotação x-senior-domain: erp_sup x-senior-domain-path: erp_sup x-senior-service-path: cot_cotacao 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_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /cot_cotacao/queries/pesquisarEmpresa: post: description: Retorna informações da(s) empresa(s) paginado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pagina properties: pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente texto: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base na pesquisa presente codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Campos para ordenação responses: 200: description: Ok schema: type: object required: – empresas – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Retorna a(s) empresa(s) do(s) filtro(s) informado(s) totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/buscarEmpresa: post: description: Retorna informações da(s) empresa(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: ids: type: array items: type: integer format: int64 description: Identificador único da empresa codigos: type: array items: type: string description: Código da empresa, se ids for informado o código não é usado. responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Retorna a(s) empresa(s) do(s) id(s) informado(s) default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da(s) empresa(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ids description: Identificador único da empresa in: query type: array items: type: integer format: int64 – name: codigos description: Código da empresa, se ids for informado o código não é usado. in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Retorna a(s) empresa(s) do(s) id(s) informado(s) default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/buscarIdsTodasEmpresas: post: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/buscarFilial: post: description: Retorna informações da(s) filial(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: integer format: int64 description: Identificador da empresa para o qual a filial pertence ids: type: array items: type: integer format: int64 description: Identificador único da filial codigos: type: array items: type: string description: Código da filial, se ids for informado o empresaId e código não são usados. responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Retorna filial(s) do(s) filtro(s) informado(s). default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da(s) filial(s) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: empresaId description: Identificador da empresa para o qual a filial pertence in: query type: integer format: int64 – name: ids description: Identificador único da filial in: query type: array items: type: integer format: int64 – name: codigos description: Código da filial, se ids for informado o empresaId e código não são usados. in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Retorna filial(s) do(s) filtro(s) informado(s). default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/buscarIdsFiliaisPorEmpresas: post: description: Buscar IDs das filiais por empresas. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais default: description: Error response schema: #/definitions/genericError get: description: Buscar IDs das filiais por empresas. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: empresaIds description: IDs das empresas in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/buscarFiliaisMultiplasEmpresas: post: description: Pesquisar filiais de múltiplas empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – todas – pagina properties: texto: type: string description: Busca por nome ou código das filiais todas: type: boolean description: Se todas a empresas devem ser buscadas somente: type: array items: type: integer format: int64 description: Somente buscar pelos IDs das empresas exceto: type: array items: type: integer format: int64 description: Todas as empresas, exceto as listadas pagina: type: object allOf: – #/definitions/recPagina description: Paginação responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: Filiais agrupadas por empresa default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/pesquisarFilial: post: description: Retorna filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigoEmpresa: type: integer format: int64 description: Empresa para pesquisar empresaId: type: integer format: int64 description: Id da empresa para pesquisar codigo: type: integer format: int64 description: Código da filial nome: type: string description: Nome da filial pesquisa: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição do item presente texto: type: string description: Campo de pesquisa responsável por filtrar os dados a serem pesquisados, com base no código e descrição do item presente pagina: type: object allOf: – #/definitions/recPagina description: Dados para paginação orderby: type: string description: Campos para ordenação responses: 200: description: Ok schema: type: object required: – filiais – totalRegistros properties: filiais: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Retorna a lista de filial totalRegistros: type: integer format: int64 description: Retorna quantidade total de registros default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/obterSku: post: description: Busca SKU pelo código da empresa e pelo código do SKU tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoSKU properties: codigoEmpresa: type: string description: Código da empresa codigoSKU: type: string description: código do SKU responses: 200: description: Ok schema: type: object required: – sku properties: sku: type: object allOf: – #/definitions/recSku description: SKU encontrado default: description: Error response schema: #/definitions/genericError get: description: Busca SKU pelo código da empresa e pelo código do SKU tags: – Queries x-senior-visibility: PUBLIC parameters: – name: codigoEmpresa description: Código da empresa in: query required: true type: string – name: codigoSKU description: código do SKU in: query required: true type: string responses: 200: description: Ok schema: type: object required: – sku properties: sku: type: object allOf: – #/definitions/recSku description: SKU encontrado default: description: Error response schema: #/definitions/genericError /cot_cotacao/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 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 default: description: Error response schema: #/definitions/genericError /cot_cotacao/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 /cot_cotacao/queries/exportEmpresa: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/exportFilial: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /cot_cotacao/queries/exportSku: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /cot_cotacao/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 /cot_cotacao/actions/criarCotacao: post: description: Cria uma cotação tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – cotacao properties: cotacao: type: array items: type: object allOf: – #/definitions/recCotacaoItem minimum: 1 description: Itens da cotação responses: 200: description: Ok schema: type: object required: – idCotacao properties: idCotacao: type: string maxLength: 36 description: Identificador da cotação criada default: description: Error response schema: #/definitions/genericError /cot_cotacao/actions/cancelarCotacao: post: description: Cancela cotações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idNecessidadeCompra properties: idNecessidadeCompra: type: array items: type: string minimum: 1 description: Identificadores das necessidades de compra que terão suas cotações canceladas responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /cot_cotacao/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /cot_cotacao/actions/importEmpresa: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /cot_cotacao/actions/importFilial: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /cot_cotacao/actions/importSku: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/empresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/empresa default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/empresa/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/empresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/empresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/filial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/filial default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/filial/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filial default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/filial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/sku: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sku default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/sku/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sku responses: 200: description: Ok schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sku responses: 200: description: Ok schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sku default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /cot_cotacao/entities/sku/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sku responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoSKU: description: Enumerador de tipo de SKU type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufatura – EmFabricacao – Subproduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recCotacaoItem: description: Item da cotação type: object required: – idNecessidadeCompra – numeroNecessidadeCompra – quantidade – codigoEmpresa – codigoFilial – codigoUnidadeMedida properties: idNecessidadeCompra: type: string maxLength: 36 description: Identificador da necessidade de compra numeroNecessidadeCompra: type: integer format: int64 description: Número da necessidade de compra quantidade: type: number format: double description: Quantidade codigoEmpresa: type: string description: Código da empresa codigoFilial: type: string description: Código da filial codigoSKU: type: string maxLength: 30 description: SKU codigoUnidadeMedida: type: string maxLength: 3 description: Código da unidade de medida complemento: type: string description: Complemento observacao: type: string description: Observacao enderecoEntrega: type: object allOf: – #/definitions/recCotacaoItemEndereco description: Endereço de entrega enderecoFaturamento: type: object allOf: – #/definitions/recCotacaoItemEndereco description: Endereço de faturamento anexos: type: array items: type: object allOf: – #/definitions/recCotacaoItemAnexo description: Anexos do item da cotação detalhesUsuario: type: object allOf: – #/definitions/recDetalhesUsuario description: Detalhes do usuário recDetalhesUsuario: description: Detalhes do Usuário cotação type: object properties: email: type: string description: E-mail do usuário Cotador recCotacaoItemAnexo: description: Anexo do item da cotação type: object required: – id – nomeArquivo – versaoArquivo properties: id: type: string maxLength: 36 description: Identificador único nomeArquivo: type: string maxLength: 100 description: Nome do arquivo versaoArquivo: type: string maxLength: 50 description: Versão do arquivo recCotacaoItemEndereco: description: Endereço de entrega e faturamento type: object required: – codigoEmpresa – codigoFilial – endereco – cep properties: codigoEmpresa: type: string description: Código da empresa codigoFilial: type: string description: Código da filial endereco: type: string description: Endereço cep: type: string description: CEP sequencia: type: integer format: int64 description: Sequência codigoCidade: type: string description: Código cidade codigoEstado: type: string description: Código estado bairro: type: string description: Bairro recPagina: description: Dados para paginação de registros type: object required: – offset – limit properties: offset: type: integer format: int64 description: Qual página limit: type: integer format: int64 description: Limite de registros recSku: description: SKU type: object required: – codigoEmrpesa – codigo – descricao – tipoProduto properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão codigoEmrpesa: type: string description: Código da empresa codigo: type: string description: Código descricao: type: string description: Descrição descricaoComplementar: type: string description: Descrição complementar tipoProduto: type: string allOf: – #/definitions/enumTipoSKU description: Tipo de produto recEmpresa: description: Dados da empresa type: object required: – id – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único codigo: type: string description: Código da empresa nome: type: string description: Nome da empresa fantasia: type: string description: Nome fantasia da empresa recFilial: description: Dados da filial type: object required: – id – empresaId – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único empresaId: type: object allOf: – #/definitions/recEmpresa description: Empresa codigo: type: string description: Código da filial nome: type: string description: Nome da filal fantasia: type: string description: Nome fantasia da filial recEmpresaComFiliais: description: Empresa com suas filiais type: object required: – id – codigo – nome – filiais properties: id: type: integer format: int64 description: Id da empresa codigo: type: string description: Código da empresa nome: type: string description: Nome da empresa filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais 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 empresa: description: Empresa type: object required: – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 10 description: Nome fantasia filiais: type: array items: type: object allOf: – #/definitions/filial description: Filiais da emrpesa usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: filial: description: Filial type: object required: – empresa – codigo – nome – fantasia properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão empresa: type: object allOf: – #/definitions/empresa description: Identificador único da empresa codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 30 description: Fantasia usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sku: description: SKU – produto/serviço type: object required: – empresa – codigo – descricao – tipoProduto properties: id: type: integer format: int64 description: Identificador único, deve ser informado nas operações de atualização e exclusão empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: string description: Código descricao: type: string description: Descrição descricaoComplementar: type: string description: Descrição complementar tipoProduto: type: string allOf: – #/definitions/enumTipoSKU description: Tipo de produto usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: 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