Retorna uma lista paginada das instâncias de um objeto customizado.
URL
{RMUrl}/api/objects/<NomeVariáveldoObjeto>[?[[&]$filter=<filtro>][[&]page=<Página>][[&]page_size=<Tamanhodapágina>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]
MÉTODO DE SOLICITAÇÃO
GET
PARÂMETROS DA URL
page: número da página a ser exibida. Valores válidos: de 1 ao número máximo de páginas. Se omitido, o valor 1 é utilizado. Se o valor for maior que o número máximo de páginas, uma lista em branco será retornada.
page_size: número de itens exibidos por página. Valores válidos: de 1 a 1.000. Se omitido, o valor padrão de 10 itens por página é utilizado.
filter: consulta baseada na sintaxe do protocolo OData para configurar filtros. Os campos permitidos estão listados abaixo. Siga os exemplos para identificar as operações permitidas.
orderby: ordena as instâncias listadas na página por campo. Para ordenar por mais de um campo, utilize a vírgula entre os campos. Para utilizar a ordem decrescente, digite a palavra chave "desc" para cada campo desejado. Os campos permitidos estão listados abaixo.
CAMPOS SUPORTADOS PELO FILTRO
guid Id;
boolean Deleted;
string Name;
guid CreatedBy;
guid UpdatedBy;
datetime DateCreated;
datetime DateUpdated;
Adicionalmente, os seguintes tipos de atributo também são suportados pelo filtro: Texto, E-mail, Link, Parágrafo, Número, Data Somente, Data/Hora, Lista de Opções e Relacionamento.
Os outros tipos de atributos não são suportados pelo filtro.
Para informações detalhadas sobre os filtros, como os operadores suportados, quais filtros se aplicam a quais tipos de dados e mais exemplos, veja o Apêndice 3: Filtros.
EXEMPLOS DE SOLICITAÇÃO
Para os exemplos a seguir, vamos considerar que o nome da variável seja "livro".
As 10 primeiras instâncias do objeto identificado pela variável "livro" (por padrão, somente 10 instâncias são listadas por vez):
{RMUrl}/api/objects/livro?page_size=10
As instâncias de 11 a 20 (segunda página):
{RMUrl}/api/objects/livro?page=2
Filtrar pelas instâncias com Id maior que 5:
{RMUrl}/api/objects/livro?$filter=Id eq guid'f9166f2b-c0eb-426f-8940-246102a0f429'
Filtrar pelas instâncias ativas:
{RMUrl}/api/objects/livro?$filter=Deleted eq false
Filtrar pelas instâncias removidas:
{RMUrl}/api/objects/livro?$filter=Deleted eq true
RESPOSTA DE SUCESSO
Lista de instâncias dos objetos com informações de acordo com os filtros e o tamanho da página especificados. Para saber quais são os atributos disponíveis para o objeto em questão, veja o tópico Funcionalidades do Módulo Risk Manager -> 9. Objetos customizados -> Listar atributos de um objeto customizado.
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"Id":"f9166f2b-c0eb-426f-8940-246102a0f429",
"Deleted":false,
"CreatedBy": "c80dd32d-019a-11ea-8224-02cfad345886",
"UpdatedBy":"c80dd32d-019a-11ea-8224-02cfad345886",
"DateCreated":"/Date(15922836251790-0300)/",
"DateUpdated":"/Date(15922836251790-0300)/",
"Name":"A Arte da Guerra",
"Tipo":"Livro de Guerra",
"ISBN":"9788525426642",
"AutorDaObra":"Sun Tzu",
}
]