cloudcc-ssrs

2.0.1 • Public • Published

sql_server_2017_reporting_services_rest_api

SqlServer2017ReportingServicesRestApi - JavaScript client for sql_server_2017_reporting_services_rest_api The SQL Server 2017 Reporting Services REST API provides programmatic access to the report server catalog. For example, basic CRUD operations can be done on folders, reports, KPIs, data sources, datasets, refresh plans, subscriptions, etc. The REST API can also be used to provide more advanced functionality, such as: * Navigate the folder hierarchy * Discover the contents of a folder * Download a report definition * Modify default report parameters * Change or execute a refresh plan * A whole lot more The REST API is a RESTful successor to the legacy SOAP API. Happy coding! API samples: https://github.com/Microsoft/Reporting-Services Developer documentation: https://docs.microsoft.com/sql/reporting-services/reporting-services-developer-documentation Team Blog: https://blogs.msdn.microsoft.com/sqlrsteamblog Support forums: https://social.msdn.microsoft.com/Forums/en-US/home?forum=sqlreportingservices This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 2.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install sql_server_2017_reporting_services_rest_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your sql_server_2017_reporting_services_rest_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('sql_server_2017_reporting_services_rest_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/sql_server_2017_reporting_services_rest_api then install it via:

    npm install YOUR_USERNAME/sql_server_2017_reporting_services_rest_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var SqlServer2017ReportingServicesRestApi = require('sql_server_2017_reporting_services_rest_api');

var api = new SqlServer2017ReportingServicesRestApi.CacheRefreshPlansApi()

var cacheRefreshPlan = new SqlServer2017ReportingServicesRestApi.CacheRefreshPlan(); // {CacheRefreshPlan} The definition of the new CacheRefreshPlan item.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCacheRefreshPlan(cacheRefreshPlan, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost/reports/api/v2.0

