POST GetReport
URL: /api/Report/GetReport
Description
Retrieve a report from the library that matches the provided report id and that the logged in user has permissions too view. This is used by the Report Builder to edit existing reports.
Method
POST
Data Params
{
sessionToken : [string],
ReportId: [string]
}Example
{
sessionToken : "CHOVLXUELTP[XNKDMGCFPDMLL",
search: "1452853052"
}Success Response
Code: 200
Response will be JSON object.
{
"AdHocFields": [],
"ChartFmt": {
"LegendHeader": "",
"LegendPosition": 0,
"SeriesDef": [],
"ShowLegend": 0,
"ValueAxisMax": 0,
"ValueAxisMin": 0,
"b3d": 0,
"charttitle": null,
"charttype": null,
"datarange": null,
"elementrotation": 0,
"fillcolor": null,
"isCurrency": false,
"isPercent": false,
"labelformat": 0,
"showlabels": 0,
"showtooltips": 0,
"smartlabels": 0,
"tickinterval": 0,
"transpose": 0,
"useDiscrete": false,
"withPercent": false,
"xaxis": 0,
"xaxisgridlines": 0,
"xaxisstriplines": 0,
"xaxistitle": null,
"yaxis": 0,
"yaxisgridlines": 0,
"yaxisstriplines": 0,
"yaxistitle": null
},
"Combochart": {
"argumentField": null,
"legendhorizontal": null,
"legendvertical": null,
"series": [],
"valueAxis": []
},
"CreatedBy": {
"AllApplications": [],
"AllGroups": [],
"AllRoles": [],
"AppShieldConstraints": [],
"Applications": [
{
"ApplicationID": "6",
"ApplicationName": "Remedy AR System 7.1",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "1030",
"ApplicationName": "Google BigQuery",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "52",
"ApplicationName": "Yurbi v10",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "50",
"ApplicationName": "Remedy ITSM 7.6",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "51",
"ApplicationName": "Remedy ITSM 8.1",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "11",
"ApplicationName": "CA Service Desk r12 ITIL",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "1026",
"ApplicationName": "test",
"ApplicationRoleID": "6",
"ApplicationRoleName": "Agent",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "33",
"ApplicationName": "Yurbi Advanced Reports",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
}
],
"AuthenticationType": "PIN",
"ComboName": "Admin, Yurbi",
"CreateDate": "2011-10-13T14:47:50",
"Description": "Builtin Yurbi Admin account ",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"EmailAddress": "[email protected]",
"FirstName": "Yurbi",
"FullName": "Yurbi Admin",
"Id": "1",
"LastName": "Admin",
"LoginDate": "2016-06-20T13:23:28",
"LoginName": "admin",
"ModifyDate": "2015-06-17T14:52:29",
"Pin": "",
"Preferences": [],
"SecurityGroups": [
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2011-10-13T14:47:51",
"Description": "Yurbi Admins",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Full access to resources assigned to this group",
"RoleID": "1",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "Admin"
}
],
"Id": "1",
"Membership": [],
"ModifyDate": "2011-10-13T14:47:51",
"Name": "Administrators"
},
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2011-10-13T14:47:51",
"Description": "Yurbi Anonymous Objects",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Read-Only access to resources within this group",
"RoleID": "2",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "View"
}
],
"Id": "2",
"Membership": [],
"ModifyDate": "2011-10-13T14:47:51",
"Name": "Anonymous"
},
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2011-10-13T14:47:51",
"Description": "All Users",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Full access to resources assigned to this group",
"RoleID": "1",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "Admin"
}
],
"Id": "0",
"Membership": [],
"ModifyDate": "2011-10-13T14:47:51",
"Name": "AllUsers"
},
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2015-10-21T12:27:41",
"Description": "test",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Edit permissions granted on resources assigned to this group",
"RoleID": "3",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "Modify"
}
],
"Id": "16",
"Membership": [],
"ModifyDate": "2015-10-21T12:27:41",
"Name": "test"
}
],
"isAdmin": true,
"isAgent": true,
"isArchitect": true,
"isBuilder": false,
"isConnectBuilder": false,
"isFirstRun": false,
"isSuperAdmin": true
},
"CreatedDate": "2016-01-15T10:17:32",
"CrossTab": {
"ColMembers": [],
"DataMembers": [],
"DrillDownTarget": "",
"RowMembers": [],
"bTotalCols": 0,
"bTotalRows": 0,
"isPivotDrillDown": false
},
"DbDriver": "",
"DbLogin": "",
"DbName": "",
"DbPass": "",
"Description": "",
"ErrorCode": 0,
"ErrorMessage": "",
"FieldList": [
{
"Criteria": [],
"DbFieldName": "ref_num",
"DbParentTableAlias": null,
"DbTableAlias": "INC",
"DisplayFieldName": "Incident#",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"FieldTotals": null,
"Fieldtype": "cha",
"Formula": "",
"RenamedField": "Incident",
"ReportFieldName": "Incident#",
"SearchCriteria": "",
"TotalsSubtotals": "",
"chkflag": false,
"fieldindex": 1,
"grouped": 0,
"strGroup": "/Incident/Incident#",
"strRoot": "",
"tbl10": "",
"tbl11": "",
"tbl13": "",
"tbl5": "Y"
},
{
"Criteria": [
{
"Field": "Active",
"Index": 0,
"Logical": "And",
"Nested": false,
"Op": "=",
"Value1": "YES",
"Value2": "",
"bprompt": false,
"bskip": false,
"cond": "Is"
}
],
"DbFieldName": "sym",
"DbParentTableAlias": null,
"DbTableAlias": "ACT",
"DisplayFieldName": "Active",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"FieldTotals": null,
"Fieldtype": "cha",
"Formula": "",
"RenamedField": "Active",
"ReportFieldName": "Active",
"SearchCriteria": "? = 'YES'",
"TotalsSubtotals": "",
"chkflag": false,
"fieldindex": 2,
"grouped": 0,
"strGroup": "/Incident/Active",
"strRoot": "",
"tbl10": "? = YES",
"tbl11": "And",
"tbl13": "?^=^YES",
"tbl5": "Y"
},
{
"Criteria": [],
"DbFieldName": "open_date",
"DbParentTableAlias": null,
"DbTableAlias": "INC",
"DisplayFieldName": "OpenDate",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"FieldTotals": null,
"Fieldtype": "udt",
"Formula": "",
"RenamedField": "OpenDate",
"ReportFieldName": "OpenDate",
"SearchCriteria": "",
"TotalsSubtotals": "",
"chkflag": false,
"fieldindex": 3,
"grouped": 0,
"strGroup": "/Incident/Dates/OpenDate",
"strRoot": "",
"tbl10": "",
"tbl11": "",
"tbl13": "",
"tbl5": "Y"
}
],
"FieldOrder": {
"F_order": ""
},
"FieldSort": {
"Field_Name": "",
"Sort_Method": ""
},
"FormLayout": [],
"KPIGauge": {
"Column": 0,
"KPIMax": "",
"KPIMin": "",
"KPITitle": "",
"ReportID": "",
"ReportName": "active incidents",
"Row": 0
},
"KPIText": {
"Column": 0,
"KPIGoalLabel": "",
"KPIGoalValue": "",
"KPIGoalValueLabel": "",
"KPILabel": "",
"KPITitle": "",
"KPIValue": "",
"ReportID": "",
"ReportName": "active incidents",
"Row": 0,
"Tmode": 0,
"argument": null,
"sparkline": 0,
"sparkline_target": "",
"value": null
},
"LastModifiedBy": {
"AllApplications": [],
"AllGroups": [],
"AllRoles": [],
"AppShieldConstraints": [],
"Applications": [
{
"ApplicationID": "6",
"ApplicationName": "Remedy AR System 7.1",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "1030",
"ApplicationName": "Google BigQuery",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "52",
"ApplicationName": "Yurbi v10",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "50",
"ApplicationName": "Remedy ITSM 7.6",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "51",
"ApplicationName": "Remedy ITSM 8.1",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "11",
"ApplicationName": "CA Service Desk r12 ITIL",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "1026",
"ApplicationName": "test",
"ApplicationRoleID": "6",
"ApplicationRoleName": "Agent",
"ApplicationRoleType": "0"
},
{
"ApplicationID": "33",
"ApplicationName": "Yurbi Advanced Reports",
"ApplicationRoleID": "7",
"ApplicationRoleName": "Architect",
"ApplicationRoleType": "0"
}
],
"AuthenticationType": "PIN",
"ComboName": "Admin, Yurbi",
"CreateDate": "2011-10-13T14:47:50",
"Description": "Builtin Yurbi Admin account ",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"EmailAddress": "[email protected]",
"FirstName": "Yurbi",
"FullName": "Yurbi Admin",
"Id": "1",
"LastName": "Admin",
"LoginDate": "2016-06-20T13:23:28",
"LoginName": "admin",
"ModifyDate": "2015-06-17T14:52:29",
"Pin": "",
"Preferences": [],
"SecurityGroups": [
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2011-10-13T14:47:51",
"Description": "Yurbi Admins",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Full access to resources assigned to this group",
"RoleID": "1",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "Admin"
}
],
"Id": "1",
"Membership": [],
"ModifyDate": "2011-10-13T14:47:51",
"Name": "Administrators"
},
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2011-10-13T14:47:51",
"Description": "Yurbi Anonymous Objects",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Read-Only access to resources within this group",
"RoleID": "2",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "View"
}
],
"Id": "2",
"Membership": [],
"ModifyDate": "2011-10-13T14:47:51",
"Name": "Anonymous"
},
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2011-10-13T14:47:51",
"Description": "All Users",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Full access to resources assigned to this group",
"RoleID": "1",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "Admin"
}
],
"Id": "0",
"Membership": [],
"ModifyDate": "2011-10-13T14:47:51",
"Name": "AllUsers"
},
{
"AllRoles": null,
"AllUsers": null,
"CreateDate": "2015-10-21T12:27:41",
"Description": "test",
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"GroupRoles": [
{
"ERROR_CODE": 0,
"ERROR_MESSAGE": "",
"RoleCreated": "2009-06-29T00:00:00",
"RoleDescription": "Edit permissions granted on resources assigned to this group",
"RoleID": "3",
"RoleModified": "2009-06-29T00:00:00",
"RoleName": "Modify"
}
],
"Id": "16",
"Membership": [],
"ModifyDate": "2015-10-21T12:27:41",
"Name": "test"
}
],
"isAdmin": true,
"isAgent": true,
"isArchitect": true,
"isBuilder": false,
"isConnectBuilder": false,
"isFirstRun": false,
"isSuperAdmin": true
},
"LastModifiedDate": "2016-01-15T10:17:32",
"ModType": "r12AHDI",
"ModuleName": "CA Service Desk r12 ITIL",
"OutputFormat": {
"Content": "",
"TypeId": 0
},
"OutputType": 1,
"Permissions": [
{
"ErrorCode": 0,
"ErrorMessage": "",
"LeftID": "1452853052",
"Option1": "",
"Option10": "",
"Option2": "",
"Option3": "",
"Option4": "",
"Option5": "",
"Option6": "",
"Option7": "",
"Option8": "",
"Option9": "",
"PermissionTypeEnum": 1,
"RelationShip": 0,
"RelationType": "rpt_grp",
"RelationshipType": "rpt_grp",
"RightID": "0"
}
],
"PluginId": 0,
"Published": "",
"ReportID": "1452853052",
"ReportType": "Incidents",
"Reportname": "active incidents",
"ServerName": "yurbidev1\\sql2012",
"SmartPrompt": 0,
"TimeZone": 5,
"TopN": "0",
"folderid": 25,
"linkreportjoin": {
"field1": null,
"field2": null,
"filter": null,
"joinop": null,
"jointype": null,
"table1": null,
"table2": null
},
"linkreports": [],
"linkreportunion": []
}Definition of DashobardListItem
| Name | Description | Type |
| AdHocFields | List of any AdHocField definition objects. See AdHocField | object |
| ChartFmt | Chart definition. See ChartFmt | object |
| Combochart | Combochart definition. see Combochart | object |
| CratedBy | CreatedBy contact object. See Contact. | object |
| CreatedDate | Date report was first saved. | datetime |
| CrossTab | Yurbi Pivot definition. See CrossTab | object |
| DbDriver | Legacy not in use. | string |
| DbLogin | Legacy not in use. | string |
| DBName | Legacy not in use. | string |
| DbPass | Legacy not in use. | string |
| Description | Report description | string |
| ErrorCode | 0 if no error. | integer |
| ErrorMessage | Empty when no error. | string |
| FieldList | List of fields that are included in this report. See FieldList. | object |
| folderid | Id of library folder where report is saved. | integer |
| FormLayout | Not in use. | |
| KPIGauge | KPIGauge definition. See KPIGauge. | object |
| KPIText | KPITEXT defintion. See KPIText. | object |
| LastModifiedBy | Contact record of last user to save changes to the report. | object |
| LastModifedDate | Date of last save. | datetime |
| linkreportjoin | Definition of link to another report if joined. | object |
| linkreportunion | Definition of link to another report if union-ed. | object |
| ModType | Yurbi internal App id. | string |
| ModuleName | Name of the Yurbi App the report was built from. | string |
| OutputFormat | Not in use | NA |
| OutputType | 1 = Grid | integer |
| Permissions | List of permissions assigned to the report. | object |
| PluginId | Legacy not in use | NA |
| Published | Legacy not in use | NA |
| Reportname | Name of report in library. | string |
| ReportType | Name of Yurbi App Report type used to build the report. | string |
| ServerName | Name of the data source used to build the report against. | string |
| SmartPrompt | Flag to turn smart prompting feature on/off. | boolean |
| TimeZone | Timezone offset applied to any dates used in the report. | integer |
| TopN | Return only Top N number of rows. 0 is all records. | integer |
Sample Call
$.ajax({
url: "/api/Report/GetReport",
dataType: "json",
data : {
sessionToken : “HJQXIYYL[AZVTTRPILOHXHLWW”,
ReportId:“1452853052”},
type : "POST",
success : function(r) {
console.log(r);
}
});