1.0.0 • Published 7 years ago

j_report_server v1.0.0

Weekly downloads
-
License
Apache 2.0
Repository
-
Last release
7 years ago

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 project:

  • API version: 1.0.0
  • Package version: 1.0.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 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:

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 j_report_server from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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:

    npm install YOUR_USERNAME/j_report_server --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 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

ClassMethodHTTP requestDescription
JReportServer.BVApideleteDimensionPermissionsOfBVDELETE /BV/dimension/permissionsDelete group object permissions in a business view.
JReportServer.BVApigetBVAggregationsGET /BV/aggregationsGet the aggregations in the business view.
JReportServer.BVApigetBVCategoriesGET /BV/categoriesGet the categories in the business view.
JReportServer.BVApigetBVDetailsGET /BV/detailsGet the detail objects in the business view.
JReportServer.BVApigetBVDimensionGET /BV/dimensionGet the group object in the business view.
JReportServer.BVApigetBVDimensionsGET /BV/dimensionsGet the group objects in the business view.
JReportServer.BVApigetBVsInCatalogGET /BVsGet the business views in a catalog.
JReportServer.BVApigetDimensionPermissionGET /BV/dimension/permissionGet the permission of a group object.
JReportServer.BVApigetDimensionPermissionsOfBVGET /BV/dimension/permissionsGet group object permissions in a business view.
JReportServer.BVApisetDimensionPermissionPUT /BV/dimension/permissionSet the permission of a group object.
JReportServer.BVApisetDimensionPermissionsOfBVPUT /BV/dimension/permissionsSet group object permissions in a business view.
JReportServer.ConfigurationApiaddDashboardProfilePOST /profilelist/dashboardAdd a profile.
JReportServer.ConfigurationApiaddPageStudioProfilePOST /profilelist/pagestudioAdd a profile.
JReportServer.ConfigurationApiaddWebStudioProfilePOST /profilelist/webstudioAdd a profile.
JReportServer.ConfigurationApideleteDashboardProfileDELETE /profile/dashboardDelete the profile.
JReportServer.ConfigurationApideletePageStudioProfileDELETE /profile/pagestudioDelete the profile.
JReportServer.ConfigurationApideleteWebStudioProfileDELETE /profile/webstudioDelete the profile.
JReportServer.ConfigurationApigetDashboardProfilePropertiesGET /profile/dashboardGet the properties of the profile.
JReportServer.ConfigurationApigetDashboardProfilesGET /profilelist/dashboardGet the profiles.
JReportServer.ConfigurationApigetDefaultServerPreferenceGET /preference/default/serverGet the default preference of the server.
JReportServer.ConfigurationApigetDefaultViewerPreferenceGET /preference/default/viewerGet the default preference of JReport Viewer..
JReportServer.ConfigurationApigetPageStudioProfilePropertiesGET /profile/pagestudioGet the properties of the profile.
JReportServer.ConfigurationApigetPageStudioProfilesGET /profilelist/pagestudioGet the profiles.
JReportServer.ConfigurationApigetUserServerPreferenceGET /preference/serverGet the user preference of the server.
JReportServer.ConfigurationApigetUserViewerPreferenceGET /preference/viewerGet the user preference of JReport Viewer.
JReportServer.ConfigurationApigetWebStudioProfilePropertiesGET /profile/webstudioGet the properties of the profile.
JReportServer.ConfigurationApigetWebStudioProfilesGET /profilelist/webstudioGet the profiles.
JReportServer.ConfigurationApisetDefaultServerPreferencePUT /preference/default/serverSet the default preference of the server.
JReportServer.ConfigurationApisetDefaultViewerPreferencePUT /preference/default/viewerSet the default preference of JReport Viewer..
JReportServer.ConfigurationApisetUserServerPreferencePUT /preference/serverSet the user preference of the server.
JReportServer.ConfigurationApisetUserViewerPreferencePUT /preference/viewerGet the user preference of JReport Viewer.
JReportServer.ConfigurationApiupdateDashboardProfilePUT /profile/dashboardUpdate the properties of the profile.
JReportServer.ConfigurationApiupdatePageStudioProfilePUT /profile/pagestudioUpdate the properties of the profile.
JReportServer.ConfigurationApiupdateWebStudioProfilePUT /profile/webstudioUpdate the properties of the profile.
JReportServer.ResourceTreeApideleteNodePermissionsByPathDELETE /node/permissionsDelete principals' permissions on the node/version.
JReportServer.ResourceTreeApigetNodeByPathGET /nodeGet the node properties by the server resource path.
JReportServer.ResourceTreeApigetNodeInheritedPermissionsByPathGET /node/inheritedPermissionsGet inherited permissions on the node for principals.
JReportServer.ResourceTreeApigetNodeListInFolderGET /nodes/listGet the node name list in a folder and filter by specified node types.
JReportServer.ResourceTreeApigetNodePermissionForUserGET /node/permissionGet 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.ResourceTreeApigetNodePermissionsByPathGET /node/permissionsGet principals' permissions on the node/version by the server resource path.
JReportServer.ResourceTreeApigetNodesInFolderGET /nodesGet the nodes in a folder and filter by specified node types.
JReportServer.ResourceTreeApigetResultVersionNumberListOfReportGET /resultVersions/listGet the result version number list of a report resource.
JReportServer.ResourceTreeApigetResultVersionOfReportGET /resultVersionGet the properties of a report result version by the version number.
JReportServer.ResourceTreeApigetResultVersionsOfReportGET /resultVersionsGet the result versions of a report resource.
JReportServer.ResourceTreeApigetVersionByNumberGET /versionGet the properties of a version by the version number.
JReportServer.ResourceTreeApigetVersionNumberListOfResourceGET /versions/listGet the version number list of a server resource.
JReportServer.ResourceTreeApigetVersionsOfResourceGET /versionsGet the versions of a server resource.
JReportServer.ResourceTreeApisetNodePermissionsByPathPUT /node/permissionsSet principals' permissions on the node/version.
JReportServer.SecurityApiaddGroupMembersPOST /group/membersAdd group members.
JReportServer.SecurityApiaddRoleMembersPOST /role/membersAdd the role members.
JReportServer.SecurityApichangeUserPasswordPUT /user/passwordChange a user's password.
JReportServer.SecurityApicreateGroupPOST /groupsCreate a new group.
JReportServer.SecurityApicreateRolePOST /rolesCreate a new role.
JReportServer.SecurityApicreateUserPOST /usersCreate a new user.
JReportServer.SecurityApideleteGroupDELETE /groupDelete a group.
JReportServer.SecurityApideleteGroupMembersDELETE /group/membersDelete the group members.
JReportServer.SecurityApideleteRoleDELETE /roleDelete a role.
JReportServer.SecurityApideleteRoleMembersDELETE /role/membersDelete the role members.
JReportServer.SecurityApideleteUserDELETE /userDelete a user account.
JReportServer.SecurityApigetGroupListGET /groupsGet the group list.
JReportServer.SecurityApigetGroupMembersGET /group/membersGet the group members.
JReportServer.SecurityApigetGroupPrivilegesGET /group/privilegesGet the group privileges.
JReportServer.SecurityApigetGroupsOfUserGET /user/groupsGet the groups of the user.
JReportServer.SecurityApigetRoleListGET /rolesGet the role list.
JReportServer.SecurityApigetRoleMembersGET /role/membersGet the members.
JReportServer.SecurityApigetRolePrivilegesGET /role/privilegesGet the role privileges.
JReportServer.SecurityApigetRolesOfUserGET /user/rolesGet the roles of the user.
JReportServer.SecurityApigetUserListGET /usersGet the user list.
JReportServer.SecurityApigetUserPrivilegesGET /user/privilegesGet the user privileges.
JReportServer.SecurityApigetUserPropertiesGET /userGet the user properties.
JReportServer.SecurityApiupdateGroupPrivilegesPUT /group/privilegesUpdate the group privileges.
JReportServer.SecurityApiupdateRolePrivilegesPUT /role/privilegesUpdate the role privileges.
JReportServer.SecurityApiupdateUserPrivilegesPUT /user/privilegesUpdate the user privileges.
JReportServer.SecurityApiupdateUserPropertiesPUT /userUpdate the user properties.
JReportServer.TaskApisubmitScheduledTaskPOST /myTasks/scheduledSubmit the scheduled task.
JReportServer.TaskApiviewReportTaskPOST /myTasks/ondemandView the report task.
JReportServer.UserSessionApigetCurrentUserSessionGET /sessionGet the current user session.
JReportServer.UserSessionApiloginPOST /sessionCreate new user session (login).
JReportServer.UserSessionApilogoutDELETE /sessionDelete the current user session (logout).
JReportServer.UserSessionApisetSessionTimeoutPUT /session/timeoutSet session timeout in seconds. A negative time indicates the session should never timeout.

Documentation for Models

Documentation for Authorization

user_auth

  • Type: HTTP basic authentication