Este método é responsável pela criação de um novo compartilhamento
- Endpoint: /api/retaguarda/v2/compartilhamentos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
O retorno dessa requisição gerará um código chamado loteOrigem, ele é de suma importância, pois, esse código identifica qual o lote que pertence o(s) dado(s) e deverá ser passado no envio dos dados para que a integração funcione corretamente.
Expandir |
---|
title | Exemplo de body da requisição |
---|
|
[ { "IdRetaguardaLoja": "string", "IdRetaguarda": "string", "IdProprietario": "string", "IdInquilino": "string", "NomeCompartilhamento": "string", "Nivel": int, "IdRetaguardaPai":"string", "loteOrigem": "string" } ] |
Expandir |
---|
title | Definição dos campos de requisição |
---|
|
Campo | Tipo | Descrição | Observações |
---|
IdRetaguardaLoja | string | Identificador da loja na retaguarda | Opcional. Só é preenchido se for um compartilhamento de loja | IdRetaguarda | string | Identificador do compartilhamento na retaguarda | Obrigatório | IdProprietario | string | Identificador do proprietário do dado | Obrigatório e no máximo 100 caracteres Quando os dados são enviados é necessário passar esse dado pra identificar a qual compartilhamento pertence o dado. | IdInquilino | string | Identificador do inquilino | Obrigatório | NomeCompartilhamento | string | Nome para identificação do compartilhamento | Obrigatório e no máximo 100 caracteres | Nivel | int | Nível do compartilhamento | Obrigatório Nos compartilhamentos deve ter somente um compartilhamento com nível 0. | IdRetaguardaPai | string | IdRetaguarda do compartilhamento acima deste | Opcional Somente não é preenchido no Nível 0 | loteOrigem | string | Código do lote | Obrigatório |
|
Expandir |
---|
title | Retorno da requisição |
---|
|
{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Expandir |
---|
title | Definição dos campos de retorno |
---|
|
Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|