cheniniital v2.0.0
uaes_fota_platform
UaesFotaPlatform - JavaScript client for uaes_fota_platform https://fota.uaes.com.cn This SDK is automatically generated by the Swagger Codegen project:
- API version: version
- Package version: version
- 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 uaes_fota_platform --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 uaes_fota_platform from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('uaes_fota_platform')
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/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, 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 UaesFotaPlatform = require('uaes_fota_platform');
var api = new UaesFotaPlatform.DepartmentControllerApi()
var uuid = "uuid_example"; // {String} user uuid
var deptId = 789; // {Number} dept id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addDeptMemberUsingPUT(uuid, deptId, callback);
Documentation for API Endpoints
All URIs are relative to https://fota.uaescloud.com:444
Class | Method | HTTP request | Description |
---|---|---|---|
UaesFotaPlatform.DepartmentControllerApi | addDeptMemberUsingPUT | PUT /fota-iam/admin/addDeptMember | add dept member |
UaesFotaPlatform.DepartmentControllerApi | createUsingPOST | POST /fota-iam/admin/addDept | dept create |
UaesFotaPlatform.DepartmentControllerApi | deleteUsingDELETE | DELETE /fota-iam/admin/deleteDept | dept delete |
UaesFotaPlatform.DepartmentControllerApi | getDeptByIdUsingGET | GET /fota-iam/self/searchDeptById | search dept by dept id |
UaesFotaPlatform.DepartmentControllerApi | getDeptByNameUsingGET | GET /fota-iam/self/searchDeptByName | search dept by dept name |
UaesFotaPlatform.DepartmentControllerApi | searchDeptPageUsingGET | GET /fota-iam/self/searchDept/page | paging search dept |
UaesFotaPlatform.DepartmentControllerApi | searchMemberByDeptIdUsingGET | GET /fota-iam/self/searchMemberByDeptId | search member by dept id |
UaesFotaPlatform.DepartmentControllerApi | updateUsingPUT | PUT /fota-iam/admin/updateDept | dept update |
UaesFotaPlatform.TestControllerApi | adminUsingGET | GET /fota-iam/admin/hello | admin |
UaesFotaPlatform.TestControllerApi | appUsingGET | GET /fota-iam/app/hello | app |
UaesFotaPlatform.TestControllerApi | chainingUsingGET | GET /fota-iam/apiexception | chaining |
UaesFotaPlatform.TestControllerApi | engineerUsingGET | GET /fota-iam/engineer/hello | engineer |
UaesFotaPlatform.TestControllerApi | managerUsingGET | GET /fota-iam/manager/hello | manager |
UaesFotaPlatform.TestControllerApi | publicUserUsingGET | GET /fota-iam/public/hello | publicUser |
UaesFotaPlatform.TestControllerApi | selfUsingGET | GET /fota-iam/self/hello | self |
UaesFotaPlatform.TestControllerApi | viewUsingGET | GET /fota-iam/view/hello | view |
UaesFotaPlatform.UserAdminControllerApi | addRoleForUserUsingPUT | PUT /fota-iam/admin/user/admin/addRole | add user role info |
UaesFotaPlatform.UserAdminControllerApi | addUserUsingPOST | POST /fota-iam/admin/user/admin/addUser | add user |
UaesFotaPlatform.UserAdminControllerApi | deleteUserUsingDELETE | DELETE /fota-iam/admin/user/admin/deleteUser | delete user |
UaesFotaPlatform.UserAdminControllerApi | getAllUsersUsingGET | GET /fota-iam/admin/user/admin/getAllUsers | get all user info |
UaesFotaPlatform.UserAdminControllerApi | getUserByUserNameUsingGET | GET /fota-iam/admin/user/admin/getUserByName | get user info by user name |
UaesFotaPlatform.UserAdminControllerApi | getUserByUuidUsingGET | GET /fota-iam/admin/user/admin/getUserById | get user info by user id |
UaesFotaPlatform.UserAdminControllerApi | getUsersByDeptUsingGET | GET /fota-iam/admin/user/admin/searchUsersByDeptId | search members by dept id |
UaesFotaPlatform.UserAdminControllerApi | getUsersUsingGET | GET /fota-iam/admin/user/admin/searchUsersByName | search users by name |
UaesFotaPlatform.UserAdminControllerApi | passwordResetUsingGET | GET /fota-iam/admin/user/admin/passwordReset | password reset |
UaesFotaPlatform.UserAdminControllerApi | removeRoleForUserUsingPUT | PUT /fota-iam/admin/user/admin/removeRole | remove user role info |
UaesFotaPlatform.UserAdminControllerApi | setActiveUsingPUT | PUT /fota-iam/admin/user/admin/setActiveStatus | update user active |
UaesFotaPlatform.UserAdminControllerApi | updateUserUsingPUT | PUT /fota-iam/admin/user/admin/updateUser | update user |
UaesFotaPlatform.UserLoginControllerApi | loginUsingGET | GET /fota-iam/public/user/oauth/login | 登陆 |
UaesFotaPlatform.UserRoleAdminControllerApi | getRoleByNameUsingGET | GET /fota-iam/admin/role/admin/getRoleByName | get role by role name |
UaesFotaPlatform.UserRoleAdminControllerApi | getRoleByUuidUsingGET | GET /fota-iam/admin/role/admin/getRoleById | get role by role id |
UaesFotaPlatform.UserRoleAdminControllerApi | getRolesUsingGET | GET /fota-iam/admin/role/admin/getAllRoles | get all roles |
UaesFotaPlatform.UserSelfServiceControllerApi | changePasswordUsingPUT | PUT /fota-iam/self/passwordChange | change password |
UaesFotaPlatform.UserSelfServiceControllerApi | getUserByUserNameUsingGET1 | GET /fota-iam/self/getUserInfo | get user info |
UaesFotaPlatform.UserSelfServiceControllerApi | refreshTokensUsingGET | GET /fota-iam/self/oauth/refreshTokens | refresh token |
Documentation for Models
- UaesFotaPlatform.AddUserInfo
- UaesFotaPlatform.AddUserRsp
- UaesFotaPlatform.DeptCreatRsp
- UaesFotaPlatform.DeptCreate
- UaesFotaPlatform.DeptSearchInfo
- UaesFotaPlatform.DeptSearchSimpleInfo
- UaesFotaPlatform.IPagedeptSearchSimpleInfo
- UaesFotaPlatform.ReturnData
- UaesFotaPlatform.ReturnDataListroleInfo
- UaesFotaPlatform.ReturnDataListuserInfo
- UaesFotaPlatform.ReturnDataListuserSimpleInfo
- UaesFotaPlatform.ReturnDataaddUserRsp
- UaesFotaPlatform.ReturnDatadeptCreatRsp
- UaesFotaPlatform.ReturnDatadeptSearchInfo
- UaesFotaPlatform.ReturnDataroleInfo
- UaesFotaPlatform.ReturnDatauserInfo
- UaesFotaPlatform.RoleInfo
- UaesFotaPlatform.Token
- UaesFotaPlatform.UserInfo
- UaesFotaPlatform.UserSimpleInfo
- UaesFotaPlatform.UserUpdate
Documentation for Authorization
All endpoints do not require authorization.
5 years ago