Retorna uma lista paginada dos componentes de ativo da estrutura organizacional.
URL
{RMUrl}/api/Organization/assets/components[?[[&]$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 de páginas a serem exibidas. 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 os componentes de ativo listados 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 POR FILTRO
Guid AssetId;
string Name;
string Description;
Guid Id;
string KnowledgeBaseId;
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
Os 10 primeiros componentes de ativo (por padrão, 10 componentes de ativo são listados por vez):
{RMUrl}/api/Organization/assets/components
Os componentes de ativo de 11 a 20 (segunda página):
{RMUrl}/api/Organization/assets/components?page=2
Filtrar pelo ID do ativo:
{RMUrl}/api/Organization/assets/components?$filter=AssetId eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filtrar por "Windows" no campo "Name":
{RMUrl}/api/Organization/assets/components?$filter=substringof('Windows',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os componentes de ativo de acordo com os filtros e o tamanho da página especificados.
AssetComponent[].
O objeto AssetComponent está no seguinte formato:
AssetComponent
{
Guid AssetId;
string Name;
string Description;
Guid Id;
string KnowledgeBaseId;
}
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"AssetId":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Windows 2008 Server - Banco de Dados Genérico"
"Description":"Servidor da Filial São Paulo",
"Id":"29e5b79d-4b54-11e1-b4b4-0800270094a6",
"KnowledgeBaseId":"MOD_PT.000348",
},
{
"AssetId":"63e5fe02-5773-4a49-ba13-22506f022316",
"Name":"Roteador/Firewall - Cisco PIX s500 OS v6.3"
"Description":"Roteador de saída para Internet",
"Id":"3a5e728d-4b54-11e1-b4b4-0800270094a6",
"KnowledgeBaseId":"MOD_PT.000095",
},
{
"AssetId":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Servidor Linux - Linux Suse 10"
"Description":"Servidor Linux e Web",
"Id":"4447527c-4b54-11e1-b4b4-0800270094a6",
"KnowledgeBaseId":"MOD_PT.000133",
}
]