dubhe-report-api

dubhe-report-api

DubheReportApi - JavaScript client for dubhe-report-api dubhe report demo This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.2
• Package version: 1.0.2
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.openkosmos.com

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 dubhe-report-api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your dubhe-report-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 DubheReportApi = require('dubhe-report-api');


var api = new DubheReportApi.AccessControllerApi()
api.fetchAccessesUsingPOST().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:28801

Class	Method	HTTP request	Description
DubheReportApi.AccessControllerApi	fetchAccessesUsingPOST	POST /rest/access/fetch	获取权限
DubheReportApi.AccessControllerApi	fetchMenuUsingPOST	POST /rest/access/menu	获取菜单
DubheReportApi.AuthControllerApi	loginUsingPOST	POST /auth/login	认证接口
DubheReportApi.CdcReportControllerApi	addCdc	POST /api/cdc/add	保存报卡
DubheReportApi.CdcReportControllerApi	addCdc1	POST /rest/cdc/add	保存报卡
DubheReportApi.CdcReportControllerApi	addCdcMulti	POST /api/cdc/addMulti/{immediately}	保存报卡
DubheReportApi.CdcReportControllerApi	addCdcMulti1	POST /rest/cdc/addMulti/{immediately}	保存报卡
DubheReportApi.CdcReportControllerApi	cdcReportImmediately	GET /api/cdc/report/immediately	批量报卡
DubheReportApi.CdcReportControllerApi	cdcReportImmediately1	GET /rest/cdc/report/immediately	批量报卡
DubheReportApi.CdcReportControllerApi	cdcsetting	GET /api/cdc/setting	获取CDC设置
DubheReportApi.CdcReportControllerApi	cdcsetting1	GET /rest/cdc/setting	获取CDC设置
DubheReportApi.CdcReportControllerApi	detailCdc	GET /api/cdc/detail/{id}	获取CDC请求详情
DubheReportApi.CdcReportControllerApi	detailCdc1	GET /rest/cdc/detail/{id}	获取CDC请求详情
DubheReportApi.CdcReportControllerApi	listCdc	GET /api/cdc/list	获取CDC全部上报请求
DubheReportApi.CdcReportControllerApi	listCdc1	GET /rest/cdc/list	获取CDC全部上报请求
DubheReportApi.CdcReportControllerApi	removeCdc	DELETE /api/cdc/delete/{id}	撤销报卡
DubheReportApi.CdcReportControllerApi	removeCdc1	DELETE /rest/cdc/delete/{id}	撤销报卡
DubheReportApi.CdcReportControllerApi	reportCdc	POST /api/cdc/report/{id}	上报CDC
DubheReportApi.CdcReportControllerApi	reportCdc1	POST /rest/cdc/report/{id}	上报CDC
DubheReportApi.CdcReportControllerApi	testDetailCdc	GET /api/cdc/testDetailCdc/{id}	获取CDC请求详情
DubheReportApi.CdcReportControllerApi	testDetailCdc1	GET /rest/cdc/testDetailCdc/{id}	获取CDC请求详情
DubheReportApi.CdcReportControllerApi	testPublishUsingGET	GET /api/cdc/report/testPublish	testPublish
DubheReportApi.CdcReportControllerApi	testPublishUsingGET1	GET /rest/cdc/report/testPublish	testPublish
DubheReportApi.CdcReportControllerApi	vpnstatus	GET /api/cdc/vpnstatus	获取CDC VPN状态
DubheReportApi.CdcReportControllerApi	vpnstatus1	GET /rest/cdc/vpnstatus	获取CDC VPN状态
DubheReportApi.DigitalCertificateControllerApi	fetchLicenseUsingGET	GET /license/info	获取license信息
DubheReportApi.DigitalCertificateControllerApi	reloadUsingGET	GET /license/reload	重载license信息
DubheReportApi.LoginControllerApi	refreshTokenUsingPOST	POST /rest/login/refresh/token	登录接口
DubheReportApi.MonitorStatusDemoControllerApi	fetchMonitorStatusPageSqlUsingGET	GET /rest/test/fetchMonitorStatusPageSql	测试fetch分页sql
DubheReportApi.MonitorStatusDemoControllerApi	fetchMonitorStatusPageUsingGET	GET /rest/test/fetchMonitorStatusPage	测试fetch分页nosql
DubheReportApi.MonitorStatusDemoControllerApi	fetchMonitorStatusUsingGET	GET /rest/test/fetchMonitorStatus	测试fetch
DubheReportApi.RecordControllerApi	fetchListRecords	GET /rest/record/fetchListRecords	获取操作记录全部信息
DubheReportApi.ReportControllerApi	addExposeReportUsingPOST	POST /rest/cases/exposeReport	addExposeReport
DubheReportApi.ReportControllerApi	addGatherReportUsingPOST	POST /rest/cases/gatherReport	addGatherReport
DubheReportApi.ReportControllerApi	addReportUsingPOST	POST /rest/cases/report	addReport
DubheReportApi.ReportControllerApi	cancelReportUsingPOST	POST /rest/cases/cancelReport	cancelReport
DubheReportApi.ReportControllerApi	deleteGatherReportUsingPOST	POST /rest/cases/deleteGatherReport	deleteGatherReport
DubheReportApi.ReportControllerApi	deleteReportUsingPOST	POST /rest/cases/deleteReport	deleteReport
DubheReportApi.ReportControllerApi	listExposeReportsUsingGET	GET /rest/cases/exposeReports	listExposeReports
DubheReportApi.ReportControllerApi	listGatherReportsRangeUsingGET	GET /rest/cases/gatherReports/range	listGatherReportsRange
DubheReportApi.ReportControllerApi	listGatherReportsUsingGET	GET /rest/cases/gatherReports	listGatherReports
DubheReportApi.ReportControllerApi	listReportsUsingGET	GET /rest/cases/reports	listReports
DubheReportApi.ReportControllerApi	recallReportUsingPOST	POST /rest/cases/recallReport	recallReport
DubheReportApi.ReportControllerApi	reportReportUsingPOST	POST /rest/cases/reportReport	reportReport
DubheReportApi.ReportControllerApi	submitReportUsingPOST	POST /rest/cases/submit	submitReport
DubheReportApi.SystemConfigControllerApi	fetchAllItemSettingUsingGET	GET /rest/systemConfig/fetchAllItemSetting	获取全部配置项设置值
DubheReportApi.SystemConfigControllerApi	fetchConfigByGroupCodeUsingGET	GET /rest/systemConfig/fetchConfigByGroupCode/{groupCode}	获取配置组信息
DubheReportApi.SystemConfigControllerApi	fetchItemSettingByItemCodeUsingGET	GET /rest/systemConfig/fetchItemSettingByItemCode/{itemCode}	获取配置项设置值
DubheReportApi.SystemConfigControllerApi	updateConfigByGroupSettingUsingPUT	PUT /rest/systemConfig/updateSystemConfigGroupSetting	保存组配置信息
DubheReportApi.SystemConfigControllerApi	updateDisableSystemConfigUsingPUT	PUT /rest/systemConfig/updateDisableSystemConfig/{itemCode}	禁用配置项
DubheReportApi.SystemConfigControllerApi	updateEnableSystemConfigUsingPUT	PUT /rest/systemConfig/updateEnableSystemConfig/{itemCode}	启用配置项
DubheReportApi.SystemConfigControllerApi	updateSystemConfigSettingUsingPUT	PUT /rest/systemConfig/updateSystemConfigItemSetting	保存项配置信息
DubheReportApi.UserControllerApi	all	GET /rest/user/all	获取当前用户信息
DubheReportApi.UserControllerApi	current	POST /rest/user/current	获取当前用户信息
DubheReportApi.UserControllerApi	currentDetail	GET /rest/user/currentDetail	获取当前用户信息
DubheReportApi.XhlReportControllerApi	addXhl	POST /rest/xhl/add	保存报卡
DubheReportApi.XhlReportControllerApi	addXhlMulti	POST /rest/xhl/addMulti/{immediately}	保存报卡
DubheReportApi.XhlReportControllerApi	detailXhl	GET /rest/xhl/detail/{id}	获取现换率请求详情
DubheReportApi.XhlReportControllerApi	listXhl	GET /rest/xhl/list	获取现换率全部上报请求
DubheReportApi.XhlReportControllerApi	removeXhl	DELETE /rest/xhl/delete/{id}	撤销报卡
DubheReportApi.XhlReportControllerApi	reportXhl	POST /rest/xhl/report/{id}	上报现换率

Documentation for Models

• DubheReportApi.AuthResponse
• DubheReportApi.CdcReportReq
• DubheReportApi.CdcReportRes
• DubheReportApi.ExposeInfo
• DubheReportApi.GatherInfo
• DubheReportApi.IUser
• DubheReportApi.LicenseInfo
• DubheReportApi.Record
• DubheReportApi.ReportBodyReq
• DubheReportApi.ReportBodyRes
• DubheReportApi.ReportReq
• DubheReportApi.ReportRes
• DubheReportApi.ResponseResultListExposeInfo
• DubheReportApi.ResponseResultListGatherInfo
• DubheReportApi.ResponseResultListReport
• DubheReportApi.ResponseResultstring
• DubheReportApi.SysGroupResource
• DubheReportApi.SysSystemConfig
• DubheReportApi.Users
• DubheReportApi.XhlGrqkReq
• DubheReportApi.XhlGrqkRes
• DubheReportApi.XhlReportReq
• DubheReportApi.XhlReportRes

Documentation for Authorization

All endpoints do not require authorization.