Returns the list of asset components included in the scope of a risk project. In the system, this list includes the following columns, which will also be returned by the API: Perimeter, Asset, Asset Component, Knowledge Base, KB Version, Survey, Survey ID, Analyst, Interviewee, and Reviewer.
Note that this feature does not include the scope of vulnerabilities of the project.
URL
{RMUrl}/api/risk/projects/<ProjectCode>/controlscope[?[[&]$filter=<FilterCriteria>][[&]page=<PageNumber>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]
REQUEST METHOD
GET
URL PARAMETERS
RiskProjectID: This parameter is provided in the URL and does not need to be sent through GET.
page: Number of the page to be displayed. Valid values: 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.
page_size: Number of items displayed per page. Valid values: 1 to 1,000. If omitted, the default value of 10 is used.
filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.
orderby: Orders the asset components listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each desired field. The supported fields are listed below.
FIELDS SUPPORTED BY FILTER
string AssetName;
guid AssetId;
string PerimeterName;
guid PerimeterId;
string KnowledgeBaseName;
double KnowledgeBaseVersion;
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;
The filter for the QuestionnaireStatusCode field can have one of the following values: 0 for "Not Opened", 1 for "Open", and 8 for "Closed".
For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.
REQUEST EXAMPLES
The first ten asset components in the scope of the risk project (by default, ten asset components are listed at a time):
{RMUrl}/api/risk/projects/PRJR12012/controlscope
Asset components 11 through 20 (second page)
{RMUrl}/api/risk/projects/PRJR12012/controlscope?page=2
Filter by "Windows" in the "Name" field of the asset component:
{RMUrl}/api/risk/projects/PRJR12012/controlscope?$filter=substringof('Windows',AssetComponentName)
SUCCESS RESPONSE
List of objects with information on the asset components in the scope of the project, according to the page number and filters specified.
RiskProjectControlScope[].
The RiskProjectControlScope object is in the following format:
RiskProjectControlScope
{
object AssetComponent;
object Asset;
object Perimeter;
object KnowledgeBase;
object Survey;
object Questionnaire;
humanresource Analyst;
humanresource Interviewee;
humanresource Reviewer;
}
SUCCESS RESPONSE EXAMPLES
[{
"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":"Marketing Dept"
},
"KnowledgeBase":{
"Version":1.0,
"CustomerID":"DEV-01.000004",
"Id":"307dfef0-073d-11e2-94d2-001ec91f4b0a",
"Name":"Technology - Application - \"Browser\" - Google Chrome 2.0"
},
"Survey":{
"CustomerID":"DEV-01.00000002",
"Id":"0a60967f-7bef-494b-9003-a263e4efe7b0",
"Name":"Google Chrome Survey"
},
"Analyst":{
"Id":"072b63aa-fea8-11e1-94b3-001ec91f4b0a",
"Name":"John Smith",
"Phone":"+1 (646) 555-0000",
"Email":"jsmith@example.com"
},
"Interviewee":{
"Id":"2ed8e2b5-027a-11e2-b84c-001ec91f4b0a",
"Name":"Laura Morris",
"Phone":"+1 (646) 555-0000",
"Email":"lmorris@example.com"
},
"Questionnaire":{
"Id":"169",
"OpenedOn":"\/Date(1357648997420-0200)\/",
"ClosedOn":"\/Date(1357649057153-0200)\/",
"StatusCode":"Closed"
},
"Reviewer":{
"Id":"fa9a036e-071b-11e2-94d2-001ec91f4b0a",
"Name":"Julia Goldsmith",
"Phone":"+1 (646) 555-0000",
"Email":"jgoldsmith@example.com"
}},
{
"AssetComponent":{
"Id":"edd06796-01c2-11e2-94b3-001ec91f4b0a",
"Name":"10.1.0.100 - Unix Solaris 8/9"
},
"Asset":{
"Id":"073b0880-c030-4251-8830-567425d08bb2",
"Name":"Solaris Server"
},
"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":"John Smith",
"Phone":"+1 (646) 555-0000",
"Email":"jsmith@example.com"
},
"Questionnaire":{
"Status":"Not Opened"
"StatusCode":0}}]