Retorna uma lista paginada dos knowledge bases cadastrados no sistema.
URL
{RMUrl}/api/knowledge/knowledgebases[?[[&]$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, será retornada uma lista em branco.
page_size: número de itens a serem 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 knowledge bases 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 Id;
string Name;
string Shortname;
double CurrentVersion;
int Controls;
Datetime CreatedOn;
string CustomerID;
string Classification;
string Description;
int Status;
int Source;
O campo Status pode ter os seguintes valores: 1 para a situação "Being Editing", 2 para a situação "Published" e 6 para a situação "Completed".
O campo Source pode ter os seguintes valores: 0 para "Custom" (knowledge bases próprios), 1 para "Modulo" (knowledge bases fornecidos pela Módulo) e 2 para "Terceiro" (para knowledge bases oriundo de terceiros).
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 knowledge bases (por padrão, apenas 10 knowledge bases são listados por vez):
{RMUrl}/api/knowledge/knowledgebases
Os knowledge bases de 11 a 20 (segunda página):
{RMUrl}/api/knowledge/knowledgebases?page=2
Filtrar por "Windows" no campo "Name" do knowledge base:
{RMUrl}/api/knowledge/knowledgebases?$filter=substringof('Windows',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os knowledge bases de acordo com os filtros e o tamanho da página especificados.
KnowledgeBase[].
O objeto KnowledgeBase está no seguinte formato:
KnowledgeBase
{
Guid Id;
string Name;
string Shortname;
double CurrentVersion;
int Controls;
DateTime CreatedOn;
string CustomerID;
string Type;
string Classification;
string Description;
string Status;
string Source;
}
EXEMPLO DE RESPOSTA DE SUCESSO
[
{
"Id":"e2e2b0f9-2578-4caa-b5d1-99d13166620e",
"Name":"Application - \"Application Server\" - Apache Tomcat 5.5.12",
"Shortame":"Escritório",
"CurrentVersion":3.4,
"Controls":42,
"CreatedOn":"\/Date(1338230970110-0300)\/",
"CustomerID":"MOD_EN.000193",
"Type":"Technology",
"Classification": "IT Risk Management",
"Description": "Este Knowledge Base contém boas práticas de segurança para aplicação tipo "Servidor de Aplicação" Apache Tomcat versões 5.5 e 6.0 para ambientes Unix e Linux. A informação é apresentada de forma objetiva e resumida, considerando-se uma audiência técnica especializada que já tenha familiaridade com a instalação, configuração e manutenção do Apache Tomcat e do sistema operacional onde está instalado.",
"Source":"Modulo",
"Status":"Published"
}
]