Returns a paginated list of the knowledge bases registered in the system.
URL
{RMUrl}/api/knowledge/knowledgebases[?[[&]$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 knowledge bases 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 Id;
string Name;
double CurrentVersion;
int Controls;
Datetime CreatedOn;
string CustomerID;
int Status;
int Source;
The Status field can have the following values: 1 for "Editing", 2 for "Published", and 6 for "Finished".
The Source field can have the following values: 0 for "Custom" (custom knowledge bases), 1 for "Modulo" (knowledge bases provided by Modulo), and 2 for "Third Party" (knowledge bases from third parties).
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 knowledge bases (by default, ten knowledge bases are listed at a time):
{RMUrl}/api/Knowledge/knowledgebases
Knowledge bases 11 through 20 (second page):
{RMUrl}/api/Knowledge/knowledgebases?page=2
Filter by "PCI" in the "Name" field:
{RMUrl}/api/Knowledge/knowledgebases?$filter=substringof('PCI',Name)
SUCCESS RESPONSE
List of objects with information on the knowledge bases according to the filters and page size specified.
KnowledgeBase[].
The KnowledgeBase object is in the following format:
KnowledgeBase
{
Guid Id;
string Name;
double CurrentVersion;
int Controls;
DateTime CreatedOn;
string CustomerID;
string Status;
string Source;
string Type;
}
SUCCESS RESPONSE EXAMPLES
[{"Controls":42,
"CreatedOn":"\/Date(1338230970110-0300)\/",
"CurrentVersion":3.4,
"CustomerID":"MOD_EN.000193",
"Id":"e2e2b0f9-2578-4caa-b5d1-99d13166620e",
"Name":" Application - \"Database\" - Sybase Adaptive Server",
"Source":"Modulo",
"Status":"Published",
"Type":"Technology"
},
{"Controls":87,
"CreatedOn":"\/Date(1338230971543-0300)\/",
"CustomerID":"DEV-01.000003",
"Id":"2681de33-b3a0-4633-81cc-f79446a4fbde",
"Name":"Person – End-User",
"Source":"Custom",
"Status":"Editing",
"Type":"Person"}
]