# j_report_server JReportServer - JavaScript client for j_report_server No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.0 - Package version: 1.0.0 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install j_report_server --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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your j_report_server from, and run: ```shell npm link /path/to/ ``` You should now be able to `require('j_report_server')` 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/j_report_server then install it via: ```shell npm install YOUR_USERNAME/j_report_server --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var JReportServer = require('j_report_server'); var defaultClient = JReportServer.ApiClient.instance; // Configure HTTP basic authorization: user_auth var user_auth = defaultClient.authentications['user_auth']; user_auth.username = 'YOUR USERNAME' user_auth.password = 'YOUR PASSWORD' var api = new JReportServer.BVApi() var opts = { 'bvName': "bvName_example", // {String} The business view name. 'dsName': "dsName_example", // {String} The data source name. 'path': "path_example", // {String} The server resource path. 'versionNumber': 56, // {Number} The version number. -1 means the latest version; 0 means that this parameter is ignored. 'principalType': "principalType_example", // {String} The principal type. 'principalName': "principalName_example" // {String} The principal name. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.deleteDimensionPermissionsOfBV(opts, callback); ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost:8888/jrserver/api/v1* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *JReportServer.BVApi* | [**deleteDimensionPermissionsOfBV**](docs/BVApi.md#deleteDimensionPermissionsOfBV) | **DELETE** /BV/dimension/permissions | Delete group object permissions in a business view. *JReportServer.BVApi* | [**getBVAggregations**](docs/BVApi.md#getBVAggregations) | **GET** /BV/aggregations | Get the aggregations in the business view. *JReportServer.BVApi* | [**getBVCategories**](docs/BVApi.md#getBVCategories) | **GET** /BV/categories | Get the categories in the business view. *JReportServer.BVApi* | [**getBVDetails**](docs/BVApi.md#getBVDetails) | **GET** /BV/details | Get the detail objects in the business view. *JReportServer.BVApi* | [**getBVDimension**](docs/BVApi.md#getBVDimension) | **GET** /BV/dimension | Get the group object in the business view. *JReportServer.BVApi* | [**getBVDimensions**](docs/BVApi.md#getBVDimensions) | **GET** /BV/dimensions | Get the group objects in the business view. *JReportServer.BVApi* | [**getBVsInCatalog**](docs/BVApi.md#getBVsInCatalog) | **GET** /BVs | Get the business views in a catalog. *JReportServer.BVApi* | [**getDimensionPermission**](docs/BVApi.md#getDimensionPermission) | **GET** /BV/dimension/permission | Get the permission of a group object. *JReportServer.BVApi* | [**getDimensionPermissionsOfBV**](docs/BVApi.md#getDimensionPermissionsOfBV) | **GET** /BV/dimension/permissions | Get group object permissions in a business view. *JReportServer.BVApi* | [**setDimensionPermission**](docs/BVApi.md#setDimensionPermission) | **PUT** /BV/dimension/permission | Set the permission of a group object. *JReportServer.BVApi* | [**setDimensionPermissionsOfBV**](docs/BVApi.md#setDimensionPermissionsOfBV) | **PUT** /BV/dimension/permissions | Set group object permissions in a business view. *JReportServer.ConfigurationApi* | [**addDashboardProfile**](docs/ConfigurationApi.md#addDashboardProfile) | **POST** /profilelist/dashboard | Add a profile. *JReportServer.ConfigurationApi* | [**addPageStudioProfile**](docs/ConfigurationApi.md#addPageStudioProfile) | **POST** /profilelist/pagestudio | Add a profile. *JReportServer.ConfigurationApi* | [**addWebStudioProfile**](docs/ConfigurationApi.md#addWebStudioProfile) | **POST** /profilelist/webstudio | Add a profile. *JReportServer.ConfigurationApi* | [**deleteDashboardProfile**](docs/ConfigurationApi.md#deleteDashboardProfile) | **DELETE** /profile/dashboard | Delete the profile. *JReportServer.ConfigurationApi* | [**deletePageStudioProfile**](docs/ConfigurationApi.md#deletePageStudioProfile) | **DELETE** /profile/pagestudio | Delete the profile. *JReportServer.ConfigurationApi* | [**deleteWebStudioProfile**](docs/ConfigurationApi.md#deleteWebStudioProfile) | **DELETE** /profile/webstudio | Delete the profile. *JReportServer.ConfigurationApi* | [**getDashboardProfileProperties**](docs/ConfigurationApi.md#getDashboardProfileProperties) | **GET** /profile/dashboard | Get the properties of the profile. *JReportServer.ConfigurationApi* | [**getDashboardProfiles**](docs/ConfigurationApi.md#getDashboardProfiles) | **GET** /profilelist/dashboard | Get the profiles. *JReportServer.ConfigurationApi* | [**getDefaultServerPreference**](docs/ConfigurationApi.md#getDefaultServerPreference) | **GET** /preference/default/server | Get the default preference of the server. *JReportServer.ConfigurationApi* | [**getDefaultViewerPreference**](docs/ConfigurationApi.md#getDefaultViewerPreference) | **GET** /preference/default/viewer | Get the default preference of JReport Viewer.. *JReportServer.ConfigurationApi* | [**getPageStudioProfileProperties**](docs/ConfigurationApi.md#getPageStudioProfileProperties) | **GET** /profile/pagestudio | Get the properties of the profile. *JReportServer.ConfigurationApi* | [**getPageStudioProfiles**](docs/ConfigurationApi.md#getPageStudioProfiles) | **GET** /profilelist/pagestudio | Get the profiles. *JReportServer.ConfigurationApi* | [**getUserServerPreference**](docs/ConfigurationApi.md#getUserServerPreference) | **GET** /preference/server | Get the user preference of the server. *JReportServer.ConfigurationApi* | [**getUserViewerPreference**](docs/ConfigurationApi.md#getUserViewerPreference) | **GET** /preference/viewer | Get the user preference of JReport Viewer. *JReportServer.ConfigurationApi* | [**getWebStudioProfileProperties**](docs/ConfigurationApi.md#getWebStudioProfileProperties) | **GET** /profile/webstudio | Get the properties of the profile. *JReportServer.ConfigurationApi* | [**getWebStudioProfiles**](docs/ConfigurationApi.md#getWebStudioProfiles) | **GET** /profilelist/webstudio | Get the profiles. *JReportServer.ConfigurationApi* | [**setDefaultServerPreference**](docs/ConfigurationApi.md#setDefaultServerPreference) | **PUT** /preference/default/server | Set the default preference of the server. *JReportServer.ConfigurationApi* | [**setDefaultViewerPreference**](docs/ConfigurationApi.md#setDefaultViewerPreference) | **PUT** /preference/default/viewer | Set the default preference of JReport Viewer.. *JReportServer.ConfigurationApi* | [**setUserServerPreference**](docs/ConfigurationApi.md#setUserServerPreference) | **PUT** /preference/server | Set the user preference of the server. *JReportServer.ConfigurationApi* | [**setUserViewerPreference**](docs/ConfigurationApi.md#setUserViewerPreference) | **PUT** /preference/viewer | Get the user preference of JReport Viewer. *JReportServer.ConfigurationApi* | [**updateDashboardProfile**](docs/ConfigurationApi.md#updateDashboardProfile) | **PUT** /profile/dashboard | Update the properties of the profile. *JReportServer.ConfigurationApi* | [**updatePageStudioProfile**](docs/ConfigurationApi.md#updatePageStudioProfile) | **PUT** /profile/pagestudio | Update the properties of the profile. *JReportServer.ConfigurationApi* | [**updateWebStudioProfile**](docs/ConfigurationApi.md#updateWebStudioProfile) | **PUT** /profile/webstudio | Update the properties of the profile. *JReportServer.ResourceTreeApi* | [**deleteNodePermissionsByPath**](docs/ResourceTreeApi.md#deleteNodePermissionsByPath) | **DELETE** /node/permissions | Delete principals' permissions on the node/version. *JReportServer.ResourceTreeApi* | [**getNodeByPath**](docs/ResourceTreeApi.md#getNodeByPath) | **GET** /node | Get the node properties by the server resource path. *JReportServer.ResourceTreeApi* | [**getNodeInheritedPermissionsByPath**](docs/ResourceTreeApi.md#getNodeInheritedPermissionsByPath) | **GET** /node/inheritedPermissions | Get inherited permissions on the node for principals. *JReportServer.ResourceTreeApi* | [**getNodeListInFolder**](docs/ResourceTreeApi.md#getNodeListInFolder) | **GET** /nodes/list | Get the node name list in a folder and filter by specified node types. *JReportServer.ResourceTreeApi* | [**getNodePermissionForUser**](docs/ResourceTreeApi.md#getNodePermissionForUser) | **GET** /node/permission | Get permission of node/version by the server resource path for the specified user. If the userName is not specified then return permission of the user of the user session. *JReportServer.ResourceTreeApi* | [**getNodePermissionsByPath**](docs/ResourceTreeApi.md#getNodePermissionsByPath) | **GET** /node/permissions | Get principals' permissions on the node/version by the server resource path. *JReportServer.ResourceTreeApi* | [**getNodesInFolder**](docs/ResourceTreeApi.md#getNodesInFolder) | **GET** /nodes | Get the nodes in a folder and filter by specified node types. *JReportServer.ResourceTreeApi* | [**getResultVersionNumberListOfReport**](docs/ResourceTreeApi.md#getResultVersionNumberListOfReport) | **GET** /resultVersions/list | Get the result version number list of a report resource. *JReportServer.ResourceTreeApi* | [**getResultVersionOfReport**](docs/ResourceTreeApi.md#getResultVersionOfReport) | **GET** /resultVersion | Get the properties of a report result version by the version number. *JReportServer.ResourceTreeApi* | [**getResultVersionsOfReport**](docs/ResourceTreeApi.md#getResultVersionsOfReport) | **GET** /resultVersions | Get the result versions of a report resource. *JReportServer.ResourceTreeApi* | [**getVersionByNumber**](docs/ResourceTreeApi.md#getVersionByNumber) | **GET** /version | Get the properties of a version by the version number. *JReportServer.ResourceTreeApi* | [**getVersionNumberListOfResource**](docs/ResourceTreeApi.md#getVersionNumberListOfResource) | **GET** /versions/list | Get the version number list of a server resource. *JReportServer.ResourceTreeApi* | [**getVersionsOfResource**](docs/ResourceTreeApi.md#getVersionsOfResource) | **GET** /versions | Get the versions of a server resource. *JReportServer.ResourceTreeApi* | [**setNodePermissionsByPath**](docs/ResourceTreeApi.md#setNodePermissionsByPath) | **PUT** /node/permissions | Set principals' permissions on the node/version. *JReportServer.SecurityApi* | [**addGroupMembers**](docs/SecurityApi.md#addGroupMembers) | **POST** /group/members | Add group members. *JReportServer.SecurityApi* | [**addRoleMembers**](docs/SecurityApi.md#addRoleMembers) | **POST** /role/members | Add the role members. *JReportServer.SecurityApi* | [**changeUserPassword**](docs/SecurityApi.md#changeUserPassword) | **PUT** /user/password | Change a user's password. *JReportServer.SecurityApi* | [**createGroup**](docs/SecurityApi.md#createGroup) | **POST** /groups | Create a new group. *JReportServer.SecurityApi* | [**createRole**](docs/SecurityApi.md#createRole) | **POST** /roles | Create a new role. *JReportServer.SecurityApi* | [**createUser**](docs/SecurityApi.md#createUser) | **POST** /users | Create a new user. *JReportServer.SecurityApi* | [**deleteGroup**](docs/SecurityApi.md#deleteGroup) | **DELETE** /group | Delete a group. *JReportServer.SecurityApi* | [**deleteGroupMembers**](docs/SecurityApi.md#deleteGroupMembers) | **DELETE** /group/members | Delete the group members. *JReportServer.SecurityApi* | [**deleteRole**](docs/SecurityApi.md#deleteRole) | **DELETE** /role | Delete a role. *JReportServer.SecurityApi* | [**deleteRoleMembers**](docs/SecurityApi.md#deleteRoleMembers) | **DELETE** /role/members | Delete the role members. *JReportServer.SecurityApi* | [**deleteUser**](docs/SecurityApi.md#deleteUser) | **DELETE** /user | Delete a user account. *JReportServer.SecurityApi* | [**getGroupList**](docs/SecurityApi.md#getGroupList) | **GET** /groups | Get the group list. *JReportServer.SecurityApi* | [**getGroupMembers**](docs/SecurityApi.md#getGroupMembers) | **GET** /group/members | Get the group members. *JReportServer.SecurityApi* | [**getGroupPrivileges**](docs/SecurityApi.md#getGroupPrivileges) | **GET** /group/privileges | Get the group privileges. *JReportServer.SecurityApi* | [**getGroupsOfUser**](docs/SecurityApi.md#getGroupsOfUser) | **GET** /user/groups | Get the groups of the user. *JReportServer.SecurityApi* | [**getRoleList**](docs/SecurityApi.md#getRoleList) | **GET** /roles | Get the role list. *JReportServer.SecurityApi* | [**getRoleMembers**](docs/SecurityApi.md#getRoleMembers) | **GET** /role/members | Get the members. *JReportServer.SecurityApi* | [**getRolePrivileges**](docs/SecurityApi.md#getRolePrivileges) | **GET** /role/privileges | Get the role privileges. *JReportServer.SecurityApi* | [**getRolesOfUser**](docs/SecurityApi.md#getRolesOfUser) | **GET** /user/roles | Get the roles of the user. *JReportServer.SecurityApi* | [**getUserList**](docs/SecurityApi.md#getUserList) | **GET** /users | Get the user list. *JReportServer.SecurityApi* | [**getUserPrivileges**](docs/SecurityApi.md#getUserPrivileges) | **GET** /user/privileges | Get the user privileges. *JReportServer.SecurityApi* | [**getUserProperties**](docs/SecurityApi.md#getUserProperties) | **GET** /user | Get the user properties. *JReportServer.SecurityApi* | [**updateGroupPrivileges**](docs/SecurityApi.md#updateGroupPrivileges) | **PUT** /group/privileges | Update the group privileges. *JReportServer.SecurityApi* | [**updateRolePrivileges**](docs/SecurityApi.md#updateRolePrivileges) | **PUT** /role/privileges | Update the role privileges. *JReportServer.SecurityApi* | [**updateUserPrivileges**](docs/SecurityApi.md#updateUserPrivileges) | **PUT** /user/privileges | Update the user privileges. *JReportServer.SecurityApi* | [**updateUserProperties**](docs/SecurityApi.md#updateUserProperties) | **PUT** /user | Update the user properties. *JReportServer.TaskApi* | [**submitScheduledTask**](docs/TaskApi.md#submitScheduledTask) | **POST** /myTasks/scheduled | Submit the scheduled task. *JReportServer.TaskApi* | [**viewReportTask**](docs/TaskApi.md#viewReportTask) | **POST** /myTasks/ondemand | View the report task. *JReportServer.UserSessionApi* | [**getCurrentUserSession**](docs/UserSessionApi.md#getCurrentUserSession) | **GET** /session | Get the current user session. *JReportServer.UserSessionApi* | [**login**](docs/UserSessionApi.md#login) | **POST** /session | Create new user session (login). *JReportServer.UserSessionApi* | [**logout**](docs/UserSessionApi.md#logout) | **DELETE** /session | Delete the current user session (logout). *JReportServer.UserSessionApi* | [**setSessionTimeout**](docs/UserSessionApi.md#setSessionTimeout) | **PUT** /session/timeout | Set session timeout in seconds. A negative time indicates the session should never timeout. ## Documentation for Models - [JReportServer.BV](docs/BV.md) - [JReportServer.BVElement](docs/BVElement.md) - [JReportServer.CatalogNode](docs/CatalogNode.md) - [JReportServer.CommonPreference](docs/CommonPreference.md) - [JReportServer.ComponentNode](docs/ComponentNode.md) - [JReportServer.ComponentVersion](docs/ComponentVersion.md) - [JReportServer.DashboardPreference](docs/DashboardPreference.md) - [JReportServer.DashboardProfile](docs/DashboardProfile.md) - [JReportServer.DbValue](docs/DbValue.md) - [JReportServer.DimensionPermission](docs/DimensionPermission.md) - [JReportServer.Email](docs/Email.md) - [JReportServer.EmailResult](docs/EmailResult.md) - [JReportServer.EmailUseSMTPAccount](docs/EmailUseSMTPAccount.md) - [JReportServer.ExcelFormat](docs/ExcelFormat.md) - [JReportServer.FTP](docs/FTP.md) - [JReportServer.FolderNode](docs/FolderNode.md) - [JReportServer.FormatOptionsAndFileName](docs/FormatOptionsAndFileName.md) - [JReportServer.Group](docs/Group.md) - [JReportServer.HTMLFormat](docs/HTMLFormat.md) - [JReportServer.JReportResultFormat](docs/JReportResultFormat.md) - [JReportServer.Node](docs/Node.md) - [JReportServer.PDFFormat](docs/PDFFormat.md) - [JReportServer.PageReportResultFormat](docs/PageReportResultFormat.md) - [JReportServer.PageStudioPreference](docs/PageStudioPreference.md) - [JReportServer.PageStudioProfile](docs/PageStudioProfile.md) - [JReportServer.PeriodTime](docs/PeriodTime.md) - [JReportServer.PeriodTimeDate](docs/PeriodTimeDate.md) - [JReportServer.PeriodTimeDateDaily](docs/PeriodTimeDateDaily.md) - [JReportServer.PeriodTimeDateMonthly](docs/PeriodTimeDateMonthly.md) - [JReportServer.PeriodTimeDateMonthlyWeekdayOfMonth](docs/PeriodTimeDateMonthlyWeekdayOfMonth.md) - [JReportServer.PeriodTimeDateWeekly](docs/PeriodTimeDateWeekly.md) - [JReportServer.PeriodTimeDuration](docs/PeriodTimeDuration.md) - [JReportServer.PeriodTimeTime](docs/PeriodTimeTime.md) - [JReportServer.PeriodTimeTimeHourly](docs/PeriodTimeTimeHourly.md) - [JReportServer.PeriodTimeTimeHourlyBetweenAnd](docs/PeriodTimeTimeHourlyBetweenAnd.md) - [JReportServer.PeriodTimeTimeMinutely](docs/PeriodTimeTimeMinutely.md) - [JReportServer.Permissions](docs/Permissions.md) - [JReportServer.PlainTextFormat](docs/PlainTextFormat.md) - [JReportServer.PostScriptFormat](docs/PostScriptFormat.md) - [JReportServer.Principal](docs/Principal.md) - [JReportServer.PrincipalPermissions](docs/PrincipalPermissions.md) - [JReportServer.Privilege](docs/Privilege.md) - [JReportServer.Profile](docs/Profile.md) - [JReportServer.PutUser](docs/PutUser.md) - [JReportServer.RTFFormat](docs/RTFFormat.md) - [JReportServer.ReportEmail](docs/ReportEmail.md) - [JReportServer.ReportFTP](docs/ReportFTP.md) - [JReportServer.ReportInfo](docs/ReportInfo.md) - [JReportServer.ReportInfoAdvanced](docs/ReportInfoAdvanced.md) - [JReportServer.ReportInfoAdvancedUsingDBProperties](docs/ReportInfoAdvancedUsingDBProperties.md) - [JReportServer.ReportNode](docs/ReportNode.md) - [JReportServer.ReportParameter](docs/ReportParameter.md) - [JReportServer.ResultNode](docs/ResultNode.md) - [JReportServer.ResultVersion](docs/ResultVersion.md) - [JReportServer.Role](docs/Role.md) - [JReportServer.ScheduledTask](docs/ScheduledTask.md) - [JReportServer.ServerPreference](docs/ServerPreference.md) - [JReportServer.SimpleDate](docs/SimpleDate.md) - [JReportServer.SimpleDateTime](docs/SimpleDateTime.md) - [JReportServer.Task](docs/Task.md) - [JReportServer.TaskPublish](docs/TaskPublish.md) - [JReportServer.TextFormat](docs/TextFormat.md) - [JReportServer.Time12HourClock](docs/Time12HourClock.md) - [JReportServer.TimeCondition](docs/TimeCondition.md) - [JReportServer.ToEmail](docs/ToEmail.md) - [JReportServer.ToFTP](docs/ToFTP.md) - [JReportServer.ToVersion](docs/ToVersion.md) - [JReportServer.ToVersionArchiveLocation](docs/ToVersionArchiveLocation.md) - [JReportServer.ToVersionFormats](docs/ToVersionFormats.md) - [JReportServer.User](docs/User.md) - [JReportServer.UserSession](docs/UserSession.md) - [JReportServer.Version](docs/Version.md) - [JReportServer.ViewReportTask](docs/ViewReportTask.md) - [JReportServer.ViewerPreference](docs/ViewerPreference.md) - [JReportServer.WebReportResultFormat](docs/WebReportResultFormat.md) - [JReportServer.WebStudioPreference](docs/WebStudioPreference.md) - [JReportServer.WebStudioProfile](docs/WebStudioProfile.md) - [JReportServer.XMLFormat](docs/XMLFormat.md) ## Documentation for Authorization ### user_auth - **Type**: HTTP basic authentication