O objeto Grupo (snap_mall__Grupo__c) contém todas as informações de cadastro do grupo que serão utilizadas para o cadastro da unidade locaticia, no objeto Unidade.
Campos de Grupo
| Rótulo do campo | Nome de API | Tipo de dados | Obrigatório | Descrição |
|---|---|---|---|---|
| Criado por | CreatedById | Pesquisa(Usuário) | X | Preenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração |
| Código | snap_mall__Codigo__c | Número(4, 0) (Exclusivo) | X | ID do grupo |
| Grupo | Name | Texto(80) | X | Informação da identificação do grupo |
| ID Externo | snap_mall__id_externo__c | Texto(80) (ID externo) (Não-diferenciação exclusiva de maiúsculas e minúsculas) | ID do sistema ERP, que poderá ser informado no momento da inserção da conta, para futuras atualizações, através deste ID | |
| Proprietário | OwnerId | Pesquisa(Usuário,Grupo) | ||
| Última modificação feita por | LastModifiedById | Pesquisa(Usuário) | X | Informação do usuário de sistema que realizou a ultima modificação ou usuário da integração |
Criar Grupo:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Grupo__c/
Descrição: Método de criação de um Grupo.
Request |
|---|
| { "Name":"Grupo sim", "OwnerId":"0051J000004ppUV", "snap_mall__Codigo__c":"99", "snap_mall__id_externo__c":"555" } |
Response |
|---|
| { "id": "a0E1J00000KdupfUAB", "success": true, "errors": [] } |
Atualizar Grupo:
Método :PATCH
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Grupo__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Grupo__c/snap_mall__id_externo__c/ (Id externo)
Descrição:
Método de atualização de um Grupo(snap_mall__Grupo__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.
Existem duas possibilidades de atualização do Grupo: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.
O método PATCH pode ser utilizado par Upsert, em caso do Id externo informado não existir na base e contiver todos os campos obrigatórios no body.
Request |
|---|
| { "Name":"Grupo nao" } |
| Response |
|---|
Response em caso de sucesso da atualização retornará vazio.
Deletar Grupo:
Método : DELETE
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Grupo__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Grupo__c/snap_mall__id_externo__c/ (Id externo)
Descrição: Método de deleção de um Grupo(snap_mall__Grupo__c) de qualquer tipo. Existem duas possibilidades de deleção do Grupo: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.
Request |
|---|
Body de deleção é vazio.
Response |
|---|
Response de deleção retorna vazio.