Retorna dados de uma entidade baseados em templates de consulta
Modelos de pesquisa (queryByTemplate)
Neste endpoint, você informa a entidade da qual deseja obter dados e aplica filtros específicos. Os filtros são baseados em templates de consulta, que são como "modelos" de pesquisa predefinidos para a entidade escolhida.
Por exemplo, para a entidade "city," você pode usar o template de consulta "queryByCountryAndProvince" e especificar os parâmetros, como "paramCountryName" e "paramProvinceName," para refinar sua busca.
Assim, o endpoint se parece com o seguinte exemplo de uso real:
https://platform.nstech.com.br/api/mdm/entities/city/queryByTemplate/queryByCountryName?paramCountryName=Brasil
Nesse caso, o template de consulta "queryByCountryAndProvince" funciona como um modelo de filtro, permitindo que você especifique os critérios de pesquisa (país e província) para obter os dados desejados da entidade "city." Isso facilita a busca específica de informações, de maneira análoga à cláusula WHERE no SQL.
Modelos de pesquisa de cada entidade
Para saber quais modelos de consulta estão disponíveis para cada entidade basta consultar a especificação da entidade.
Quando não existem modelos de pesquisa
Quando a "queryTemplate" não estiver definida no Schema de uma entidade, é possível utilizar o parâmetro "/all" para obter todos os dados dessa entidade.
Por exemplo, suponhamos que você deseje acessar todos os dados da entidade "City". Você pode fazer isso através do seguinte URL:
https://platform.nstech.com.br/api/mdm/entities/City/queryByTemplate/all
Dessa forma, a consulta retornará todos os dados disponíveis para a entidade consultada quando o "queryTemplate" não estiver especificado no esquema.