FAQs - Suporte técnico

RM - Integrações - Requisição REST - GetAll e Exemplo de Utilização do Filtro


Dúvida
Como consumir o GetAll através da requisição REST?

Ambiente
RM - Todas as versões

Solução

Retorna os registros do dataserver representado pelo identificador da URL {id}. Tal qual no método Get, no json retornado será acrescentado o campo id para cada registro. O registro inicial,a quantidade de registros a serem retornados, e um filtro podem ser definidos na url.

Parâmetros:

  • start - Registro inicial a ser retornado. (padrão = "0")
  • limit - Quantidade máxima de registros a serem retornados. (padrão = "0", retorna todos os registros)
  • filter - Filtro para ser aplicado na leitura dos registros. (padrão = não possui filtro padrão)

Regras para utilização do filtro:

Para montar o parâmetro "filter" devemos obedecer as seguintes regras:

  • O objeto filter deve ser um array.
  • O índice 0(zero) desse array deve ser o schema do filtro, o schema segue o mesmo padrão já adotado na lib (CODCOLIGADA =:CODCOLIGADA)
  • O índice 0(zero) não aceita comandos : DLL, DML, DCL, TCL (create, alter, truncate, comment, rename, select, insert, update, delete, call, explain plan, lock table, grant, revoke, commit, savepoint, rollback, '," )
  • Para cada parâmetro adicionado schema do filtro, deverá ser um novo registro no array com o respectivo valor.
  • É extremamente necessário serializar o filtro em json antes de fazer a chamada.

Exemplo para a montagem de um filtro com mais de um parâmetro:

[...] filter =  ["NOME_DO_CAMPO_1 = :NOME_DO_PARAMETRO_1 (AND/OR) NOME_DO_CAMPO_2 = :NOME_DO_PARAMETRO_2 (AND/OR) NOME_DO_CAMPO_N = :NOME_DO_PARAMETRO_N", "VALOR_1", "VALOR_2", "VALOR_3"]

 

Exemplo (Filtro Único):

Método: GET

Parâmetros Utilizados: 

  • start = 3;
  • limit = 2;
  • filter = ["CODCOLIGADA =:codcoligada", "1"];

URL: http://localhost:8051/rmsrestdataserver/rest/EstLOCData?start=3&limit=2&filter=%5B%22CODCOLIGADA+%3D+:CODCOLIGADA%22

Resposta (Filtro Único) Expandir origem

Exemplo (Filtro com mais de um Parâmetro):

         Iremos utilizar o mesmo dataserver (EstLOCData) como exemplo, porém iremos utilizar os seguintes parâmetros:

         OBS: Observe que vamos utilizar três filtros, em vez de um, como no exemplo anterior.

Método: GET

Parâmetros Utilizados:

  • start = 0;
  • limit = 5;
  • filter = ["CODCOLIGADA =:codcoligada AND CODLOC =:codloc AND CODFILIAL =:codfilial", "1", "01", "1"]

URL: http://localhost:8051/rmsrestdataserver/rest/EstLOCData?start=0&limit=5&filter=%5B%22CODCOLIGADA%20%3D%3Acodcoligada%20AND%20CODLOC%20%3D%3Acodloc%20AND%20CODFILIAL%20%3D%3Acodfilial%22%2C%20%221%22%2C%20%2201%22%2C%20%221%22%5D

Resposta (Filtro com mais de um Parâmetro) Expandir origem

Exemplo (Filtro com Like):

Iremos utilizar o mesmo dataserver (EstLOCData) como exemplo, porém iremos utilizar os seguintes parâmetros:

Método: GET

Parâmetros Utilzados:

  • filter = ["NOME LIKE :NOME", "%SAO PAULO%"]

URL: http://localhost:8051/rmsrestdataserver/rest/EstLOCData?filter=%5B%22NOME%20LIKE%20%3ANOME%22%2C%20%22%25SAO%20PAULO%25%22%5D

Resposta (Filtro com Like) Expandir origem

Exemplo (Implementação em Código)  

  • Adicione os disclaimers que desejar:

  • Crie o schema do filtro e adicione os respectivos valores.
  • Na chamada do findRecords, o parâmetro filter deve ser serializado em JSON.
  • A segunda opção pode ser substituída por essa:
Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0

0 Comentários

Por favor, entre para comentar.
X Fechar

Olá ,

Há pendência referente a um de seus produtos contratados para a empresa ().

Entre em contato com o Centro de Serviços TOTVS para tratativa.

Ligue! 4003-0015 opção 4 e 9 ou registre uma solicitação para CST – Cobrança – Verificação de pendências financeiras . clique aqui.

TOTVS

X Fechar

Olá ,

Seu contato não está cadastrado no Portal do Cliente como um perfil autorizado a solicitar consultoria telefônica.

Por gentileza, acione o administrador do Portal de sua empresa para: (1)configurar o seu acesso ou (2)buscar um perfil autorizado para registro desse atendimento.

Em caso de dúvidas sobre a identificação do contato administrador do Portal, ligue (11) 4003-0015, opção 7 e, em seguida, opção 4 para buscar o suporte com o time de Assessoria ao Portal do Cliente. . clique aqui.

TOTVS

X Fechar

Olá ,

Para o atendimento de "Consultoria Telefônica" você deverá estar de acordo com o Faturamento.

TOTVS

X Fechar

Olá,

Algo inesperado ocorreu, e o usuario nao foi reconhecido ou você nao se encontra logado

Por favor realize um novo login

Em caso de dúvidas, entre em contato com o administrador do Portal de Clientes de sua empresa para verificação do seu usuário, ou Centro de Serviços TOTVS.

Ligue! 4003-0015 opção 4 e 9 ou registre uma solicitação para CST – Cadastros . clique aqui.

TOTVS

Chat _

Preencha os campos abaixo para iniciar o atendimento:

Chat _