Report Designer Details APIs

Summary

GET report/category/{type}/(tenant_id)

Returns an array of allowed saving categories by type (Reports/Templates/Dashboards), filtered by tenant_id if given.

type

• 0 = Reports
• 1 = Templates
• 2 = Dashboards

Request

No payload

Response

An array of Category objects

Samples

GET/api/report/category/1HTTP/1.1

Sample response:

[{"name":"Category 1","type":"Templates","parentId":null,"tenantId":null,"status":2,"id":"17c176e1-500b-4378-8c59-1f69e84e425b","state":0,"modified":null"},{"name":"Sub Category 1","type":"Templates","parentId":"17c176e1-500b-4378-8c59-1f69e84e425b","tenantId":null,"status":2,"id":"14b3f8c7-c4e8-4730-a57e-3b28ad75b097","state":0,"modified":null"},{"name":"Sub Category 2","type":"Templates","parentId":"17c176e1-500b-4378-8c59-1f69e84e425b","tenantId":null,"status":2,"id":"72d44e10-a707-455e-99dc-054088b6b2f3","state":0,"modified":null"}]

POST report/allowedSavingCategories

Returns an array of allowed saving categories for report, with total number of items.

Request

Payload: a ReportDashboardSearchCriteria object

Response

The following object:

Field	Description	Note
data array of objects	An array of Category objects
isLastPage boolean	Whether this is the last page

Samples

POST/api/report/allowedSavingCategoriesHTTP/1.1

Sample Request Payload:

{"tenantId":null,"isUncategorized":false,"criterias":[],"ParentIds":["5ca51cd0-1f63-44ca-9711-ba6c988a520a"]}

Sample Response:

{"data":[{"name":"Category01","type":0,"parentId":null,"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"f93c0770-9629-41ee-9ac2-48e4c89fc2d0","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"System5 Admin5","modified":null,"modifiedBy":null},{"name":"Category02","type":0,"parentId":null,"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"System5 Admin5","modified":null,"modifiedBy":null}],"isLastPage":true}

POST report/allowedSavingSubCategories

Returns an array of allowed saving sub-categories for report, with total number of items.

The following object:

Field	Description	Note
data array of objects	An array of Category objects
totalItems string	The number of all reports
numOfChilds integer	The number of children
numOfCheckedChilds integer	The number of selected children
indeterminate boolean	true if 0 < numOfCheckedChilds < numOfChilds false if not
isLastPage boolean	Whether this is the last page

Samples

POST/api/report/allowedSavingSubCategoriesHTTP/1.1

Sample Request Payload:

{"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","isUncategorized":false,"criterias":[],"ParentIds":["5ca51cd0-1f63-44ca-9711-ba6c988a520a"]}

Sample Response:

{"data":[{"name":"SubCategory02","type":0,"parentId":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"0e771076-c385-4c1f-a10d-a89c2b473405","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"System5 Admin5","modified":null,"modifiedBy":null},{"name":"SubCategory02","type":0,"parentId":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"f432f63a-92f4-4b9d-8d1f-1433c5f323f8","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"System5 Admin5","modified":null,"modifiedBy":null}],"isLastPage":true}

GET report/subcategory/{parent_category_id}

Returns an array of allowed saving sub-categories under the Report category specified by parent_category_id.

Request

No payload

Response

An array of Category objects

Samples

GET/api/report/subcategory/17c176e1-500b-4378-8c59-1f69e84e425bHTTP/1.1

Sample response:

[{"name":"Sub Category 1","type":null,"parentId":"17c176e1-500b-4378-8c59-1f69e84e425b","tenantId":null,"status":2,"id":"72d44e10-a707-455e-99dc-054088b6b2f3","state":0,"modified":null},{"name":"Sub Category 2","type":null,"parentId":"17c176e1-500b-4378-8c59-1f69e84e425b","tenantId":null,"status":2,"id":"14b3f8c7-c4e8-4730-a57e-3b28ad75b097","state":0,"modified":null}]

GET report/allCategories/{type}/(tenant_id)

Returns the list of categories by type (Reports/Templates/Dashboards) in parent-child hierarchy.

type

• 0 = Reports
• 1 = Templates
• 2 = Dashboards

Request

No payload

Response

An array of Category objects

Samples

GET/api/report/allCategories/0HTTP/1.1

Sample response:

[{"name":"Category 1","type":0,"parentId":null,"tenantId":null,"subReportCategories":null,"canDelete":false,"status":2,"id":"f2d79ff5-3aa8-4ae6-b0d0-e47687a77380","state":0,"inserted":true,"version":null,"created":null,"createdBy":null,"modified":null,"modifiedBy":null},{"name":"Category 2","type":0,"parentId":null,"tenantId":null,"subReportCategories":[{"name":"Sub-category 1","type":0,"parentId":"f514e26f-501c-4369-8ea9-de4eba208bdf","tenantId":null,"subReportCategories":null,"canDelete":false,"status":2,"id":"81517214-273b-42e9-91b5-8ef766cc5761","state":0,"inserted":true,"version":null,"created":null,"createdBy":null,"modified":null,"modifiedBy":null}],"canDelete":false,"status":2,"id":"f514e26f-501c-4369-8ea9-de4eba208bdf","state":0,"inserted":true,"version":null,"created":null,"createdBy":null,"modified":null,"modifiedBy":null}]

POST report/allCategories

Returns the list of categories in parent-child hierarchy, with total number of items.

Request

Payload: a ReportDashboardSearchCriteria object

Response

The following object:

Field	Description	Note
data array of objects	An array of Category objects
totalItems string	The number of all items
numOfChilds integer	The number of children
numOfCheckedChilds integer	The number of selected children
indeterminate boolean	true if 0 < numOfCheckedChilds < numOfChilds false if not
isLastPage boolean	Whether this is the last page

Samples

POST/api/report/allCategoriesHTTP/1.1

Sample response:

{"data":[{"name":"Local Categories","type":0,"parentId":null,"tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[{"name":"CN","type":0,"parentId":null,"tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[],"dashboards":[],"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"dc04087a-a761-43fb-b82d-13d2ffe8d9e3","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null}],"checked":false,"reports":[],"dashboards":[],"numOfChilds":1,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"09f8c4ab-0fe8-4e03-82d1-7949e3738f87","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null}],"totalItems":2,"numOfChilds":1,"numOfCheckedChilds":0,"indeterminate":false,"isLastPage":true}

POST report/category

Renames a report category.

Request

A Category object

Response

Field	Description	Note
success boolean	Is the rename successful
messages array of strings	The error messages

Samples

POST/api/report/categoryHTTP/1.1

Request Payload:

{"id":"f2d79ff5-3aa8-4ae6-b0d0-e47687a77380","type":1,"name":"Category 1 renamed","parentId":null,"tenantId":null,"status":2,"state":0,"modified":null,"canDelete":false,"subCategories":[],"subReportCategories":null,"reports":[]}

Successful response:

{"success":true,"messages":null}

DELETE report/category/{report_category_id}

Removes the report category specified by report_category_id.

Request

No payload

Response

An OperationResult object with the success field populated:

Field	Description	Note
success boolean	Is the rename successful

Samples

DELETE/api/report/category/f285a869-25fb-428e-8cef-856241ba4249HTTP/1.1

Sample response in case of error:

{"success":false,"messages":[{"key":"","messages":["This category (or its sub-category) containing report(s)."]}]"data":null}

POST report/validateCategoryName

Validates a report category name.

Request

Payload: a Category object

Response

• true if the category name is valid and not duplicated
• false if not

Samples

POST/api/report/validateCategoryNameHTTP/1.1

With payload:

{"name":"InternetSales","type":0,"parentId":"5d034fc7-0cc8-46b7-beb3-35b22c57827c","id":"45f17b8a-3708-4f36-80ef-9178b7124841"}

Sample response:

{"success":true,"messages":null,"data":null}

GET report/reportByProperty/{report_id}/{property}

Returns a report section.

Request

property

• 0 = All
• 1 = DataSource
• 2 = Relationship
• 3 = Filter
• 4 = ReportPart
• 5 = CalculatedField
• 6 = DynamicQuerySourceField
• 7 = Scheduling
• 8 = Access
• 9 = Report

Response

A ReportDefinition object

Samples

GET/api/report/reportByProperty/e09f9d45-b721-4012-b8e7-c31c58d52af3/3HTTP/1.1

Sample response:

{"inaccessible":false,"category":{"name":"Sales","type":0,"parentId":null,"tenantId":null,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":null,"dashboards":null,"id":"93de93b9-d5d1-48f1-800d-1db1ffc02614","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null},"subCategory":null,"reportRelationship":[],"reportPart":[],"reportFilter":{"filterFields":[],"logic":"","visible":true,"reportId":"e09f9d45-b721-4012-b8e7-c31c58d52af3","id":"93f2af72-1309-46fe-a779-ff426574619f","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null},"calculatedFields":[],"accesses":[],"schedules":[],"dynamicQuerySourceFields":[],"name":"FactInternetSales Date","reportDataSource":[],"type":0,"previewRecord":10,"advancedMode":true,"allowNulls":false,"isDistinct":false,"categoryId":"93de93b9-d5d1-48f1-800d-1db1ffc02614","categoryName":"Sales","subCategoryId":null,"subCategoryName":null,"tenantId":null,"tenantName":null,"description":"","title":"","lastViewed":"2017-01-05T07:25:53.557","owner":"John Doe","ownerId":"9fc0f5c2-decf-4d65-9344-c59a1704ea0c","excludedRelationships":"","numberOfView":7,"renderingTime":1359.8571428571429,"createdById":"9fc0f5c2-decf-4d65-9344-c59a1704ea0c","modifiedById":"9fc0f5c2-decf-4d65-9344-c59a1704ea0c","snapToGrid":false,"usingFields":"78c99b13-af5d-47b9-9d2a-9fae8bc2b51c,80d98874-67fd-49f7-8755-497c0393736b","hasDeletedObjects":false,"header":{"removed":"for brevity"},"footer":{"removed":"for brevity"},"titleDescription":{"removed":"for brevity"},"sourceId":null,"checked":false,"copyDashboard":false,"exportFormatSetting":{"removed":"for brevity"},"deletable":true,"editable":true,"movable":true,"copyable":true,"accessPriority":1,"active":true,"id":"e09f9d45-b721-4012-b8e7-c31c58d52af3","state":0,"deleted":false,"inserted":true,"version":6,"created":"2016-11-21T07:22:01","createdBy":"John Doe","modified":"2016-11-21T08:42:07.763","modifiedBy":"John Doe"}

POST report

Saves a report.

Request

Payload: a ReportSavingParameter object

Response

A ReportSavingResult object

Samples

POST/api/reportHTTP/1.1

Sample payload:

{"reportKey":{"key":"b95d2611-10c5-4808-aa68-9db2ccc719ff","modified":null},"section":2,"saveAs":false,"ignoreCheckChange":false,"report":{"name":"Report01","type":"Templates","previewRecord":10,"advancedMode":false,"allowNulls":false,"isDistinct":false,"category":{"id":null,"name":"","type":"Templates"},"subCategory":{"id":null,"name":"","type":"Templates"},"reportDataSource":[{"aliasId":"1a67e4e1-7b76-4aac-b905-027bb4302845_Categories","querySourceId":"1a67e4e1-7b76-4aac-b905-027bb4302845","querySourceName":"Categories","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[{"name":"CategoryID","alias":"","dataType":"int","izendaDataType":"Numeric","allowDistinct":false,"visible":true,"filterable":true,"deleted":false,"querySourceId":"00000000-0000-0000-0000-000000000000","parentId":null,"expressionFields":[],"filteredValue":"","type":0,"groupPosition":0,"position":0,"extendedProperties":"{\"PrimaryKey\":true}","physicalChange":0,"approval":0,"existed":false,"matchedTenant":false,"functionName":null,"expression":null,"fullName":null,"calculatedTree":null,"reportId":null,"originalName":"CategoryID","isParameter":false,"isCalculated":false,"querySource":null,"id":"9fd3b009-4809-47ad-845b-96a9dc4cf71e","state":0,"modified":"0001-01-01T00:00:00.0000000-08:00","dateTimeNow":"2016-06-10T07:29:35.9754058Z"}]}],"reportRelationship":[{"id":"1a67e4e1-7b76-4aac-b905-027bb4302845","category":null,"databaseName":"Northwind","schemaName":"dbo","dataObject":"Categories","dataObjectType":"Table","relationshipKeyJoins":[],"relationshipPosition":0,"level":1}],"reportFilter":{"status":0,"logic":"","visible":false,"filterFields":[],"id":"19578f3d-ce47-4e94-a46b-2f7216e059b7","reportId":"b95d2611-10c5-4808-aa68-9db2ccc719ff"},"reportPart":[{"isDirty":true,"reportPartContent":{"isDirty":false,"type":3,"columns":{"elements":[{"isDirty":false,"name":"CategoryName","properties":{"isDirty":false,"dataFormattings":{"function":"","functionInfo":{},"format":"Format","font":{"family":"Georgia","size":8,"bold":true,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""},"grandTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":0,"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}}},"position":1,"field":{"fieldId":"0c140c5a-fa48-46f8-91ae-656a394c48ce","fieldName":"CategoryName","fieldNameAlias":"CategoryName","dataFieldType":"Text","querySourceId":"1a67e4e1-7b76-4aac-b905-027bb4302845","querySourceType":"Table","sourceAlias":"Categories","relationshipId":null,"visible":true,"calculatedTree":null},"isDeleted":false,"isSelected":false}]},"rows":{"elements":[]},"values":{"elements":[]},"separators":{"elements":[]},"groups":{"elements":[]},"properties":{"isDirty":false,"generalInfo":{"gridStyle":"Vertical","separatorStyle":"Comma"},"table":{"border":{"top":{},"right":{},"bottom":{},"midVer":{},"left":{},"midHor":{}},"backgroundColor":"#efefef"},"columns":{"width":{"value":60,"unit":"Pixels"},"alterBackgroundColor":false},"rows":{"height":15,"alterBackgroundColor":false},"headers":{"font":{"family":"Georgia","size":12,"bold":true,"italic":false,"underline":false,"backgroundColor":"#dbf2ff"},"alignment":"left","wordWrap":true,"removeHeaderForExport":false},"grouping":{"useSeparator":false},"view":{"dataRefreshInterval":{"enable":false,"updateInterval":0,"isAll":true,"latestRecord":0}}},"settings":{},"title":{"text":"title","properties":{},"settings":{"font":{"family":"","size":0,"bold":true,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]},"description":{"text":"desc","properties":{},"settings":{"font":{"family":"","size":0,"bold":true,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]}},"positionX":0,"positionY":0,"width":12,"height":4,"state":1,"modified":null,"isBackSide":true,"title":"Grid"}]}}

Successful response:

{"reportKey":{"key":"b95d2611-10c5-4808-aa68-9db2ccc719ff","tenantId":null},"report":{"fields":"omitted",},"success":true,"messages":null,"data":null}

Note

In the Izenda UI, for a Form report part payload, the column elements properties in the reportPart > reportPartContent > columns > elements > properties has higher precedence than the properties in htmlcontent (field-prop). Thus, system will display the field(s) in Izenda UI follow the column elements properties.

For example: In the image below, the visible property of ShipCountry field is different between the column elements properties and the htmlcontent. Thus, in the Izenda UI, this field will keep the value "fieldItemVisible":false and not be displayed in report part.

POST report/draft

Saves a report as draft.

Request

Payload: a ReportSavingParameter object

Response

An OperationResult object

Samples

POST/api/report/draftHTTP/1.1

Sample payload:

{"reportKey":{"key":null,"modified":null},"saveAs":false,"report":{"name":"TestReport","type":"Reports","previewRecord":100,"advancedMode":true,"allowNulls":false,"distinct":false,"category":null,"subCategory":null,"reportDataSource":[{"querySourceId":"aff154e4-af1f-4b57-8e80-72400ca6deac","querySourceName":"CustOrdersDetail","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[]}],"reportRelationship":[],"reportFilter":null}}

Sample response:

{"success":true,"messages":null}

POST report/cancel

Deletes temporary data of a report.

Request

Payload: a ReportParameter object

Response

A ReportSavingResult object

Samples

POST/api/report/cancelHTTP/1.1

Request Payload:

{"reportKey":{"key":"4fd37956-4b97-4efb-9d71-c750b0c36474"}}

Successful response:

{"reportKey":{"key":null,"tenantId":null},"report":null}

POST report/loadForEdit

Returns an object with report key and report’s details.

Request

Payload: a ReportParameter object

Response

A ReportSavingParameter object, with the report field fully populated

Samples

POST/api/report/loadForEditHTTP/1.1

Payload:

{"reportKey":{"key":"9d34d5d2-447f-465e-8223-d7f66378b5f9"}}

Sample response:

{"saveAs":false,"report":{"category":{"name":"","type":1,"parentId":null,"tenantId":null,"subReportCategories":null,"id":"00000000-0000-0000-0000-000000000000","state":0,"modified":null},"subCategory":{"name":"","type":1,"parentId":null,"tenantId":null,"subReportCategories":null,"id":"00000000-0000-0000-0000-000000000000","state":0,"modified":null},"reportDataSource":[{"reportId":"00000000-0000-0000-0000-000000000000","querySourceId":"e1bc2021-3874-4e5a-b51e-d799cef5e29a","id":"bc4cabe6-6f64-473d-b5c8-d3faf314e1fb","state":0,"modified":null}],"reportRelationship":[],"reportPart":[],"reportFilter":{"filterFields":[],"logic":"","visible":false,"reportId":"00000000-0000-0000-0000-000000000000","id":"e610c0a9-c074-47ec-a633-1195a589549c","state":0,"modified":null},"calculatedFields":[],"name":"","type":1,"previewRecord":10,"advancedMode":true,"allowNulls":false,"isDistinct":false,"categoryId":null,"categoryName":null,"subCategoryId":null,"subCategoryName":null,"tenantId":null,"description":null,"createdBy":null,"createdDate":"0001-01-01T00:00:00","modifiedBy":null,"version":null,"numberOfViews":0,"averageRenderingTime":0.0,"id":"00000000-0000-0000-0000-000000000000","state":1,"modified":null},"section":0,"tenantId":null,"ignoreCheckChange":false,"reportKey":{"key":"9d34d5d2-447f-465e-8223-d7f66378b5f9","tenantId":null}}

GET report/(tenant_id)

Returns all report categories together with the reports inside.

Request

No payload

Response

An array of Category objects

Samples

GET/api/report/b5b3a5cc-9e55-424c-ae85-ba92ec3b934eHTTP/1.1

Sample response:

[{"name":"ACME","type":1,"parentId":null,"tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[{"name":null,"type":1,"parentId":"2b3f5a54-a719-41a9-a475-91e0353a4771","tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[{"name":"Example","reportDataSource":[],"type":0,"previewRecord":0,"advancedMode":false,"allowNulls":false,"isDistinct":false,"categoryId":"2b3f5a54-a719-41a9-a475-91e0353a4771","categoryName":null,"subCategoryId":null,"subCategoryName":null,"tenantId":"00000000-0000-0000-0000-000000000000","tenantName":null,"description":null,"title":null,"lastViewed":null,"owner":null,"ownerId":null,"excludedRelationships":null,"numberOfView":0,"renderingTime":0,"createdById":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","modifiedById":null,"snapToGrid":false,"usingFields":null,"hasDeletedObjects":false,"header":null,"footer":null,"titleDescription":null,"sourceId":null,"checked":false,"copyDashboard":false,"exportFormatSetting":null,"deletable":false,"editable":false,"movable":false,"copyable":false,"accessPriority":0,"active":false,"fullPath":null,"computeNameSettings":null,"isGlobal":false,"isCheck":false,"id":"f4d5aa24-7ed3-49f4-8c4b-e274ced11191","state":0,"deleted":false,"inserted":true,"version":0,"created":null,"createdBy":"ACME Cooperation","modified":null,"modifiedBy":null}],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":null,"state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"ACME Cooperation","modified":null,"modifiedBy":null}],"checked":false,"reports":[],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"2b3f5a54-a719-41a9-a475-91e0353a4771","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"ACME Cooperation","modified":null,"modifiedBy":null}]

POST report/validateReportName

Validates that a report name is unique and not empty.

Request

Payload: a ReportDefinition object, with name, type, category and subCategory fields populated.

Response

A OperationResult object, with success field means whether the report name is unique (in the specified category and sub-category)

Samples

POST/api/report/validateReportNameHTTP/1.1

Request payload:

{"id":null,"name":"AnExistingName","type":1,"category":{"id":"b45d865c-bea2-41be-9986-8a912981bfed","name":"Category A","type":1,"tenantId":null},"subCategory":{"id":null,"name":"","type":1,"tenantId":null}}

Response when that report name already exists in Category A:

{"success":false,"messages":[{"key":"Name","detail":null,"messages":["This template name already exists in the \"Category A\" category."]}],"data":null}

POST report/validate

Validates that a report name is unique and its filter and relationships are valid.

Request

Payload: a ReportSavingParameter object

Response

An OperationResult object, with success field means whether the validation is successful

Samples

POST/api/report/validateHTTP/1.1

Request payload:

{"reportKey":{"key":"940529fd-f1fb-4d98-8def-c8dcfa7eba84","tenantId":null},"report":{"id":"940529fd-f1fb-4d98-8def-c8dcfa7eba84","type":"Templates","category":{"id":"0adae39c-1db0-466d-820b-9f3f59c8e199"},"subCategory":{"id":null}}}

Sample response:

{"success":true,"message":null,"errors":[]}

POST report/search

Searches for reports.

Request

Payload: a ReportDashboardSearchCriteria object

Response

An array of Category objects

Samples

POSTapi/report/searchHTTP/1.1

Request payload:

{"criterias":[{"key":"Category","value":"ACME"}],"isUncategorized":false,"sortCriteria":{"key":"ReportName","descending":false},"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","type":"0","skipItems":0,"pageSize":100,"parentIds":[],"includeGlobalCategory":true,"isGlobal":null}

Sample response:

[{"name":"ACME","type":0,"parentId":null,"tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[{"name":"Example","type":0,"parentId":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[{"name":"ExampleReport","reportDataSource":[],"type":0,"previewRecord":0,"advancedMode":false,"allowNulls":false,"isDistinct":false,"categoryId":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","categoryName":null,"subCategoryId":"41a3dff9-d1da-48e5-b4fb-50775324bd3d","subCategoryName":null,"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","tenantName":null,"description":"","title":null,"lastViewed":"2017-09-28T07:50:02.533","owner":"John Doe","ownerId":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","excludedRelationships":null,"numberOfView":3,"renderingTime":646.66667,"createdById":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","modifiedById":null,"snapToGrid":false,"usingFields":null,"hasDeletedObjects":false,"header":null,"footer":null,"titleDescription":null,"sourceId":null,"checked":false,"copyDashboard":false,"exportFormatSetting":null,"deletable":true,"editable":true,"movable":true,"copyable":true,"accessPriority":1,"active":true,"fullPath":null,"computeNameSettings":null,"isGlobal":false,"isCheck":false,"id":"5447a5c1-a0c8-4bf6-bd68-f09234ba5e84","state":0,"deleted":false,"inserted":true,"version":2,"created":"2017-09-27T10:20:46.277","createdBy":"John Doe","modified":"2017-09-28T07:49:39.25","modifiedBy":"John Doe"}],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"41a3dff9-d1da-48e5-b4fb-50775324bd3d","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null}],"checked":false,"reports":[],"dashboards":null,"numOfChilds":0,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null}]

POST report/search2

Searches for reports, with total number of items.

Request

Payload: a ReportDashboardSearchCriteria object

Response

The following object:

Field	Description	Note
data array of objects	An array of Category objects
totalItems string	The number of all items
numOfChilds integer	The number of children
numOfCheckedChilds integer	The number of selected children
indeterminate boolean	true if 0 < numOfCheckedChilds < numOfChilds false if not
isLastPage boolean	Whether this is the last page

Samples

POST/api/report/search2HTTP/1.1

Payload:

{"criterias":[{"key":"Category","value":"ACME"}],"isUncategorized":false,"sortCriteria":{"key":"ReportName","descending":false},"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","type":"0","skipItems":0,"pageSize":100,"parentIds":[],"includeGlobalCategory":true,"isGlobal":null}

Response

{"data":[{"name":"Local Categories","type":0,"parentId":null,"tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[{"name":"ACME","type":0,"parentId":null,"tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[{"name":"Example","type":0,"parentId":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","tenantId":null,"isGlobal":false,"canDelete":false,"editable":false,"savable":false,"subCategories":[],"checked":false,"reports":[{"name":"ExampleReport","reportDataSource":[],"type":0,"previewRecord":0,"advancedMode":false,"allowNulls":false,"isDistinct":false,"categoryId":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","categoryName":null,"subCategoryId":"41a3dff9-d1da-48e5-b4fb-50775324bd3d","subCategoryName":null,"tenantId":"b5b3a5cc-9e55-424c-ae85-ba92ec3b934e","tenantName":null,"description":"","title":null,"lastViewed":"2017-09-28T07:50:02.533","owner":"John Doe","ownerId":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","excludedRelationships":null,"numberOfView":3,"renderingTime":646.66667,"createdById":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","modifiedById":null,"snapToGrid":false,"usingFields":null,"hasDeletedObjects":false,"header":null,"footer":null,"titleDescription":null,"sourceId":null,"checked":false,"copyDashboard":false,"exportFormatSetting":null,"deletable":true,"editable":true,"movable":true,"copyable":true,"accessPriority":1,"active":true,"fullPath":null,"computeNameSettings":null,"isGlobal":false,"isCheck":false,"id":"5447a5c1-a0c8-4bf6-bd68-f09234ba5e84","state":0,"deleted":false,"inserted":true,"version":2,"created":"2017-09-27T10:20:46.277","createdBy":"John Doe","modified":"2017-09-28T07:49:39.25","modifiedBy":"John Doe"}],"dashboards":[],"numOfChilds":1,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"41a3dff9-d1da-48e5-b4fb-50775324bd3d","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null},],"checked":false,"reports":[],"dashboards":[],"numOfChilds":5,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"5ca51cd0-1f63-44ca-9711-ba6c988a520a","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null}],"checked":false,"reports":[],"dashboards":[],"numOfChilds":1,"numOfCheckedChilds":0,"indeterminate":false,"fullPath":null,"computeNameSettings":null,"isCheck":false,"id":"09f8c4ab-0fe8-4e03-82d1-7949e3738f87","state":0,"deleted":false,"inserted":true,"version":null,"created":null,"createdBy":"John Doe","modified":null,"modifiedBy":null}],"totalItems":45,"numOfChilds":1,"numOfCheckedChilds":0,"indeterminate":false,"isLastPage":true}

POST report/advancedSearch

Searches for reports with advanced options.

Request

Payload: a ReportPagedRequest object

Note

The keys for SearchCriteria that this API support:
- All
- ReportName
- ReportDescription
- DashboardName
- DashboardDescription
- CreatedBy
- CreatedDate
- LastEditedBy
- LastEditedDate
- Version
- NumberOfView
- RenderingTime
- ReportOwner
- LastViewed
- Category
- SubCategory
- CategoryId
- CreatedDateFrom
- CreatedDateTo
- LastEditedDateFrom
- LastEditedDateTo

Response

A PagedResult object, with result field containing an array of ReportDefinition objects

Samples

POST/api/report/advancedSearchHTTP/1.1

Request payload:

{"subcategoryid":null,"categoryId":null,"tenantId":null,"pageSize":10,"pageIndex":1,"sortOrders":[{"key":"reportname","descending":true}],"criteria":[{"key":"reportName","value":"test","operation":1}]}

Sample response:

{"result":[],"pageIndex":1,"pageSize":10,"total":0}

GET report/reportMode

Returns the report mode.

Request

No payload

Response

The value of the report mode

• 0 = Simple
• 1 = Advanced

Samples

GET/api/report/reportModeHTTP/1.1

Sample response:

1

POST report/reportMode/{value}

Sets the report mode to Simple or Advanced.

Request

• call report/reportMode/0 to set Simple mode
• call report/reportMode/1 to set Advanced mode

Response

• true if succeeded
• false if there was an error

Samples

POST/api/report/reportMode/0HTTP/1.1

Successful response:

true

POST report/detectReportChange

Verifies that all report details are up to date, without physical changes, and valid.

Request

Payload: a ReportSavingParameter object, with section field specifies where to detect changes

• 0 = All
• 1 = DataSource
• 2 = Fields
• 3 = CalculatedField

Response

An OperationResult object, with success field means whether the report is up to date, without physical changes, and valid

Samples

POST/api/report/detectReportChangeHTTP/1.1

Request Payload to check if a new report with only one data source has physical changes:

{"reportKey":{"key":null,"modified":null},"section":1,"report":{"reportDataSource":[{"querySourceId":"1a67e4e1-7b76-4aac-b905-027bb4302845"}]}}

Successful response:

{"success":true,"messages":null}

Request Payload for an existing report with two data sources, filter and report part:

{"reportKey":{"key":"37e99389-fa8a-4f9f-9d03-f6362240c931","modified":null},"section":2,"report":{"reportDataSource":[{"aliasId":"84340ae7-275e-4bd5-bd77-89916341f20e_Order Details","querySourceId":"84340ae7-275e-4bd5-bd77-89916341f20e","querySourceName":"Order Details","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[{"name":"OrderID","alias":"","dataType":"int","izendaDataType":"Numeric","allowDistinct":false,"visible":true,"filterable":true,"deleted":false,"querySourceId":"00000000-0000-0000-0000-000000000000","parentId":null,"expressionFields":[],"filteredValue":"","type":0,"groupPosition":0,"position":0,"extendedProperties":"{\"PrimaryKey\":true}","physicalChange":0,"approval":0,"existed":false,"matchedTenant":false,"functionName":null,"expression":null,"fullName":null,"calculatedTree":null,"reportId":null,"originalName":"OrderID","isParameter":false,"isCalculated":false,"querySource":null,"id":"9a4c52a4-f931-40d0-88b9-7f914d49581b","state":0,"modified":"0001-01-01T00:00:00.0000000-08:00","dateTimeNow":"2016-06-13T07:22:35.8918127Z"},{"name":"ProductID","alias":"","dataType":"int","izendaDataType":"Numeric","allowDistinct":false,"visible":true,"filterable":true,"deleted":false,"querySourceId":"00000000-0000-0000-0000-000000000000","parentId":null,"expressionFields":[],"filteredValue":"","type":0,"groupPosition":0,"position":0,"extendedProperties":"{\"PrimaryKey\":true}","physicalChange":0,"approval":0,"existed":false,"matchedTenant":false,"functionName":null,"expression":null,"fullName":null,"calculatedTree":null,"reportId":null,"originalName":"ProductID","isParameter":false,"isCalculated":false,"querySource":null,"id":"1d379f29-02ae-4f51-ac3a-a627694c3539","state":0,"modified":"0001-01-01T00:00:00.0000000-08:00","dateTimeNow":"2016-06-13T07:22:35.8918127Z"}]},{"aliasId":"8fda0166-5f38-4ca1-ae20-9b6cab288f9d_Orders","querySourceId":"8fda0166-5f38-4ca1-ae20-9b6cab288f9d","querySourceName":"Orders","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[{"name":"orderid_alias","alias":"","dataType":"int","izendaDataType":"Numeric","allowDistinct":false,"visible":true,"filterable":true,"deleted":false,"querySourceId":"00000000-0000-0000-0000-000000000000","parentId":null,"expressionFields":[],"filteredValue":"","type":0,"groupPosition":0,"position":0,"extendedProperties":"{\"PrimaryKey\":true}","physicalChange":0,"approval":0,"existed":false,"matchedTenant":false,"functionName":null,"expression":null,"fullName":null,"calculatedTree":null,"reportId":null,"originalName":"OrderID","isParameter":false,"isCalculated":false,"querySource":null,"id":"93157476-d4e6-49bb-8900-2fda43e46f87","state":0,"modified":"0001-01-01T00:00:00.0000000-08:00","dateTimeNow":"2016-06-13T07:22:35.8918127Z"}]}],"reportRelationship":[{"tempId":"6da998ae-5451-4a45-ab86-69894e1b3a13","joinConnectionId":"a0028b41-f820-4640-927c-68f6ef730b0f","foreignConnectionId":"a0028b41-f820-4640-927c-68f6ef730b0f","joinQuerySourceId":"84340ae7-275e-4bd5-bd77-89916341f20e","joinQuerySourceName":"Order Details","joinDataSourceCategoryName":"","joinDataSourceCategoryId":"00000000-0000-0000-0000-000000000000","foreignDataSourceCategoryName":"","foreignDataSourceCategoryId":"00000000-0000-0000-0000-000000000000","foreignQuerySourceId":"8fda0166-5f38-4ca1-ae20-9b6cab288f9d","foreignQuerySourceName":"Orders","joinFieldId":"9a4c52a4-f931-40d0-88b9-7f914d49581b","joinFieldName":"OrderID","foreignFieldId":"93157476-d4e6-49bb-8900-2fda43e46f87","foreignFieldName":"orderid_alias","alias":"","systemRelationship":true,"joinType":"Inner","parentRelationshipId":"5147885d-0bac-4252-8d33-f9fd96bd3b8e","position":null,"relationshipKeyJoins":[],"reportId":"00000000-0000-0000-0000-000000000000","selectedForeignAlias":"8fda0166-5f38-4ca1-ae20-9b6cab288f9d_Orders","id":"6da998ae-5451-4a45-ab86-69894e1b3a13","state":1,"validationKey":"5147885d-0bac-4252-8d33-f9fd96bd3b8e","relationshipPosition":0,"invalidAlias":null,"hidden":false,"level":1}],"reportFilter":{"status":0,"logic":null,"visible":false,"filterFields":[{"connectionName":"Northwind","querySourceCategoryName":"dbo","sourceFieldName":"ShipCountry","sourceFieldVisible":true,"sourceFieldFilterable":true,"sourceDataObjectName":"Orders","dataType":"Text","filterId":"00000000-0000-0000-0000-000000000000","querySourceFieldId":"d0f88020-8d3f-4f80-a1ac-0c187f87dfd3","querySourceType":"Table","querySourceId":"8fda0166-5f38-4ca1-ae20-9b6cab288f9d","relationshipId":null,"alias":"ShipCountry","position":1,"visible":false,"required":false,"cascading":true,"operatorId":"737307d1-1e5f-407f-889f-1b3c9a66dd6f","operatorSetting":null,"value":"'US'","sortType":"Unsorted","fontFamily":null,"fontSize":0,"textColor":null,"backgroundColor":null,"fontBold":false,"fontItalic":false,"fontUnderline":false,"id":"00000000-0000-0000-0000-000000000000","status":0,"modified":null,"dateTimeNow":"2016-06-13T07:23:25.9138114Z","isParameter":false,"sourceDataObjectFullName":"Northwind.dbo.Orders","selected":false}],"id":"00000000-0000-0000-0000-000000000000","reportId":"37e99389-fa8a-4f9f-9d03-f6362240c931"},"reportPart":[{"isDirty":true,"reportPartContent":{"isDirty":false,"type":3,"columns":{"elements":[{"isDirty":false,"name":"ShipCity","properties":{"isDirty":false,"dataFormattings":{"function":"","functionInfo":{},"format":"Format","font":{"family":"Georgia","size":8,"bold":true,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""},"grandTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":0,"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":1,"field":{"fieldId":"f5b9bac6-aa76-402c-8ade-6b8f619e9ced","fieldName":"ShipCity","fieldNameAlias":"ShipCity","dataFieldType":"Text","querySourceId":"8fda0166-5f38-4ca1-ae20-9b6cab288f9d","querySourceType":"Table","sourceAlias":"Orders","relationshipId":null,"visible":true,"calculatedTree":null},"isDeleted":false,"isSelected":false},{"isDirty":false,"name":"ProductID","properties":{"isDirty":false,"dataFormattings":{"function":"","functionInfo":{},"format":"Format","font":{"family":"Georgia","size":8,"bold":true,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""},"grandTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":0,"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":2,"field":{"fieldId":"1d379f29-02ae-4f51-ac3a-a627694c3539","fieldName":"ProductID","fieldNameAlias":"ProductID","dataFieldType":"Numeric","querySourceId":"84340ae7-275e-4bd5-bd77-89916341f20e","querySourceType":"Table","sourceAlias":"Order Details","relationshipId":null,"visible":true,"calculatedTree":null},"isDeleted":false,"isSelected":false},{"isDirty":false,"name":"Quantity","properties":{"isDirty":false,"dataFormattings":{"function":"","functionInfo":{},"format":"Format","font":{"family":"Georgia","size":8,"bold":true,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""},"grandTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":""}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":0,"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":3,"field":{"fieldId":"1eaa3d97-da56-45ca-b61a-8bf3bb253fea","fieldName":"Quantity","fieldNameAlias":"Quantity","dataFieldType":"Numeric","querySourceId":"84340ae7-275e-4bd5-bd77-89916341f20e","querySourceType":"Table","sourceAlias":"Order Details","relationshipId":null,"visible":true,"calculatedTree":null},"isDeleted":false,"isSelected":false}]},"rows":{"elements":[]},"values":{"elements":[]},"separators":{"elements":[]},"properties":{"isDirty":false,"generalInfo":{"gridStyle":"Vertical","separatorStyle":"Comma"},"table":{"border":{"top":{},"right":{},"bottom":{},"midVer":{},"left":{},"midHor":{}},"backgroundColor":"#efefef"},"columns":{"width":{"value":100,"unit":"Pixels"},"alterBackgroundColor":false},"rows":{"height":40,"alterBackgroundColor":false},"headers":{"font":{"family":"Georgia","size":12,"bold":true,"italic":false,"underline":false,"backgroundColor":"#dbf2ff"},"alignment":"left","wordWrap":true,"removeHeaderForExport":false},"grouping":{"useSeparator":false},"view":{"dataRefreshInterval":{"enable":false,"updateInterval":0,"isAll":true,"latestRecord":0}}},"settings":{},"title":{"text":"Title","properties":{},"settings":{"font":{"family":"","size":0,"bold":true,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]},"description":{"text":"Description line","properties":{},"settings":{"font":{"family":"","size":0,"bold":true,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]}},"positionX":0,"positionY":0,"width":12,"height":4,"state":1,"modified":null,"isBackSide":true,"expandedLevel":0,"points":[{"key":"All","filter":[{"key":"","value":""}],"expandedLevel":0,"isViewSeparator":false}],"title":"Grid"}]}}