Listar alterações de uma instância de um objeto customizado

Retorna uma lista paginada das alterações de uma instância de um objeto customizado.

 

URL

{RMUrl}/api/objects/<NomeVariáveldoObjeto>/<IDdaInstancia>/snapshots[?[[&]$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

NomeVariáveldoObjeto: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.

IDdaInstancia: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.

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

     datetime SnapshotDate;

     string Differences/Name;

     string Author/Id;

     string Author/Name;

     string Author/UserName;

 

Para informações detalhadas sobre 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

Filtrar por atualizações mais recentes que uma determinada data:

{RMUrl}/api/objects/livro/66f295ae-f946-4f74-9ef4-21a0ca93febb/snapshots?$filter=SnapshotDate ge datetime'2013-12-01T12:34:56'

 

Filtrar por atualizações feitas por um determinado autor:

{RMUrl}/api/objects/livro/66f295ae-f946-4f74-9ef4-21a0ca93febb/snapshots?$filter=Author/Name eq 'John Meyers'

 

Filtrar por atualizações que o atributo tenha o nome "lista":

{RMUrl}/api/objects/livro/66f295ae-f946-4f74-9ef4-21a0ca93febb/snapshots?$filter=Differences/any(diff: diff/Name eq 'lista')

 

RESPOSTA DE SUCESSO

[

{

"Differences":[

{"Name":"listasimples","OldValue":[],"NewValue":[{"Oid":"148022e2-1a10-414e-81a1-09e8b41ed40a","Caption":"a1"}

{"Name":"numero","OldValue":1,"NewValue":5},

],

"SnapshotDate":"\/Date(1387288987560-0200)\/"}

},

{

"Differences":[],

"SnapshotDate":"\/Date(1387288970217-0200)\/"}

]