REL documentation
Resource:base report and its customizations, no RDLC# Rel Const:Rels.ReportDefsSvc.SsrsSummaryURI template:ssrs/{name}/summary{?customerid,alternatepath}Obtain URI from:
Get report summary info including any customizations of the report.
Success status: 200; Response is cacheable
| Name (* = required) | Data Type | Description |
|---|---|---|
| name * | string | base report name |
| customerid | int | specify to limit customer specific customizations to just one customer's |
| alternatepath | string | for access to reports not in the default path |
A base report and its customizations, no RDL.
| Type | Description | |
|---|---|---|
| Name | string | base report name |
| CanCustomizeBy | Common.Enum.CustomizeReportBy | for whome report can be customized |
| Common.Enum.CustomizeReportBy | for whom a report can be customized | |
| - 0: CustomerOnly | all reports are customizable for specific customers; this specifies no other customizations allowed | |
| - 1: CustomerAnd3Pl | in addition to specific customer, report is customizable for threepl and for any customer | |
| Customizations | IList<ReportDef.Models.SsrsCustomizedReportSummary> | list of existing customizations |
| ReportDef.Models.SsrsCustomizedReportSummary | a specific customization of a base report, no RDL | |
| CustomName | string | name of this customization; name unique within base report+customizedReportFor+customerId |
| CustomizedReportFor | Common.Enum.CustomizedReportFor | for whom report is customized |
| Common.Enum.CustomizedReportFor | for whom a particular customization is made | |
| - 0: Customer | a specific customer; other parameters elsewhere specify the customer id | |
| - 1: CustomerAny | not a specific customer but any customer | |
| - 2: TplOnly | hidden from a customer's view, to be used internally within the threepl | |
| CustomerId | int? ... | if customizedReportFor is Customer, the customer for whom it is customized |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/reportdefs/ssrsrunc11n | Run this customized report | |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/reportdefs/ssrsrun | Run this report |
Sample accept: application/hal+json
{
"name": "str",
"canCustomizeBy": 0,
"_embedded": {
"item": [
{
"customName": "str",
"customizedReportFor": 0,
"customerId": 1
}
]
}
}
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.