Exibir origem

Objetivo

Método que permite consultar similaridades.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Similaridade

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais

Home TOTVS Varejo Supermercados > Consultar Similaridades - GET > image-2024-5-6_14-56-39.png

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

AdicionarCategoriaReqDto

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
IdProduto	Lista de identificadores de produtos	array[integer]	Não há.
TipoSimilaridade	Tipo de similaridade	string	Não há.
Expand	Propriedade que expande os campos	string	Não há.
Fields	Campos	string	Não há.
Order	Ordenação dos campos	string	Não há.
Page	Número da Página	integer($int32)	Não há.
PageSize	Tamanho da Página	integer($int32)	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

BuscaPorFiltroSimilaridadeResDto

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
idSimilaridade	Identificador de similaridade	integer($int64)	Não há.
descricao	Descrição	string	Não há.
tipoSimilaridade	Tipo de similaridade	string	Não há.

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idSimilaridade": 0,
      "descricao": "string",
      "tipoSimilaridade": "string"
    }
  ]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}