Returns a paginated list of the asset components in the organizational structure.
URL
{RMUrl}/api/Organization/assets/components[?[[&]$filter=<filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]
REQUEST METHOD
GET
URL PARAMETERS
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
Guid AssetId;
string Name;
string Description;
Guid Id;
string KnowledgeBaseId;
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 (by default, ten asset components are listed at a time):
{RMUrl}/api/Organization/assets/components
Asset components 11 through 20 (second page):
{RMUrl}/api/Organization/assets/components?page=2
Filter by asset ID:
{RMUrl}/api/Organization/assets/components?$filter=AssetId eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filter by "Windows" in the "Name" field:
{RMUrl}/api/Organization/assets/components?$filter=substringof('Windows',Name)
SUCCESS RESPONSE
List of objects with information on the asset components, according to the filter and page size specified.
AssetComponent[].
The AssetComponent object is in the following format:
{
Guid AssetId;
string Name;
string Description;
Guid Id;
string KnowledgeBaseId;
}
SUCCESS RESPONSE EXAMPLES
[
{
"AssetId":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Windows 2008 Server – Standard Database"
"Description":"Main California server",
"Id":"29e5b79d-4b54-11e1-b4b4-0800270094a6",
"KnowledgeBaseId":"MOD_EN.000348",
},
{
"AssetId":"63e5fe02-5773-4a49-ba13-22506f022316",
"Name":"Router/Firewall - Cisco PIX s500 OS v6.3"
"Description":"Internet router",
"Id":"3a5e728d-4b54-11e1-b4b4-0800270094a6",
"KnowledgeBaseId":"MOD_EN.000095",
},
{
"AssetId":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Linux Server - Linux Suse 10"
"Description":"Linux and web servers",
"Id":"4447527c-4b54-11e1-b4b4-0800270094a6",
"KnowledgeBaseId":"MOD_EN.000133",
}
]