POST SearchDashboardList
URL: /api/Dashboard/SearchDashboardList
Description
Retrieve a list of all dashboards in the Yurbi library that matches the provided search string and that the logged in user has permissions too view.
Method:
POST
Data Params
{
sessionToken : [string],
search: [string]
}Example
{
sessionToken : "HJQXIYYL[AZVTTRPILOHXHLWW",
search: "Sales"
}Success Response
Code: 200Response will empty if no matching dashboards found. If one or more matching dashboards are found then a JSON array will be returned in x number of matches of DashboardListItem.
[
{
Descr: "2015 Sales Dashboard",
id: 10,
isFav: 0,
name= "2015 Sales",
weight=0
},
{
Descr: "2014 Sales Dashboard",
id: 5,
isFav: 0,
name= "2014 Sales",
weight=1
}
]Definition of DashobardListItem
| Name | Description | Type |
| descr | Description of Dashboard | string |
| id | Unique id of stored dashboard, used to retrieve dashboard for display. | integer |
| isFav | 1 if this dashboard is in logged in users’ favorite list. | integer |
| name | Name of the dashboard. | string |
| weight | Search list index value. | integer |
Sample Call
$.ajax({
url: "/api/Dashboard/SearchDashboardList",
dataType: "json",
data : {
sessionToken : “HJQXIYYL[AZVTTRPILOHXHLWW”,
search: “Sales”},
type : "POST",
success : function(r) {
console.log(r);
}
});