You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ce/docs/AdminControllerApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@
12
12
|[**getFeaturesInfo**](#getFeaturesInfo)|**GET** /api/admin/featuresInfo | Get features info (getFeaturesInfo) |
13
13
|[**getJwtSettings**](#getJwtSettings)|**GET** /api/admin/jwtSettings | Get the JWT Settings object (getJwtSettings) |
14
14
|[**getMailOAuth2AuthorizationUrl**](#getMailOAuth2AuthorizationUrl)|**GET** /api/admin/mail/oauth2/authorize | Redirect user to mail provider login page. |
15
-
|[**getMailOAuth2RedirectUri**](#getMailOAuth2RedirectUri)|**GET** /api/admin/mail/oauth2/loginProcessingUrl | Get OAuth2 log in processing URL (getMailOAuth2RedirectUri) |
15
+
|[**getMailProcessingUrl**](#getMailProcessingUrl)|**GET** /api/admin/mail/oauth2/loginProcessingUrl | Get OAuth2 log in processing URL (getMailProcessingUrl) |
16
16
|[**getRepositorySettings**](#getRepositorySettings)|**GET** /api/admin/repositorySettings | Get repository settings (getRepositorySettings) |
|[**getSecuritySettings**](#getSecuritySettings)|**GET** /api/admin/securitySettings | Get the Security Settings object (getSecuritySettings) |
@@ -173,11 +173,11 @@ After user logged in and provided accessprovider sends authorization code to spe
173
173
**String**
174
174
175
175
176
-
## getMailOAuth2RedirectUri
176
+
## getMailProcessingUrl
177
177
178
-
> String getMailOAuth2RedirectUri()
178
+
> String getMailProcessingUrl()
179
179
180
-
Get OAuth2 log in processing URL (getMailOAuth2RedirectUri)
180
+
Get OAuth2 log in processing URL (getMailProcessingUrl)
181
181
182
182
Returns the URL enclosed in double quotes. After successful authentication with OAuth2 provider and user consent for requested scope, it makes a redirect to this path so that the platform can do further log in processing and generating access tokens. Available for users with 'SYS_ADMIN' authority.
|[**deleteRelations**](#deleteRelations)|**DELETE** /api/relations | Delete common relations (deleteCommonRelations) |
7
+
|[**deleteRelations**](#deleteRelations)|**DELETE** /api/relations | Delete common relations (deleteRelations) |
8
8
|[**findEntityRelationInfosByFrom**](#findEntityRelationInfosByFrom)|**GET** /api/relations/info/from/{fromType}/{fromId} | Get List of Relation Infos (findEntityRelationInfosByFrom) |
9
9
|[**findEntityRelationInfosByQuery**](#findEntityRelationInfosByQuery)|**POST** /api/relations/info | Find related entity infos (findEntityRelationInfosByQuery) |
10
10
|[**findEntityRelationInfosByTo**](#findEntityRelationInfosByTo)|**GET** /api/relations/info/to/{toType}/{toId} | Get List of Relation Infos (findEntityRelationInfosByTo) |
@@ -73,7 +73,7 @@ Deletes a relation between two entities in the platform. If the user has the a
73
73
74
74
> deleteRelations(entityId, entityType)
75
75
76
-
Delete common relations (deleteCommonRelations)
76
+
Delete common relations (deleteRelations)
77
77
78
78
Deletes all the relations ('from' and 'to' direction) for the specified entity and relation type group: 'COMMON'. If the user has the authority of 'System Administrator', the server checks that the entity is owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that the entity is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the entity is assigned to the same customer.
|[**getMobileAppDeepLink**](#getMobileAppDeepLink)|**GET** /api/mobile/qr/deepLink | Get the deep link to the associated mobile application (getMobileAppDeepLink) |
7
-
|[**getQrCodeSettings**](#getQrCodeSettings)|**GET** /api/mobile/qr/settings | Get Mobile application settings (getMobileAppSettings) |
7
+
|[**getQrCodeSettings**](#getQrCodeSettings)|**GET** /api/mobile/qr/settings | Get Mobile application settings (getQrCodeSettings) |
8
8
|[**getUserTokenByMobileSecret**](#getUserTokenByMobileSecret)|**GET** /api/noauth/qr/{secret} | Get User Token (getUserTokenByMobileSecret) |
9
9
|[**saveQrCodeSettings**](#saveQrCodeSettings)|**POST** /api/mobile/qr/settings | Create Or Update the Mobile application settings (saveMobileAppSettings) |
10
10
@@ -45,7 +45,7 @@ Fetch the url that takes user to linked mobile application Available for any a
45
45
46
46
> QrCodeSettings getQrCodeSettings()
47
47
48
-
Get Mobile application settings (getMobileAppSettings)
48
+
Get Mobile application settings (getQrCodeSettings)
49
49
50
50
The response payload contains configuration for android/iOS applications and platform qr code widget settings. Available for any authorized user.
|[**getLwm2mListObjects**](#getLwm2mListObjects)|**GET** /api/resource/lwm2m | Get LwM2M Objects (getLwm2mListObjects) |
13
13
|[**getLwm2mListObjectsPage**](#getLwm2mListObjectsPage)|**GET** /api/resource/lwm2m/page | Get LwM2M Objects (getLwm2mListObjectsPage) |
14
14
|[**getResourceById**](#getResourceById)|**GET** /api/resource/{resourceId} | Get Resource (getResourceById) |
15
15
|[**getResourceInfo**](#getResourceInfo)|**GET** /api/resource/{resourceType}/{scope}/{key}/info | Get resource info (getResourceInfo) |
16
16
|[**getResourceInfoById**](#getResourceInfoById)|**GET** /api/resource/info/{resourceId} | Get Resource Info (getResourceInfoById) |
17
17
|[**getResources**](#getResources)|**GET** /api/resource | Get Resource Infos (getResources) |
18
18
|[**getSystemOrTenantResourcesByIds**](#getSystemOrTenantResourcesByIds)|**GET** /api/resource/list | Get Resource Infos by ids (getSystemOrTenantResourcesByIds) |
19
-
|[**getTenantResources**](#getTenantResources)|**GET** /api/resource/tenant | Get All Resource Infos (getAllResources) |
19
+
|[**getTenantResources**](#getTenantResources)|**GET** /api/resource/tenant | Get All Resource Infos (getTenantResources) |
20
20
|[**saveResource**](#saveResource)|**POST** /api/resource | Create Or Update Resource (saveResource) |
Returns a page of Resource Info objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Resource Info is a lightweight object that includes main information about the Resource excluding the heavyweight data. Available for users with 'TENANT_ADMIN' authority.
Copy file name to clipboardExpand all lines: ce/docs/UserControllerApi.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,19 @@
9
9
|[**getActivationLink**](#getActivationLink)|**GET** /api/user/{userId}/activationLink | Get activation link (getActivationLink) |
10
10
|[**getActivationLinkInfo**](#getActivationLinkInfo)|**GET** /api/user/{userId}/activationLinkInfo | Get activation link info (getActivationLinkInfo) |
11
11
|[**getCustomerUsers**](#getCustomerUsers)|**GET** /api/customer/{customerId}/users | Get Customer Users (getCustomerUsers) |
12
-
|[**getGeneralUserSettings**](#getGeneralUserSettings)|**GET** /api/user/settings/general | Get user settings (getUserSettings) |
12
+
|[**getGeneralUserSettings**](#getGeneralUserSettings)|**GET** /api/user/settings/general | Get user settings (getGeneralUserSettings) |
|[**getTenantAdmins**](#getTenantAdmins)|**GET** /api/tenant/{tenantId}/users | Get Tenant Users (getTenantAdmins) |
15
15
|[**getUserById**](#getUserById)|**GET** /api/user/{userId} | Get User (getUserById) |
16
-
|[**getUserDashboardsInfo**](#getUserDashboardsInfo)|**GET** /api/user/dashboards | Get information about last visited and starred dashboards (getLastVisitedDashboards) |
16
+
|[**getUserDashboardsInfo**](#getUserDashboardsInfo)|**GET** /api/user/dashboards | Get information about last visited and starred dashboards (getUserDashboardsInfo) |
17
17
|[**getUserSettings**](#getUserSettings)|**GET** /api/user/settings/{type} | Get user settings (getUserSettings) |
18
18
|[**getUserToken**](#getUserToken)|**GET** /api/user/{userId}/token | Get User Token (getUserToken) |
19
19
|[**getUsers**](#getUsers)|**GET** /api/users | Get Users (getUsers) |
20
20
|[**getUsersByIds**](#getUsersByIds)|**GET** /api/users/list | Get Users By Ids (getUsersByIds) |
21
21
|[**getUsersForAssign**](#getUsersForAssign)|**GET** /api/users/assign/{alarmId} | Get usersForAssign (getUsersForAssign) |
|[**reportUserDashboardAction**](#reportUserDashboardAction)|**GET** /api/user/dashboards/{dashboardId}/{action} | Report action of User over the dashboard (reportUserDashboardAction) |
@@ -262,7 +262,7 @@ Fetch the User object based on the provided User Id. If the user has the authori
262
262
263
263
> UserDashboardsInfo getUserDashboardsInfo()
264
264
265
-
Get information about last visited and starred dashboards (getLastVisitedDashboards)
265
+
Get information about last visited and starred dashboards (getUserDashboardsInfo)
266
266
267
267
Fetch the list of last visited and starred dashboards. Both lists are limited to 10 items. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
268
268
@@ -397,7 +397,7 @@ Checks that the system is configured to allow administrators to impersonate them
397
397
398
398
> putGeneralUserSettings(body)
399
399
400
-
Update user settings (saveUserSettings)
400
+
Update user settings (putGeneralUserSettings)
401
401
402
402
Update user settings for authorized user. Only specified json elements will be updated.Example: you have such settings: {A:5, B:{C:10, D:20}}. Updating it with {B:{C:10, D:30}} will result in{A:5, B:{C:10, D:30}}. The same could be achieved by putting {B.D:30}
403
403
@@ -417,7 +417,7 @@ null (empty response body)
417
417
418
418
> putUserSettings(type, body)
419
419
420
-
Update user settings (saveUserSettings)
420
+
Update user settings (putUserSettings)
421
421
422
422
Update user settings for authorized user. Only specified json elements will be updated.Example: you have such settings: {A:5, B:{C:10, D:20}}. Updating it with {B:{C:10, D:30}} will result in{A:5, B:{C:10, D:30}}. The same could be achieved by putting {B.D:30}
0 commit comments