Retorna uma lista paginada dos controles de um knowledge base cadastrado no sistema.
URL
{RMUrl}/api/knowledge/knowledgebases/<CódigoDoKnowledgeBase>/controls/[?[[&]$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
KnowledgeBaseID: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.
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, será retornada uma lista em branco.
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 controles 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 Grouping;
string Name;
int Probability;
string Reference;
string ControlID;
int Severity;
string Source;
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 controles de um knowledge base (por padrão, apenas 10 controles são listados por vez):
{RMUrl}/api/knowledge/knowledgebases/e2e2b0f9-2578-4caa-b5d1-99d13166620e/controls
Os controles de 11 a 20 (segunda página):
{RMUrl}/api/knowledge/knowledgebases/e2e2b0f9-2578-4caa-b5d1-99d13166620e/controls?page=2
Filtrar por "Access permissions" no campo "Name" dos controles:
{RMUrl}/api/knowledge/knowledgebases/e2e2b0f9-2578-4caa-b5d1-99d13166620e/controls?$filter=substringof('Access permissions',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os controles de acordo com os filtros e o tamanho da página especificados.
Control[].
O objeto Control está no seguinte formato:
Control
{
Guid Id;
string Name;
int Probability;
int Severity;
string Reference
int Severity;
string Source;
string ControlID;
string Grouping;
}
EXEMPLO DE RESPOSTA DE SUCESSO
{
"ControlID":"MOD_PT.00010922",
"Grouping":"System and Application Settings",
"Id":"54458887-c6ed-47cd-9559-9d573b86a46e",
"Name":"As permissões do diretório e de páginas publicadas no Apache Tomcat devem ser configuradas de forma a evitar acessos indevidos",
"Probability":3,
"Reference":"Modulo Security Lab",
"Severity":4,
"Source":"Apache Tomcat Security Guide"
},
{
"ControlID":"MOD_PT.00012076",
"Grouping":"System and Application Settings",
"Id":"4906f3da-d765-41e5-aabe-904d9c65949c",
"Name":"A exibição da estrutura de diretórios deve ser desabilitada no Apache Tomcat",
"Probability":4,
"Reference":"no references",
"Severity":4,
"Source":"Apache Tomcat Security Guide"
}