Class Method HTTP request Description
SqlServer2017ReportingServicesRestApi.CacheRefreshPlansApi addCacheRefreshPlan POST /CacheRefreshPlans Creates a new CacheRefreshPlan item.
SqlServer2017ReportingServicesRestApi.CacheRefreshPlansApi deleteCacheRefreshPlan DELETE /CacheRefreshPlans({Id}) Deletes the specified CacheRefreshPlan.
SqlServer2017ReportingServicesRestApi.CacheRefreshPlansApi executeCacheRefreshPlan POST /CacheRefreshPlans({Id})/Model.Execute Executes given CacheRefreshPlan immediately.
SqlServer2017ReportingServicesRestApi.CacheRefreshPlansApi getCacheRefreshPlan GET /CacheRefreshPlans({Id}) Gets a CacheRefreshPlan item specified by the Id.
SqlServer2017ReportingServicesRestApi.CacheRefreshPlansApi setCacheRefreshPlan PUT /CacheRefreshPlans({Id}) Replaces the specified CacheRefreshPlan item using the provided definition.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi addCatalogItem POST /CatalogItems Creates a new CatalogItem.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi deleteCatalogItem DELETE /CatalogItems({Id}) Deletes the specified CatalogItem.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi deleteCatalogItems POST /CatalogItems/Model.DeleteItems Deletes the given list of items
SqlServer2017ReportingServicesRestApi.CatalogItemsApi getCatalogItem GET /CatalogItems({Id}) Gets a CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi getCatalogItemContent GET /CatalogItems({Id})/Content/$value Gets the content of the specified CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi getCatalogItemPolicies GET /CatalogItems({Id})/Policies Gets ItemPolicies associated with the specified CatalogItem.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi getCatalogItemProperties GET /CatalogItems({Id})/Properties Gets the specified Properties for the CatalogItem (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.CatalogItemsApi getCatalogItemRoles GET /CatalogItems({Id})/Roles Gets the list of available Roles for the CatalogItem
SqlServer2017ReportingServicesRestApi.CatalogItemsApi getCatalogItems GET /CatalogItems Gets an array of CatalogItems.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi moveCatalogItems POST /CatalogItems/Model.MoveItems Moves given list of items to target folder.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi setCatalogItemPolicies PUT /CatalogItems({Id})/Policies Replaces ItemPolicies associated with the specified CatalogItem.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi updateCatalogItem PATCH /CatalogItems({Id}) Updates the specified CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.CatalogItemsApi updateCatalogItemProperties PATCH /CatalogItems({Id})/Properties Updates a CatalogItem's Properties with the list of given properties.
SqlServer2017ReportingServicesRestApi.DataSetsApi addDataSet POST /DataSets Creates a new DataSet CatalogItem.
SqlServer2017ReportingServicesRestApi.DataSetsApi deleteDataSet DELETE /DataSets({Id}) Deletes the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSet GET /DataSets({Id}) Gets a DataSet CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetAggregatedValue POST /DataSets({Id})/Model.GetAggregatedValue Gets the value for the specified DataSet column using the given aggregation type.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetAllowedActions GET /DataSets({Id})/AllowedActions Gets a list of actions allowed in the current session; user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetCacheOptions GET /DataSets({Id})/CacheOptions Gets the CacheOption's content for a given DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetCacheRefreshPlans GET /DataSets({Id})/CacheRefreshPlans Gets the CacheRefreshPlans for a given DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetContent GET /DataSets({Id})/Content/$value Gets the content of the specified DataSet CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetData POST /DataSets({Id})/Model.GetData Gets the query results for the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetDataSource GET /DataSets({Id})/DataSources({DataSourceId}) Gets the DataSource specified by the DataSourceId that is associated with the DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetDataSources GET /DataSets({Id})/DataSources Gets the DataSources associated with the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetDependentItems GET /DataSets({Id})/DependentItems Returns a list of CatalogItems that reference the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetParameterDefinitions GET /DataSets({Id})/ParameterDefinitions Gets the ParameterDefinitions associated with the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetPolicies GET /DataSets({Id})/Policies Gets ItemPolicies associated with the specified DataSet CatalogItem.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSetSchema GET /DataSets({Id})/Model.GetSchema Gets the schema for the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDataSets GET /DataSets Gets an array of DataSet CatalogItems.
SqlServer2017ReportingServicesRestApi.DataSetsApi getDatasetProperties GET /DataSets({Id})/Properties Gets DataSet Properties (takes list of property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.DataSetsApi setDataSetCacheOptions PUT /DataSets({Id})/CacheOptions Replaces the CacheOption's content for a given DataSet using the provided definition.
SqlServer2017ReportingServicesRestApi.DataSetsApi setDataSetDataSource PUT /DataSets({Id})/DataSources({DataSourceId}) Updates the DataSource specified by the DataSourceId that is associated with the DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi setDataSetDataSources PUT /DataSets({Id})/DataSources Updates the DataSource definition associated with the specified DataSet.
SqlServer2017ReportingServicesRestApi.DataSetsApi setDataSetPolicies PUT /DataSets({Id})/Policies Replaces ItemPolicies associated with the specified DataSet item.
SqlServer2017ReportingServicesRestApi.DataSetsApi updateDataSet PATCH /DataSets({Id}) Updates the specified DataSet CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.DataSetsApi updateDataSetParameterDefinitions PATCH /DataSets({Id})/ParameterDefinitions Updates the ParameterDefinitions associated with the DataSet specified.
SqlServer2017ReportingServicesRestApi.DataSetsApi updateDatasetProperties PUT /DataSets({Id})/Properties Updates the DataSet Properties included in the given list.
SqlServer2017ReportingServicesRestApi.DataSourcesApi addDataSource POST /DataSources Creates a new DataSource CatalogItem.
SqlServer2017ReportingServicesRestApi.DataSourcesApi checkExistingDataSourceConnection POST /DataSources({Id})/Model.CheckConnection Tests the connection for a data source. This method supports the testing of published data sources that are used by reports and shared data sources
SqlServer2017ReportingServicesRestApi.DataSourcesApi checkNewDataSourceConnection POST /DataSources/Model.CheckConnection Tests the connection for a data source. This method supports the direct testing of the unsaved data source.
SqlServer2017ReportingServicesRestApi.DataSourcesApi deleteDataSource DELETE /DataSources({Id}) Deletes the specified DataSource.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSource GET /DataSources({Id}) Gets a DataSource CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSourceAllowedActions GET /DataSources({Id})/AllowedActions Gets a list of actions allowed in the current session; user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSourceContent GET /DataSources({Id})/Content/$value Gets the content of the DataSource CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSourceDependentItems GET /DataSources({Id})/DependentItems Returns a list of CatalogItems that reference the DataSource specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSourcePolicies GET /DataSources({Id})/Policies Gets ItemPolicies associated with the DataSource specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSourceQueryFields POST /DataSources/Model.GetQueryFields Retrieves a dataset that contains the fields retrieved by the delivery query for a data-driven subscription.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDataSources GET /DataSources Gets an array of DataSource CatalogItems.
SqlServer2017ReportingServicesRestApi.DataSourcesApi getDatasourceProperties GET /DataSources({Id})/Properties Gets DataSource Properties (takes list of property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.DataSourcesApi setDataSourcePolicies PUT /DataSources({Id})/Policies Replaces ItemPolicies associated with the DataSource specified by the Id.
SqlServer2017ReportingServicesRestApi.DataSourcesApi updateDataSource PATCH /DataSources({Id}) Updates the DataSource CatalogItem specified by the Id using the provided definition.
SqlServer2017ReportingServicesRestApi.DataSourcesApi updateDatasourceProperties PUT /DataSources({Id})/Properties Updates the DataSource Properties included in the given list.
SqlServer2017ReportingServicesRestApi.ExtensionsApi getExtensionParameters GET /Extensions({Id})/Parameters Retrieves the ExtensionParameter list for given extension.
SqlServer2017ReportingServicesRestApi.ExtensionsApi getExtensions GET /Extensions Retreives all Extension items.
SqlServer2017ReportingServicesRestApi.ExtensionsApi validateExtensionParameters POST /Extensions/Model.ValidateExtensionSettings Validates extension parameters and returns collection of ExtensionParameter.
SqlServer2017ReportingServicesRestApi.FavoriteItemsApi getFavoriteItems GET /FavoriteItems Retrieves a collection of items of type CatalogItem which have been designated as favorites. Use the OData $expand option to also get the referenced items.
SqlServer2017ReportingServicesRestApi.FavoriteItemsApi removeFavoriteItem DELETE /FavoriteItems({Id}) Removes a CatalogItem from the list of favorite items.
SqlServer2017ReportingServicesRestApi.FavoriteItemsApi setFavoriteItem POST /FavoriteItems Designate a CatalogItem as a favorite.
SqlServer2017ReportingServicesRestApi.FoldersApi addFolder POST /Folders Creates a new Folder CatalogItem.
SqlServer2017ReportingServicesRestApi.FoldersApi deleteFolder DELETE /Folders({Id}) Deletes the specified Folder.
SqlServer2017ReportingServicesRestApi.FoldersApi getFolder GET /Folders({Id}) Gets a Folder CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.FoldersApi getFolderAllowedActions GET /Folders({Id})/AllowedActions Gets a list of actions allowed in the current session; user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.FoldersApi getFolderCatalogItems GET /Folders({Id})/CatalogItems Gets a list of child CatalogItems in the specified folder.
SqlServer2017ReportingServicesRestApi.FoldersApi getFolderPolicies GET /Folders({Id})/Policies Gets policies associated with the Folder CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.FoldersApi getFolderProperties GET /Folders({Id})/Properties Gets Folder Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.FoldersApi getFolders GET /Folders Gets an array of Folder CatalogItems.
SqlServer2017ReportingServicesRestApi.FoldersApi searchCatalogItemsInFolder POST /Folders({Id})/Model.SearchItems(searchText={searchText}) Searches items in a given folder.
SqlServer2017ReportingServicesRestApi.FoldersApi setFolderPolicies PUT /Folders({Id})/Policies Replaces ItemPolicies associated with the Folder item specified by the Id.
SqlServer2017ReportingServicesRestApi.FoldersApi updateFolder PATCH /Folders({Id}) Updates the specified Folder CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.FoldersApi updateFolderProperties PUT /Folders({Id})/Properties Updates the Folder Properties included in the given list.
SqlServer2017ReportingServicesRestApi.KpisApi addKpi POST /Kpis Creates a new Kpi CatalogItem.
SqlServer2017ReportingServicesRestApi.KpisApi deleteKpi DELETE /Kpis({Id}) Deletes the specified Kpi.
SqlServer2017ReportingServicesRestApi.KpisApi getKpi GET /Kpis({Id}) Gets a Kpi CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.KpisApi getKpiAllowedActions GET /Kpis({Id})/AllowedActions Gets a list of actions allowed in the current session, user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.KpisApi getKpiPolicies GET /Kpis({Id})/Policies Gets ItemPolicies associated with the Kpi CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.KpisApi getKpiProperties GET /Kpis({Id})/Properties Gets Kpi Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.KpisApi getKpis GET /Kpis Gets an array of Kpi CatalogItems.
SqlServer2017ReportingServicesRestApi.KpisApi setKpiPolicies PUT /Kpis({Id})/Policies Replaces ItemPolicies associated with the Kpi specified by the Id.
SqlServer2017ReportingServicesRestApi.KpisApi updateKpi PATCH /Kpis({Id}) Updates the specified Kpi CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.KpisApi updateKpiProperties PUT /Kpis({Id})/Properties Updates the Kpi Properties included in the given list.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi addLinkedReport POST /LinkedReports Creates a new LinkedReport CatalogItem.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi addLinkedReportComment POST /LinkedReports({Id})/Comments Creates a new Comment associated to the specified LinkedReport.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi addLinkedReportHistorySnapshot POST /LinkedReports({Id})/HistorySnapshots Creates new HistorySnapshot
SqlServer2017ReportingServicesRestApi.LinkedReportsApi deleteLinkedReport DELETE /LinkedReports({Id}) Deletes the specified LinkedReport.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi deleteLinkedReportComment DELETE /LinkedReports({Id})/Comments({CommentId}) Deletes the specified Comment associated to the LinkedReport.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi deleteLinkedReportHistorySnapshot DELETE /LinkedReports({Id})/HistorySnapshots({HistoryId}) Deletes a HistorySnapshot specified by HistoryId from the LinkedReport specified by Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReport GET /LinkedReports({Id}) Gets a LinkedReport CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportAllowedActions GET /LinkedReports({Id})/AllowedActions Gets a list of actions allowed in the current session; user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportCacheOptions GET /LinkedReports({Id})/CacheOptions Gets the content of CacheOptions for the LinkedReport specified by the Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportCacheRefreshPlans GET /LinkedReports({Id})/CacheRefreshPlans Gets the CacheRefreshPlans for a LinkedReport specified by the Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportComments GET /LinkedReports({Id})/Comments Gets the Comments for a LinkedReport specified by the Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportHistorySnapshot GET /LinkedReports({Id})/HistorySnapshots({HistoryId}) Gets requested HistorySnapshot item specified by HistoryId of the LinkedReport specified by Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportHistorySnapshotOptions GET /LinkedReports({Id})/HistorySnapshotOptions Gets HistorySnapshotOptions for the specified LinkedReport.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportHistorySnapshots GET /LinkedReports({Id})/HistorySnapshots Get a list of HistorySnapshots of the LinkedReport specified by Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportParameterDefinitions GET /LinkedReports({Id})/ParameterDefinitions Gets the ParameterDefinitions associated with the LinkedReport specified by the Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportPolicies GET /LinkedReports({Id})/Policies Gets ItemPolicies associated with the specified LinkedReport CatalogItem.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReportProperties GET /LinkedReports({Id})/Properties Gets LinkedReport Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.LinkedReportsApi getLinkedReports GET /LinkedReports Gets an array of LinkedReport CatalogItems.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi setLinkedReportCacheOptions PUT /LinkedReports({Id})/CacheOptions Replaces the CacheOption's content for a given LinkedReport using the provided definition.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi setLinkedReportHistorySnapshotOptions PUT /LinkedReports({Id})/HistorySnapshotOptions Updates HistorySnapshotOptions property.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi setLinkedReportPolicies PUT /LinkedReports({Id})/Policies Replaces ItemPolicies associated with the specified LinkedReport item.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi updateLinkedReport PATCH /LinkedReports({Id}) Updates the specified LinkedReport CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi updateLinkedReportComment PUT /LinkedReports({Id})/Comments({CommentId}) Updates the Comment specified by CommentId in the associated LinkedReport.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi updateLinkedReportParameterDefinitions PATCH /LinkedReports({Id})/ParameterDefinitions Updates the ParameterDefinitions associated with the specified LinkedReport by the Id.
SqlServer2017ReportingServicesRestApi.LinkedReportsApi updateLinkedReportProperties PUT /LinkedReports({Id})/Properties Updates the LinkedReport Properties included in the given list.
SqlServer2017ReportingServicesRestApi.MeApi getUserDetails GET /Me Gets the User object for the current user.
SqlServer2017ReportingServicesRestApi.MobileReportsApi addMobileReport POST /MobileReports Creates new MobileReport item
SqlServer2017ReportingServicesRestApi.MobileReportsApi addMobileReportComment POST /MobileReports({Id})/Comments Creates a new Comment associated to the specified MobileReport.
SqlServer2017ReportingServicesRestApi.MobileReportsApi deleteMobileReport DELETE /MobileReports({Id}) Delete the specified MobileReport.
SqlServer2017ReportingServicesRestApi.MobileReportsApi deleteMobileReportComment DELETE /MobileReports({Id})/Comments({CommentId}) Deletes the specified Comment associated to the MobileReport.
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReport GET /MobileReports({Id}) Fetch MobileReport item by Id or path property.
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReportAllowedActions GET /MobileReports({Id})/AllowedActions Gets a list of actions allowed in the current session; considering user permissions and product edition capabilities.
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReportComments GET /MobileReports({Id})/Comments Gets the Comments for a MobileReport specified by the Id.
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReportContent GET /MobileReports({Id})/Content/$value Gets the content of the specified MobileReport CatalogItem.
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReportPolicies GET /MobileReports({Id})/Policies Gets ItemPolicies associated with the MobileReport catalog item.
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReportProperties GET /MobileReports({Id})/Properties Gets MobileReport Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.MobileReportsApi getMobileReports GET /MobileReports Retrieve array of MobileReport catalog items.
SqlServer2017ReportingServicesRestApi.MobileReportsApi setMobileReportPolicies PUT /MobileReports({Id})/Policies Sets ItemPolicies on the MobileReport item.
SqlServer2017ReportingServicesRestApi.MobileReportsApi updateMobileReport PATCH /MobileReports({Id}) Updates the specified MobileReport CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.MobileReportsApi updateMobileReportComment PUT /MobileReports({Id})/Comments({CommentId}) Updates the Comment specified by CommentId in the associated MobileReport.
SqlServer2017ReportingServicesRestApi.MobileReportsApi updateMobileReportProperties PUT /MobileReports({Id})/Properties Updates the MobileReport properties included in the given list.
SqlServer2017ReportingServicesRestApi.ReportsApi addReport POST /Reports Creates a new Report CatalogItem.
SqlServer2017ReportingServicesRestApi.ReportsApi addReportComment POST /Reports({Id})/Comments Creates a new Comment associated to the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi addReportHistorySnapshot POST /Reports({Id})/HistorySnapshots Creates new HistorySnapshot
SqlServer2017ReportingServicesRestApi.ReportsApi checkReportDataSourceConnection POST /Reports({Id})/Model.CheckDataSourceConnection Checks the status of the specified Reports DataSource connection.
SqlServer2017ReportingServicesRestApi.ReportsApi deleteReport DELETE /Reports({Id}) Deletes the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi deleteReportComment DELETE /Reports({Id})/Comments({CommentId}) Deletes the specified Comment associated to the Report.
SqlServer2017ReportingServicesRestApi.ReportsApi deleteReportHistorySnapshot DELETE /Reports({Id})/HistorySnapshots({HistoryId}) Deletes the requested Reports HistorySnapshot specified by HistoryId.
SqlServer2017ReportingServicesRestApi.ReportsApi getReport GET /Reports({Id}) Gets a Report CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportAllowedActions GET /Reports({Id})/AllowedActions Gets a list of actions allowed in the current session; user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportCacheOptions GET /Reports({Id})/CacheOptions Gets the content of CacheOptions for the Report specified by the Id
SqlServer2017ReportingServicesRestApi.ReportsApi getReportCacheRefreshPlans GET /Reports({Id})/CacheRefreshPlans Gets the CacheRefreshPlans for the Report specified by the Id
SqlServer2017ReportingServicesRestApi.ReportsApi getReportComments GET /Reports({Id})/Comments Gets the Comments for a Report specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportContent GET /Reports({Id})/Content/$value Gets the content of the specified Report CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportDataSources GET /Reports({Id})/DataSources Gets the DataSources associated with the Report specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportDependentItems GET /Reports({Id})/DependentItems Returns a list of CatalogItems that reference the Report specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportHistorySnapshot GET /Reports({Id})/HistorySnapshots({HistoryId}) Gets the requested Reports HistorySnapshot specified by HistoryId.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportHistorySnapshotOptions GET /Reports({Id})/HistorySnapshotOptions Gets the HistorySnapshotOptions for the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportHistorySnapshots GET /Reports({Id})/HistorySnapshots Get a list of HistorySnapshots for the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportParameterDefinitions GET /Reports({Id})/ParameterDefinitions Gets the ParameterDefinitions associated with the Report specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportPolicies GET /Reports({Id})/Policies Gets policies associated with the specified Report CatalogItem.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportProperties GET /Reports({Id})/Properties Gets the specified Reports Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.ReportsApi getReportSharedDataSets GET /Reports({Id})/SharedDataSets Gets the shared DataSets for the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi getReportSubscriptions GET /Reports({Id})/Subscriptions Gets the Subscriptions for the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi getReports GET /Reports Gets an array of Report CatalogItems.
SqlServer2017ReportingServicesRestApi.ReportsApi setReportCacheOptions PUT /Reports({Id})/CacheOptions Replaces the CacheOptions content for a given Report using the provided definition.
SqlServer2017ReportingServicesRestApi.ReportsApi setReportDataSource PUT /Reports({Id})/DataSources Updates the DataSource definition associated with the Report specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi setReportHistorySnapshotOptions PUT /Reports({Id})/HistorySnapshotOptions Updates HistorySnapshotOptions for the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi setReportPolicies PUT /Reports({Id})/Policies Replaces ItemPolicies associated with the Report specified by the Id.
SqlServer2017ReportingServicesRestApi.ReportsApi setReportSharedDataSets PUT /Reports({Id})/SharedDataSets Updates the DataSet definitions associated with the specified Report.
SqlServer2017ReportingServicesRestApi.ReportsApi updateCacheSnapshot POST /Reports({Id})/Model.UpdateCacheSnapshot Updates the execution cache snapshot for the specified report.
SqlServer2017ReportingServicesRestApi.ReportsApi updateReport PATCH /Reports({Id}) Updates the specified Report CatalogItem using the provided definition.
SqlServer2017ReportingServicesRestApi.ReportsApi updateReportComment PUT /Reports({Id})/Comments({CommentId}) Updates the Comment specified by CommentId in the associated Report.
SqlServer2017ReportingServicesRestApi.ReportsApi updateReportParameterDefinitions PATCH /Reports({Id})/ParameterDefinitions Updates the ParameterDefinitions associated with the Report specified by Id.
SqlServer2017ReportingServicesRestApi.ReportsApi updateReportProperties PUT /Reports({Id})/Properties Updates the Report Properties included in the given list.
SqlServer2017ReportingServicesRestApi.ResourcesApi addResource POST /Resources Creates new Resource item
SqlServer2017ReportingServicesRestApi.ResourcesApi deleteResource DELETE /Resources({Id}) Delete the specified Resource catalog item.
SqlServer2017ReportingServicesRestApi.ResourcesApi getResource GET /Resources({Id}) Get the specified Resource.
SqlServer2017ReportingServicesRestApi.ResourcesApi getResourceAllowedActions GET /Resources({Id})/AllowedActions Gets a list of actions allowed in the current session; considering user permissions and product edition capabilities.
SqlServer2017ReportingServicesRestApi.ResourcesApi getResourceContent GET /Resources({Id})/Content/$value Gets the content of the specified Resource CatalogItem specified by the Id.
SqlServer2017ReportingServicesRestApi.ResourcesApi getResourcePolicies GET /Resources({Id})/Policies Gets ItemPolicies on the Resource item.
SqlServer2017ReportingServicesRestApi.ResourcesApi getResourceProperties GET /Resources({Id})/Properties Gets the specified Resources Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.ResourcesApi getResources GET /Resources Gets an array of Resource catalog items
SqlServer2017ReportingServicesRestApi.ResourcesApi setResourcePolicies PUT /Resources({Id})/Policies Replaces ItemPolicies on the Resource item.
SqlServer2017ReportingServicesRestApi.ResourcesApi updateResource PATCH /Resources({Id}) Updates the specified Resource catalog item.
SqlServer2017ReportingServicesRestApi.ResourcesApi updateResourceProperties PUT /Resources({Id})/Properties Updates the Resource Properties included in the given list.
SqlServer2017ReportingServicesRestApi.SessionApi createSession POST /Session Creates a new session
SqlServer2017ReportingServicesRestApi.SessionApi deleteSession DELETE /Session Deletes the currently active session
SqlServer2017ReportingServicesRestApi.SubscriptionsApi addSubscription POST /Subscriptions Creates new Subscription item
SqlServer2017ReportingServicesRestApi.SubscriptionsApi deleteSubscription DELETE /Subscriptions({Id}) Deletes the specified Subscription.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi disableSubscription POST /Subscriptions({Id})/Model.Disable Disables the Subscription specified by the Id.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi enableSubscription POST /Subscriptions({Id})/Model.Enable Enables a Subscription specified by the Id.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi executeSubscription POST /Subscriptions({Id})/Model.Execute Executes the Subscription specified by the Id.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi getSubscription GET /Subscriptions({Id}) Get the specified Subscription.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi getSubscriptions GET /Subscriptions Gets an array of Subscriptions.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi setSubscription PUT /Subscriptions({Id}) Replaces the Subscription item using Id property as key.
SqlServer2017ReportingServicesRestApi.SubscriptionsApi updateSubscription PATCH /Subscriptions({Id}) Updates the Subscription item using Id property as key.
SqlServer2017ReportingServicesRestApi.SystemApi getSystemAllowedActions GET /System/AllowedActions Gets a list of system level actions allowed in the current session; user permissions and product edition capabilities are considered when querying.
SqlServer2017ReportingServicesRestApi.SystemApi getSystemInfo GET /System Get SystemInformation
SqlServer2017ReportingServicesRestApi.SystemApi getSystemPolicies GET /System/Policies Gets the System Policies.
SqlServer2017ReportingServicesRestApi.SystemApi getSystemProperties GET /System/Properties Gets the Systems Properties (takes list of Property names to retrieve the values)
SqlServer2017ReportingServicesRestApi.SystemApi setSystemPolicies PUT /System/Policies Updates the System's Policies.
SqlServer2017ReportingServicesRestApi.SystemApi updateSystemProperties PATCH /System/Properties Updates the System Properties with the given property list.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Readme

Keywords

none

Package Sidebar

Install

npm i cloudcc-ssrs

Weekly Downloads

3

Version

2.0.1

License

Unlicense

Unpacked Size

104 kB

Total Files

4

Last publish

Collaborators

  • xuhm