Retorna a lista de componentes de ativo incluídos no escopo de um projeto de riscos. No sistema, essa lista inclui as seguintes colunas, cujas informações serão retornadas pela API: Perimeter, Asset, Asset Component, Knowledge Base, KB Version, Survey, Survey ID, Analyst, Interviewee e Reviewer. (Em português: Perímetro, Ativo, Componente de Ativo, Knolwedge Base, Versão do KB, Pesquisa, ID da Pesquisa, Analista, Entrevistado e Revisor.)
Observe que esta funcionalidade não inclui o escopo de vulnerabilidades do projeto.
URL
{RMUrl}/api/risk/projects/<CódigoDoProjetodeRiscos>/controlscope[?[[&]$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
RiskProjectID: 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 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
string AssetName;
guid AssetId;
string PerimeterName;
guid PerimeterId;
string KnowledgeBaseName;
double KnowledgeBaseVersion;
string KnowledgeBaseId;
string KnowledgeBaseCustomerId;
string SurveyName;
string SurveyId;
string SurveyCustomerID;
string AssetComponentName;
string AssetComponentId;
guid AnalystId;
string AnalystName;
string AnalystPhone;
string AnalystEmail;
string IntervieweeId;
string IntervieweeName;
string IntervieweePhone;
string IntervieweeEmail;
string ReviewerId;
string ReviewerName;
string ReviewerPhone;
string ReviewerEmail;
int QuestionnaireStatusCode;
int QuestionnaireId;
O filtro do campo QuestionnaireStatusCode pode assumir um dos seguintes valores: 0 (Não Aberto), 1 (Aberto) e 8 (Fechado).
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 no escopo do projeto de riscos (por padrão, somente 10 são listados por vez):
{RMUrl}/api/risk/projects/PRJR12012/controlscope
Os componentes de 11 a 20 (segunda página):
{RMUrl}/api/risk/projects/PRJR12012/controlscope?page=2
Filtrar por "Windows" no campo "Nome" do componente de ativo:
{RMUrl}/api/risk/projects/PRJR12012/controlscope?$filter=substringof('Windows',AssetComponentName)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os componentes de ativo acordo com os filtros e o tamanho da página especificados.
RiskProjectControlScope[].
O objeto RiskProjectControlScope está no seguinte formato:
RiskProjectControlScope
{
object AssetComponent;
object Asset;
object Perimeter;
object KnowledgeBase;
object Survey;
object Questionnaire;
humanresource Analyst;
humanresource Interviewee;
humanresource Reviewer;
}
EXEMPLO DE RESPOSTAS DE SUCESSO
[{
"AssetComponent":{
"Id":"da800934-0750-11e2-94d2-001ec91f4b0a",
"Name":"Desktop - Google Chrome 2.0"
},
"Asset":{
"Id":"6092324d-5293-40db-aad6-08a0b334b95a",
"Name":"Desktop"
},
"Perimeter":{
"Id":"f467d40d-1493-4da4-9b58-d668b8b428b7",
"Name":"Departamento de Marketing"
},
"KnowledgeBase":{
"Version":1.0,
"CustomerID":"DEV-01.000004",
"Id":"307dfef0-073d-11e2-94d2-001ec91f4b0a",
"Name":"Tecnologia - Application - \"Browser\" - Google Chrome 2.0"
},
"Survey":{
"CustomerID":"DEV-01.00000002",
"Id":"0a60967f-7bef-494b-9003-a263e4efe7b0",
"Name":"Pesquisa do Google Chrome"
},
"Analyst":{
"Id":"072b63aa-fea8-11e1-94b3-001ec91f4b0a",
"Name":"Alexandre Ferreira",
"Phone":"+55 (21) 2100-0000",
"Email":"alexandre@exemplo.com.br"
},
"Interviewee":{
"Id":"2ed8e2b5-027a-11e2-b84c-001ec91f4b0a",
"Name":"Marcos Silva",
"Phone":"+55 (21) 2100-0000",
"Email":"marcos@exemplo.com.br"
},
"Questionnaire":{
"Id":"169",
"OpenedOn":"\/Date(1357648997420-0200)\/",
"ClosedOn":"\/Date(1357649057153-0200)\/",
"Status":"Closed",
"StatusCode":8
},
"Reviewer":{
"Id":"fa9a036e-071b-11e2-94d2-001ec91f4b0a",
"Name":"Juliana Gomes",
"Phone":"+55 (21) 2100-0000",
"Email":"juliana@exemplo.com.br"
}},
{
"AssetComponent":{
"Id":"edd06796-01c2-11e2-94b3-001ec91f4b0a",
"Name":"10.1.0.100 - Unix Solaris 8/9"
},
"Asset":{
"Id":"073b0880-c030-4251-8830-567425d08bb2",
"Name":"Servidor Solaris"
},
"Perimeter":{
"Id":"808f4b2d-754c-453f-a58d-49a594b7d110",
"Name":"Datacenter"
},
"KnowledgeBase":{
"Version":6.8,
"CustomerID":"MOD_EN.001407",
"Id":"8ab166c3-0f98-41d4-93cf-4cf6e7a59e6a",
"Name":"Operating System - \"Unix\" - Unix Solaris 8 and 9"
},
"Analyst":{
"Id":"072b63aa-fea8-11e1-94b3-001ec91f4b0a",
"Name":"Alexandre Ferreira",
"Phone":"+55 (21) 2100-0000",
"Email":"alexandre@exemplo.com.br"
},
"Questionnaire":{
"Status":"Not Opened",
"StatusCode":0}}]