❤
npm
Sign UpSign In

zx-api

0.0.1 • Public • Published

api

Api - JavaScript client for api 织信开放API接口 This SDK is automatically generated by the Swagger Codegen project:

  • API version: v2
  • Package version: v2
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://www.informat.cn/

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

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 Api = require('api');
var defaultClient = Api.ApiClient.instance;


var api = new Api.AdminApi()
var body = new Api.AdminCompanyMemberBatchDeleteRequest(); // {AdminCompanyMemberBatchDeleteRequest} 
var opts = { 
  'oid': "oid_example", // {String} OID
  'companyId': "companyId_example", // {String} 团队ID
  'appId': "appId_example" // {String} 应用ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.adminAccountBatchDelete(body, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://uat.informat.cn/webapi

Class Method HTTP request Description
Api.AdminApi adminAccountBatchDelete POST /v2/admin_account/batch_delete 从团队批量移除成员
Api.AdminApi adminAccountCreate POST /v2/admin_account/create 创建用户
Api.AdminApi adminAccountDelete POST /v2/admin_account/delete 删除用户
Api.AdminApi adminAccountGet POST /v2/admin_account/get 查询用户信息
Api.AdminApi adminAccountJoinCompany POST /v2/admin_account/join_company 指定用户加入指定团队
Api.AdminApi adminAccountList POST /v2/admin_account/list 获取用户列表
Api.AdminApi adminAccountPassword POST /v2/admin_account/password 更改指定用户的密码
Api.AdminApi adminAccountUpdate POST /v2/admin_account/update 更改用户信息
Api.AdminApi adminAppTemplateDelete POST /v2/admin_app_template/delete 删除应用模板
Api.AdminApi adminAppTemplateGet POST /v2/admin_app_template/get 根据id获取应用模板
Api.AdminApi adminAppTemplateImport POST /v2/admin_app_template/import 导入应用模板
Api.AdminApi adminAppTemplateList POST /v2/admin_app_template/list 获取应用模板列表
Api.AdminApi adminAppTemplateUpdate POST /v2/admin_app_template/update 更新应用模板
Api.AdminApi adminCompanyDelete POST /v2/admin_company/delete 删除团队
Api.AdminApi adminCompanyGet POST /v2/admin_company/get 根据ID获取团队
Api.AdminApi adminCompanyList POST /v2/admin_company/list 获取团队列表
Api.AdminApi adminCompanyPro POST /v2/admin_company/pro 设置团队版本为专业版
Api.AdminApi adminConfigList POST /v2/admin_config/list 查询配置列表
Api.AdminApi adminConfigUpdate POST /v2/admin_config/update 更新配置信息
Api.AdminApi adminImportLicense POST /v2/admin/import_license 导入许可证
Api.AdminApi adminImportSubLicense POST /v2/admin/import_sub_license 导入子许可证
Api.AdminApi adminRefreshToken POST /v2/admin/refresh_token 刷新adminToken
Api.AdminApi adminToken POST /v2/admin/token 获取adminToken
Api.AdminApi adminVersion POST /v2/admin/version 系统版本号
Api.AppApi appAuth POST /v2/app/auth 应用鉴权
Api.AppApi appDelete POST /v2/app/delete 删除应用
Api.AppApi appImport POST /v2/app/import 通过ima文件安装应用
Api.AppApi appInstallTemplate POST /v2/app/install_template 通过应用模板安装应用
Api.AppApi appList POST /v2/app/list 应用列表
Api.AppApi appMemberCreate POST /v2/app_member/create 创建应用成员
Api.AppApi appMemberDelete POST /v2/app_member/delete 从应用移除成员
Api.AppApi appMemberGet POST /v2/app_member/get 查询应用成员
Api.AppApi appMemberList POST /v2/app_member/list 获取成员列表
Api.AppApi appMemberRoleCreate POST /v2/app_member_role/create 创建应用角色
Api.AppApi appMemberRoleDelete POST /v2/app_member_role/delete 删除应用角色
Api.AppApi appMemberRoleGet POST /v2/app_member_role/get 获取应用角色
Api.AppApi appMemberRoleList POST /v2/app_member_role/list 获取应用角色列表
Api.AppApi appMemberRoleUpdate POST /v2/app_member_role/update 更新应用角色
Api.AppApi appMemberUpdate POST /v2/app_member/update 更新应用成员
Api.AppApi appModuleGet POST /v2/app_module/get 应用模块查询
Api.AppApi appModuleList POST /v2/app_module/list 应用模块列表
Api.AppApi appRefreshToken POST /v2/app/refresh_token 刷新应用accessToken
Api.AppApi appScriptCreate POST /v2/app_script/create 创建脚本
Api.AppApi appScriptDelete POST /v2/app_script/delete 删除脚本
Api.AppApi appScriptList POST /v2/app_script/list 查询脚本列表
Api.AppApi appScriptLoad POST /v2/app_script/load 装载脚本
Api.AppApi appScriptUpdate POST /v2/app_script/update 编辑脚本
Api.AppApi appToken POST /v2/app/token 获取应用accessToken
Api.AppApi appVersion POST /v2/app/version 系统版本号
Api.AppApi tableGet POST /v2/table/get 查询数据表
Api.AppApi tableList POST /v2/table/list 数据表列表
Api.AppApi tableRecordBatchCreate POST /v2/table_record/batch_create 批量创建数据表记录
Api.AppApi tableRecordBatchDelete POST /v2/table_record/batch_delete 批量删除数据表记录
Api.AppApi tableRecordBatchUpdate POST /v2/table_record/batch_update 批量编辑数据表记录
Api.AppApi tableRecordCreate POST /v2/table_record/create 创建数据表记录
Api.AppApi tableRecordDelete POST /v2/table_record/delete 删除数据表记录
Api.AppApi tableRecordList POST /v2/table_record/list 查询数据表记录列表
Api.AppApi tableRecordUpdate POST /v2/table_record/update 编辑数据表记录
Api.AppApi tableWorkflowChartGet POST /v2/table_workflow_chart/get 通过id查询审批流程图详情
Api.AppApi tableWorkflowChartList POST /v2/table_workflow_chart/list 查询审批流程图列表
Api.AppApi tableWorkflowGet POST /v2/table_workflow/get 通过id查询审批流程详情
Api.AppApi tableWorkflowInstanceCancel POST /v2/table_workflow_instance/cancel 取消审批流程
Api.AppApi tableWorkflowInstanceCreate POST /v2/table_workflow_instance/create 发起审批流程
Api.AppApi tableWorkflowInstanceGet POST /v2/table_workflow_instance/get 通过ID查询审批流程实例详情
Api.AppApi tableWorkflowInstanceList POST /v2/table_workflow_instance/list 查询审批流程实例列表
Api.AppApi tableWorkflowInstanceNodeGet POST /v2/table_workflow_instance_node/get 通过ID查询审批流程实例节点详情
Api.AppApi tableWorkflowInstanceNodeList POST /v2/table_workflow_instance_node/list 查询审批流程实例节点列表
Api.AppApi tableWorkflowInstanceNodeOwnerAgree POST /v2/table_workflow_instance_node_owner/agree 同意审批流程
Api.AppApi tableWorkflowInstanceNodeOwnerGet POST /v2/table_workflow_instance_node_owner/get 通过ID查询审批流程实例节点审批人
Api.AppApi tableWorkflowInstanceNodeOwnerList POST /v2/table_workflow_instance_node_owner/list 查询审批流程实例节点审批人列表
Api.AppApi tableWorkflowInstanceNodeOwnerRefuse POST /v2/table_workflow_instance_node_owner/refuse 拒绝审批流程
Api.AppApi tableWorkflowInstanceNodeOwnerRollback POST /v2/table_workflow_instance_node_owner/rollback 回退审批流程
Api.AppApi tableWorkflowInstanceNodeOwnerTransfer POST /v2/table_workflow_instance_node_owner/transfer 转交审批流程
Api.AppApi tableWorkflowInstanceSetOwner POST /v2/table_workflow_instance/set_owner 设置审批人
Api.AppApi tableWorkflowList POST /v2/table_workflow/list 查询审批流程列表
Api.AppApi websiteMaterialCreate POST /v2/website_material/create 创建网站模块素材
Api.AppApi websiteMaterialDelete POST /v2/website_material/delete 删除网站模块素材
Api.AppApi websiteMaterialList POST /v2/website_material/list 查询网站模块素材列表
Api.AppApi websiteMaterialUpdate POST /v2/website_material/update 更新网站模块素材
Api.AppApi websitePageCreate POST /v2/website_page/create 创建网站模块页面
Api.AppApi websitePageDelete POST /v2/website_page/delete 删除网站模块页面
Api.AppApi websitePageGet POST /v2/website_page/get 通过ID查询网站模板页面
Api.AppApi websitePageList POST /v2/website_page/list 查询网站模板页面列表
Api.AppApi websitePagePublish POST /v2/website_page/publish 发布网站模块页面
Api.AppApi websitePageUpdate POST /v2/website_page/update 编辑网站模块页面
Api.CompanyApi companyDepartmentCreate POST /v2/company_department/create 创建部门
Api.CompanyApi companyDepartmentDelete POST /v2/company_department/delete 删除部门
Api.CompanyApi companyDepartmentList POST /v2/company_department/list 获取部门列表
Api.CompanyApi companyDepartmentUpdate POST /v2/company_department/update 更新部门
Api.CompanyApi companyGet POST /v2/company/get 获取当前团队信息
Api.CompanyApi companyMemberBatchDelete POST /v2/company_member/batch_delete 从团队批量移除成员
Api.CompanyApi companyMemberGet POST /v2/company_member/get 根据token查询用户信息
Api.CompanyApi companyMemberList POST /v2/company_member/list 获取成员列表
Api.CompanyApi companyMemberRoleCreate POST /v2/company_member_role/create 创建角色
Api.CompanyApi companyMemberRoleDelete POST /v2/company_member_role/delete 删除角色
Api.CompanyApi companyMemberRoleList POST /v2/company_member_role/list 获取角色列表
Api.CompanyApi companyMemberRoleUpdate POST /v2/company_member_role/update 更新角色
Api.CompanyApi companyMemberUpdate POST /v2/company_member/update 更新成员信息
Api.CompanyApi companyRefreshToken POST /v2/company/refresh_token 刷新团队token
Api.CompanyApi companyToken POST /v2/company/token 获取团队token
Api.CompanyApi companyUpdateLogo POST /v2/company/update_logo 修改团队logo

Documentation for Models

Documentation for Authorization

accessToken

Readme

Keywords

none

Package Sidebar

Install

npm i zx-api

Weekly Downloads

3

Version

0.0.1

License

MIT

Unpacked Size

2.17 MB

Total Files

755

Last publish

Collaborators

  • minilize
Try on RunKit
Report malware