POST GetListByFolderID
URL: /api/library/GetListByFolderID
Description
Retrieve a list of all reports and dashboards(library items) in the Yurbi library that belongs to the provided Folder ID and that the logged in user has permissions to view.
Method
POST
Data Params
{
sessionToken : [string],
LibraryID: [string]
}Example
{
sessionToken : "HJQXIYYL[AZVTTRPILOHXHLWW",
LibraryID : "25"
}Success Response
Code: 200
Response will be empty if no matching library items are found. If one or more matching items are found then a JSON array will be returned in x number of matches of list items.
{
"AppDisplayName":"My help desk r12",
"Application":"CA Service Desk r12 ITIL",
"CreatedBy":"admin, Yurbi",
"CreatedDate":"2015-07-28T12:51:34",
"Description":"",
"LastModified":"2016-06-07T12:00:00",
"ModType":"r12AHDI",
"ModifiedBy":"admin, Yurbi",
"PluginId":0,
"Published":"False",
"ReportName":"Sales Goal",
"ReportType":"Incidents",
"error_code":0,
"error_message":null,
"folderid":25,
"id":1438087894,
"index":0,
"isEmbedable":false,
"isFav":true,
"isPublicView":false,
"isUserAdmin":true,
"isUserAgent":true,
"isUserArchitect":true,
"isUserBuilder":true,
"isUserDelete":true,
"isUserModify":true,
"isUserView":true,
"itemtype":3
},
{
"AppDisplayName":"My help desk r12",
"Application":"CA Service Desk r12 ITIL",
"CreatedBy":"admin, Yurbi",
"CreatedDate":"2015-08-06T13:47:25",
"Description":"",
"LastModified":"2016-06-07T12:03:00",
"ModType":"r12AHDI",
"ModifiedBy":"admin, Yurbi",
"PluginId":0,
"Published":"False",
"ReportName":"YTD Sales",
"ReportType":"Incidents",
"error_code":0,
"error_message":null,
"folderid":25,
"id":1438868845,
"index":0,
"isEmbedable":false,
"isFav":true,
"isPublicView":false,
"isUserAdmin":true,
"isUserAgent":true,
"isUserArchitect":true,
"isUserBuilder":true,
"isUserDelete":true,
"isUserModify":true,
"isUserView":true,
"itemtype":3
}
]Definition of Library List Items - ReadOnly
| Name | Description |
| AppDisplayName | The UI display name for the Yurbi app that was used to build the report. |
| Application | Yurbi internal application name used to create the report. |
| CreatedBy | Lastname, Firstname of contact that created the report. |
| Description | Report description. |
| error_code | error code |
| error_message | Error message. |
| folderid | Library folder id number. |
| id | Report id. |
| index | NA |
| isEmbedable | Can the report be used with embed code. |
| isFav | Is report currently Favorited by the logged in user. |
| isPublicView | Is report allow to be anonymously view and executed. |
| isUserAdmin | Does user have admin access to report. |
| isUserAgent | Does the user have agent access to report, user can execute. |
| isUserArchitect | Does the user have Architect access the the Yurbi App used to build the report. |
| isUserBuilder | Does the user have Builder access to the report, can modify report. |
| isUserDelete | Does the user have delete permission. |
| isUserModify | Does the user have modify rights. |
| isUserView | Does the user have view rights. |
| itemtype | 0=Dashboard, 1 = grid, 2=chart, 3=KPI text, 4=KPI gauge, 5=NA,6=PieChart, 7=ComboChart |
| LastModified | Last Modified Date. |
| ModifiedBy | Last name, First name of last modified by contact. |
| ModType | Internal Yurbi App code. |
| PluginId | NA |
| Published | Not in use |
| ReportName | Report name |
| ReportType | Report type from Yurbi App used to create report. |
Sample Call
$.ajax({
url: ApiUrl + '/api/library/GetListByFolderID',
type: 'POST',
data: JSON.stringify(libraryListJSON),
contentType: 'application/json; charset=utf-8',
dataType: 'json',
async: true,
success: function(msg) {
lstFolderReports = msg;
}
});