Listar consultas

Retorna uma lista com todas as consultas a que o usuário tem acesso.

 

URL

{RMUrl}/api/queries[?[[&]$filter=<filtro>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]

 

MÉTODO DE SOLICITAÇÃO

GET

 

PARÂMETROS DA URL

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 por campo os componentes de ativo listados na página. 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

string Name;

string Description;

Guid Id;

string Type;

DateTime? UpdatedOn;

 

 

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

Listar todas as consultas:

{RMUrl}/api/queries

 

Filtrar por consultas que tenham "Windows" no campo "Name":

{RMUrl}/api/queries?$filter=substringof('Windows',Name)

 

RESPOSTA DE SUCESSO

Lista de consultas da organização de acordo com os filtros e o tamanho de página especificados.

OrganizationQuery[].

 

O objeto OrganizationQuery está no seguinte formato:

OrganizationQuery

{

string Name;

string Description;

Guid Id;

string Type;

DateTime? UpdatedOn;

object Links;

}

 

EXEMPLO DE RESPOSTAS DE SUCESSO

[

{

"Name":"consulta de ativos"

"Description":"consulta de ativos",

"Id":"29e5b79d-4b54-11e1-b4b4-0800270094a6",

"Type":"Organizational Information - Assets",

"UpdatedOn":"\/Date(1321621109510-0200)\/" ,

"Links":[{

"Uri":"https://riskamanager.modulo.com/RM/api/organization/queries/5c67ef1c-3b68-4034-b83b-aeb26d6e2527",

"Rel":"run",

"Name":"Execute"

}]

},

{

"Name":"Consulta Customizada"

"Description":"Consulta Customizada",

"Id":"3a5e728d-4b54-11e1-b4b4-0800270094a6",

"Type":"Status of Controls",

"UpdatedOn":"\/Date(1321621109510-0200)\/" ,

"Links":[{

"Uri":"https://riskmanager.modulo.com/RM/api/queries/rest/3502b1f6-9a63-4b9c-b452-46afec2a6ea0",

"Rel":"run",

"Name":"Execute"

}]

}

]