public class AppClient
extends Object
Modifier and Type | Method and Description |
---|---|
AddAppResponseBody |
addApp(AddAppRequest request)
Creates a preview App.
|
long |
addApp(String name)
Creates a preview App.
|
long |
addApp(String name,
Long spaceId,
Long threadId)
Creates a preview App.
|
AddFormFieldsResponseBody |
addFormFields(AddFormFieldsRequest request)
Adds fields to a form of an App.
|
long |
addFormFields(long app,
List<FieldProperty> properties)
Adds fields to a form of an App.
|
long |
addFormFields(long app,
List<FieldProperty> properties,
Long revision)
Adds fields to a form of an App.
|
long |
addFormFields(long app,
Map<String,FieldProperty> properties)
Adds fields to a form of an App.
|
long |
addFormFields(long app,
Map<String,FieldProperty> properties,
Long revision)
Adds fields to a form of an App.
|
AddAppPluginsResponseBody |
addPlugins(AddAppPluginsRequest request)
Adds Plug-ins to an App.
|
long |
addPlugins(long app,
List<String> ids)
Adds Plug-ins to an App.
|
DeleteFormFieldsResponseBody |
deleteFormFields(DeleteFormFieldsRequest request)
Deletes fields from a form of an App.
|
long |
deleteFormFields(long app,
List<String> fields)
Deletes fields from a form of an App.
|
long |
deleteFormFields(long app,
List<String> fields,
Long revision)
Deletes fields from a form of an App.
|
DeployAppResponseBody |
deployApp(DeployAppRequest request)
Updates the settings of a pre-live App to the live App.
|
void |
deployApp(long app)
Updates the settings of a pre-live App to the live App.
|
void |
deployApp(long app,
Long revision)
Updates the settings of a pre-live App to the live App.
|
EvaluateRecordAclResponseBody |
evaluateRecordAcl(EvaluateRecordAclRequest request)
Evaluates the API user's permissions for records and fields within an App.
|
List<EvaluatedRecordRight> |
evaluateRecordAcl(long app,
List<Long> recordIds)
Evaluates the API user's permissions for records and fields within an App.
|
EvaluatedRecordRight |
evaluateRecordAcl(long app,
long recordId)
Evaluates the API user's permissions for records and fields within an App.
|
GetAdminNotesResponseBody |
getAdminNotes(GetAdminNotesRequest request)
Gets notes for app administrators and their settings.
|
GetAdminNotesResponseBody |
getAdminNotes(long app)
Gets notes for app administrators and their settings.
|
GetAdminNotesPreviewResponseBody |
getAdminNotesPreview(GetAdminNotesPreviewRequest request)
Gets notes for app administrators and their settings.
|
GetAdminNotesPreviewResponseBody |
getAdminNotesPreview(long app)
Gets notes for app administrators and their settings.
|
GetAppResponseBody |
getApp(GetAppRequest request)
Gets general information of an App, including the name, description, related Space, creator and
updater information.
|
App |
getApp(long id)
Gets general information of an App, including the name, description, related Space, creator and
updater information.
|
GetAppAclResponseBody |
getAppAcl(GetAppAclRequest request)
Gets the App permissions of an app.
|
List<AppRightEntity> |
getAppAcl(long app)
Gets the App permissions of an app.
|
GetAppAclPreviewResponseBody |
getAppAclPreview(GetAppAclPreviewRequest request)
Gets the App permissions of an app.
|
List<AppRightEntity> |
getAppAclPreview(long app)
Gets the App permissions of an app.
|
GetAppActionsResponseBody |
getAppActions(GetAppActionsRequest request)
Gets the Action settings of the App.
|
Map<String,AppAction> |
getAppActions(long app)
Gets the Action settings of the App.
|
Map<String,AppAction> |
getAppActions(long app,
String lang)
Gets the Action settings of the App.
|
GetAppActionsPreviewResponseBody |
getAppActionsPreview(GetAppActionsPreviewRequest request)
Gets the Action settings of the App.
|
Map<String,AppAction> |
getAppActionsPreview(long app)
Gets the Action settings of the App.
|
Map<String,AppAction> |
getAppActionsPreview(long app,
String lang)
Gets the Action settings of the App.
|
GetAppCustomizeResponseBody |
getAppCustomize(GetAppCustomizeRequest request)
Gets the JavaScript and CSS customization settings of an App.
|
GetAppCustomizeResponseBody |
getAppCustomize(long app)
Gets the JavaScript and CSS customization settings of an App.
|
GetAppCustomizePreviewResponseBody |
getAppCustomizePreview(GetAppCustomizePreviewRequest request)
Gets the JavaScript and CSS customization settings of an App.
|
GetAppCustomizePreviewResponseBody |
getAppCustomizePreview(long app)
Gets the JavaScript and CSS customization settings of an App.
|
GetAppsResponseBody |
getApps(GetAppsRequest request)
Gets general information of multiple Apps, including the name, description, related Space,
creator and updater information.
|
List<App> |
getAppsByCodes(List<String> codes)
Gets general information of multiple Apps by specifying the App codes.
|
List<App> |
getAppsByIds(List<Long> ids)
Gets general information of multiple Apps by specifying the App IDs.
|
GetAppSettingsResponseBody |
getAppSettings(GetAppSettingsRequest request)
Gets the description, name, icon, revision and color theme of an App.
|
GetAppSettingsResponseBody |
getAppSettings(long app)
Gets the description, name, icon, revision and color theme of an App.
|
GetAppSettingsResponseBody |
getAppSettings(long app,
String lang)
Gets the description, name, icon, revision and color theme of an App.
|
GetAppSettingsPreviewResponseBody |
getAppSettingsPreview(GetAppSettingsPreviewRequest request)
Gets the description, name, icon, revision and color theme of an App.
|
GetAppSettingsPreviewResponseBody |
getAppSettingsPreview(long app)
Gets the description, name, icon, revision and color theme of an App.
|
GetAppSettingsPreviewResponseBody |
getAppSettingsPreview(long app,
String lang)
Gets the description, name, icon, revision and color theme of an App.
|
GetDeployStatusResponseBody |
getDeployStatus(GetDeployStatusRequest request)
Gets the deployment status of the App settings for multiple Apps.
|
DeployStatus |
getDeployStatus(long app)
Gets the deployment status of the App settings for multiple Apps.
|
GetFieldAclResponseBody |
getFieldAcl(GetFieldAclRequest request)
Gets the Field permission settings of an App.
|
List<FieldRight> |
getFieldAcl(long app)
Gets the Field permission settings of an App.
|
GetFieldAclPreviewResponseBody |
getFieldAclPreview(GetFieldAclPreviewRequest request)
Gets the Field permission settings of an App.
|
List<FieldRight> |
getFieldAclPreview(long app)
Gets the Field permission settings of an App.
|
GetFormFieldsResponseBody |
getFormFields(GetFormFieldsRequest request)
Gets the field settings of an App.
|
Map<String,FieldProperty> |
getFormFields(long app)
Gets the field settings of an App.
|
Map<String,FieldProperty> |
getFormFields(long app,
String lang)
Gets the field settings of an App.
|
GetFormFieldsPreviewResponseBody |
getFormFieldsPreview(GetFormFieldsPreviewRequest request)
Gets the field settings of an App.
|
Map<String,FieldProperty> |
getFormFieldsPreview(long app)
Gets the field settings of an App.
|
Map<String,FieldProperty> |
getFormFieldsPreview(long app,
String lang)
Gets the field settings of an App.
|
GetFormLayoutResponseBody |
getFormLayout(GetFormLayoutRequest request)
Gets the field layout info of a form in an App.
|
List<Layout> |
getFormLayout(long app)
Gets the field layout info of a form in an App.
|
GetFormLayoutPreviewResponseBody |
getFormLayoutPreview(GetFormLayoutPreviewRequest request)
Gets the field layout info of a form in an App.
|
List<Layout> |
getFormLayoutPreview(long app)
Gets the field layout info of a form in an App.
|
GetGeneralNotificationsResponseBody |
getGeneralNotifications(GetGeneralNotificationsRequest request)
Gets the general notification settings of an App.
|
GetGeneralNotificationsResponseBody |
getGeneralNotifications(long app)
Gets the general notification settings of an App.
|
GetGeneralNotificationsPreviewResponseBody |
getGeneralNotificationsPreview(GetGeneralNotificationsPreviewRequest request)
Gets the general notification settings of an App.
|
GetGeneralNotificationsPreviewResponseBody |
getGeneralNotificationsPreview(long app)
Gets the general notification settings of an App.
|
GetPerRecordNotificationsResponseBody |
getPerRecordNotifications(GetPerRecordNotificationsRequest request)
Gets the per record notification settings of an App.
|
GetPerRecordNotificationsResponseBody |
getPerRecordNotifications(long app)
Gets the per record notification settings of an App.
|
GetPerRecordNotificationsResponseBody |
getPerRecordNotifications(long app,
String lang)
Gets the per record notification settings of an App.
|
GetPerRecordNotificationsPreviewResponseBody |
getPerRecordNotificationsPreview(GetPerRecordNotificationsPreviewRequest request)
Gets the per record notification settings of an App.
|
GetPerRecordNotificationsPreviewResponseBody |
getPerRecordNotificationsPreview(long app)
Gets the per record notification settings of an App.
|
GetPerRecordNotificationsPreviewResponseBody |
getPerRecordNotificationsPreview(long app,
String lang)
Gets the per record notification settings of an App.
|
GetAppPluginsResponseBody |
getPlugins(GetAppPluginsRequest request)
Gets the list of Plug-ins added to an App.
|
List<AppPlugin> |
getPlugins(long app)
Gets the list of Plug-ins added to an App.
|
List<AppPlugin> |
getPlugins(long app,
String lang)
Gets the list of Plug-ins added to an App.
|
GetAppPluginsPreviewResponseBody |
getPluginsPreview(GetAppPluginsPreviewRequest request)
Gets the list of Plug-ins added to an App.
|
List<AppPlugin> |
getPluginsPreview(long app)
Gets the list of Plug-ins added to an App.
|
List<AppPlugin> |
getPluginsPreview(long app,
String lang)
Gets the list of Plug-ins added to an App.
|
GetProcessManagementResponseBody |
getProcessManagement(GetProcessManagementRequest request)
Gets the process management settings of an App.
|
GetProcessManagementResponseBody |
getProcessManagement(long app)
Gets the process management settings of an App.
|
GetProcessManagementResponseBody |
getProcessManagement(long app,
String lang)
Gets the process management settings of an App.
|
GetProcessManagementPreviewResponseBody |
getProcessManagementPreview(GetProcessManagementPreviewRequest request)
Gets the process management settings of an App.
|
GetProcessManagementPreviewResponseBody |
getProcessManagementPreview(long app)
Gets the process management settings of an App.
|
GetProcessManagementPreviewResponseBody |
getProcessManagementPreview(long app,
String lang)
Gets the process management settings of an App.
|
GetRecordAclResponseBody |
getRecordAcl(GetRecordAclRequest request)
Gets the record permission settings of an App.
|
List<RecordRight> |
getRecordAcl(long app)
Gets the record permission settings of an App.
|
List<RecordRight> |
getRecordAcl(long app,
String lang)
Gets the record permission settings of an App.
|
GetRecordAclPreviewResponseBody |
getRecordAclPreview(GetRecordAclPreviewRequest request)
Gets the Record permission settings of an App.
|
List<RecordRight> |
getRecordAclPreview(long app)
Gets the Record permission settings of an App.
|
List<RecordRight> |
getRecordAclPreview(long app,
String lang)
Gets the Record permission settings of an App.
|
GetReminderNotificationsResponseBody |
getReminderNotifications(GetReminderNotificationsRequest request)
Gets the reminder notification settings of an App.
|
GetReminderNotificationsResponseBody |
getReminderNotifications(long app)
Gets the reminder notification settings of an App.
|
GetReminderNotificationsResponseBody |
getReminderNotifications(long app,
String lang)
Gets the reminder notification settings of an App.
|
GetReminderNotificationsPreviewResponseBody |
getReminderNotificationsPreview(GetReminderNotificationsPreviewRequest request)
Gets the reminder notification settings of an App.
|
GetReminderNotificationsPreviewResponseBody |
getReminderNotificationsPreview(long app)
Gets the reminder notification settings of an App.
|
GetReminderNotificationsPreviewResponseBody |
getReminderNotificationsPreview(long app,
String lang)
Gets the reminder notification settings of an App.
|
GetReportsResponseBody |
getReports(GetReportsRequest request)
Gets the Graph settings of the App.
|
Map<String,Report> |
getReports(long app)
Gets the Graph settings of the App.
|
Map<String,Report> |
getReports(long app,
String lang)
Gets the Graph settings of the App.
|
GetReportsPreviewResponseBody |
getReportsPreview(GetReportsPreviewRequest request)
Gets the Graph settings of the App.
|
Map<String,Report> |
getReportsPreview(long app)
Gets the Graph settings of the App.
|
Map<String,Report> |
getReportsPreview(long app,
String lang)
Gets the Graph settings of the App.
|
GetViewsResponseBody |
getViews(GetViewsRequest request)
Gets the View settings of an App.
|
Map<String,View> |
getViews(long app)
Gets the View settings of an App.
|
Map<String,View> |
getViews(long app,
String lang)
Gets the View settings of an App.
|
GetViewsPreviewResponseBody |
getViewsPreview(GetViewsPreviewRequest request)
Gets the View settings of an App.
|
Map<String,View> |
getViewsPreview(long app)
Gets the View settings of an App.
|
Map<String,View> |
getViewsPreview(long app,
String lang)
Gets the View settings of an App.
|
void |
move(long app,
Long space)
Changes the Space to which an App belongs.
|
MoveAppResponseBody |
move(MoveAppRequest request)
Changes the Space to which an App belongs.
|
void |
revertApp(long app)
Cancel all changes made to the pre-live settings.
|
void |
revertApp(long app,
Long revision)
Cancel all changes made to the pre-live settings.
|
UpdateAdminNotesResponseBody |
updateAdminNotes(UpdateAdminNotesRequest request)
Updates the notes for App administrators and their settings.
|
long |
updateAppAcl(long app,
List<AppRightEntity> rights)
Updates the App permissions of an App.
|
long |
updateAppAcl(long app,
List<AppRightEntity> rights,
Long revision)
Updates the App permissions of an App.
|
UpdateAppAclResponseBody |
updateAppAcl(UpdateAppAclRequest request)
Updates the App permissions of an App.
|
Map<String,ActionId> |
updateAppActions(long app,
Map<String,AppAction> actions)
Updates the Action settings of the App.
|
Map<String,ActionId> |
updateAppActions(long app,
Map<String,AppAction> actions,
Long revision)
Updates the Action settings of the App.
|
UpdateAppActionsResponseBody |
updateAppActions(UpdateAppActionsRequest request)
Updates the Action settings of the App.
|
UpdateAppCustomizeResponseBody |
updateAppCustomize(UpdateAppCustomizeRequest request)
Updates the JavaScript and CSS customization settings of an App.
|
UpdateAppSettingsResponseBody |
updateAppSettings(UpdateAppSettingsRequest request)
Updates the description, name, icon, revision and color theme of an App.
|
long |
updateFieldAcl(long app,
List<FieldRight> rights)
Updates the Field permission settings of an App.
|
long |
updateFieldAcl(long app,
List<FieldRight> rights,
Long revision)
Updates the Field permission settings of an App.
|
UpdateFieldAclResponseBody |
updateFieldAcl(UpdateFieldAclRequest request)
Updates the Field permission settings of an App.
|
long |
updateFormFields(long app,
List<FieldProperty> properties)
Updates the field settings of fields in a form of an App.
|
long |
updateFormFields(long app,
List<FieldProperty> properties,
Long revision)
Updates the field settings of fields in a form of an App.
|
long |
updateFormFields(long app,
Map<String,FieldProperty> properties)
Updates the field settings of fields in a form of an App.
|
long |
updateFormFields(long app,
Map<String,FieldProperty> properties,
Long revision)
Updates the field settings of fields in a form of an App.
|
UpdateFormFieldsResponseBody |
updateFormFields(UpdateFormFieldsRequest request)
Updates the field settings of fields in a form of an App.
|
long |
updateFormLayout(long app,
List<Layout> layouts)
Updates the field layout info of a form in an App.
|
long |
updateFormLayout(long app,
List<Layout> layouts,
Long revision)
Updates the field layout info of a form in an App.
|
UpdateFormLayoutResponseBody |
updateFormLayout(UpdateFormLayoutRequest request)
Updates the field layout info of a form in an App.
|
UpdateGeneralNotificationsResponseBody |
updateGeneralNotifications(UpdateGeneralNotificationsRequest request)
Updates the general notification settings of an App.
|
UpdatePerRecordNotificationsResponseBody |
updatePerRecordNotifications(UpdatePerRecordNotificationsRequest request)
Updates the per record notification settings of an App.
|
UpdateProcessManagementResponseBody |
updateProcessManagement(UpdateProcessManagementRequest request)
Updates the process management settings of an App.
|
long |
updateRecordAcl(long app,
List<RecordRight> rights)
Updates the Record permission settings of an App.
|
long |
updateRecordAcl(long app,
List<RecordRight> rights,
Long revision)
Updates the Record permission settings of an App.
|
UpdateRecordAclResponseBody |
updateRecordAcl(UpdateRecordAclRequest request)
Updates the Record permission settings of an App.
|
UpdateReminderNotificationsResponseBody |
updateReminderNotifications(UpdateReminderNotificationsRequest request)
Updates the reminder notification settings of an App.
|
Map<String,ReportId> |
updateReports(long app,
Map<String,Report> reports)
Updates the Graph settings of an App.
|
Map<String,ReportId> |
updateReports(long app,
Map<String,Report> reports,
Long revision)
Updates the Graph settings of an App.
|
UpdateReportsResponseBody |
updateReports(UpdateReportsRequest request)
Updates the Graph settings of an App.
|
Map<String,ViewId> |
updateViews(long app,
Map<String,View> views)
Updates the View settings of an App.
|
Map<String,ViewId> |
updateViews(long app,
Map<String,View> views,
Long revision)
Updates the View settings of an App.
|
UpdateViewsResponseBody |
updateViews(UpdateViewsRequest request)
Updates the View settings of an App.
|
public long addApp(String name)
name
- the name of Apppublic long addApp(String name, Long spaceId, Long threadId)
name
- the name of AppspaceId
- the Space ID of where the App will be createdthreadId
- the Thread ID of the thread in the Space where the App will be createdpublic AddAppResponseBody addApp(AddAppRequest request)
request
- the request parameters. See AddAppRequest
AddAppResponseBody
public long addFormFields(long app, List<FieldProperty> properties)
app
- the App IDproperties
- A list of field settings to addedpublic long addFormFields(long app, List<FieldProperty> properties, Long revision)
app
- the App IDproperties
- A list of field settings to addedrevision
- the expected revision number of the App settingspublic long addFormFields(long app, Map<String,FieldProperty> properties)
app
- the App IDproperties
- an object with data of the field settingspublic long addFormFields(long app, Map<String,FieldProperty> properties, Long revision)
app
- the App IDproperties
- an object with data of the field settingsrevision
- the expected revision number of the App settingspublic AddFormFieldsResponseBody addFormFields(AddFormFieldsRequest request)
request
- the request parameters. See AddFormFieldsRequest
AddFormFieldsResponseBody
public long addPlugins(long app, List<String> ids)
app
- the App IDids
- the Plug-in IDs that will be added to the Apppublic AddAppPluginsResponseBody addPlugins(AddAppPluginsRequest request)
request
- the request parameters. See AddAppPluginsRequest
AddAppPluginsResponseBody
public long deleteFormFields(long app, List<String> fields)
app
- the App IDfields
- the list of field codes of the fields to deletepublic long deleteFormFields(long app, List<String> fields, Long revision)
app
- the App IDfields
- the list of field codes of the fields to deleterevision
- the expected revision number of the App settingspublic DeleteFormFieldsResponseBody deleteFormFields(DeleteFormFieldsRequest request)
request
- the request parameters. See DeleteFormFieldsRequest
DeleteFormFieldsResponseBody
public void deployApp(long app)
app
- the App IDpublic void deployApp(long app, Long revision)
app
- the App IDrevision
- the expected revision number of the App settingspublic DeployAppResponseBody deployApp(DeployAppRequest request)
request
- the request parameters. See DeployAppRequest
DeployAppResponseBody
public EvaluatedRecordRight evaluateRecordAcl(long app, long recordId)
app
- the App IDrecordId
- the record IDpublic List<EvaluatedRecordRight> evaluateRecordAcl(long app, List<Long> recordIds)
app
- the App IDrecordIds
- the list of record IDspublic EvaluateRecordAclResponseBody evaluateRecordAcl(EvaluateRecordAclRequest request)
request
- the request parameters. See EvaluateRecordAclRequest
EvaluateRecordAclResponseBody
public GetAdminNotesResponseBody getAdminNotes(long app)
app
- the App IDGetAdminNotesResponseBody
public GetAdminNotesResponseBody getAdminNotes(GetAdminNotesRequest request)
request
- the request parameters. See GetAdminNotesRequest
GetAdminNotesResponseBody
public GetAdminNotesPreviewResponseBody getAdminNotesPreview(long app)
app
- the App IDGetAdminNotesPreviewResponseBody
public GetAdminNotesPreviewResponseBody getAdminNotesPreview(GetAdminNotesPreviewRequest request)
request
- the request parameters. See GetAdminNotesPreviewRequest
GetAdminNotesPreviewResponseBody
public App getApp(long id)
id
- the App IDpublic GetAppResponseBody getApp(GetAppRequest request)
request
- the request parameters. See GetAppRequest
GetAppResponseBody
public List<AppRightEntity> getAppAcl(long app)
app
- the App IDpublic GetAppAclResponseBody getAppAcl(GetAppAclRequest request)
request
- the request parameters. See GetAppAclRequest
GetAppAclResponseBody
public List<AppRightEntity> getAppAclPreview(long app)
app
- the App IDpublic GetAppAclPreviewResponseBody getAppAclPreview(GetAppAclPreviewRequest request)
request
- the request parameters. See GetAppAclPreviewRequest
GetAppAclPreviewResponseBody
public Map<String,AppAction> getAppActions(long app)
app
- the app IDpublic Map<String,AppAction> getAppActions(long app, String lang)
app
- the app IDlang
- the localization language settingpublic GetAppActionsResponseBody getAppActions(GetAppActionsRequest request)
request
- the request parameters. See GetAppActionsRequest
GetAppActionsResponseBody
public Map<String,AppAction> getAppActionsPreview(long app)
app
- the app IDpublic Map<String,AppAction> getAppActionsPreview(long app, String lang)
app
- the app IDlang
- the localization language settingpublic GetAppActionsPreviewResponseBody getAppActionsPreview(GetAppActionsPreviewRequest request)
request
- the request parameters. See GetAppActionsPreviewRequest
GetAppActionsPreviewResponseBody
public GetAppCustomizeResponseBody getAppCustomize(long app)
app
- the app IDGetAppCustomizeResponseBody
public GetAppCustomizeResponseBody getAppCustomize(GetAppCustomizeRequest request)
request
- the request parameters. See GetAppCustomizeRequest
GetAppCustomizeResponseBody
public GetAppCustomizePreviewResponseBody getAppCustomizePreview(long app)
app
- the App IDGetAppCustomizePreviewResponseBody
public GetAppCustomizePreviewResponseBody getAppCustomizePreview(GetAppCustomizePreviewRequest request)
request
- the request parameters. See GetAppCustomizePreviewRequest
GetAppCustomizePreviewResponseBody
public GetAppsResponseBody getApps(GetAppsRequest request)
request
- the request parameters. See GetAppsRequest
GetAppsResponseBody
public List<App> getAppsByCodes(List<String> codes)
codes
- the list of App codespublic List<App> getAppsByIds(List<Long> ids)
ids
- the list of App IDspublic GetAppSettingsResponseBody getAppSettings(long app)
app
- the App IDGetAppSettingsResponseBody
public GetAppSettingsResponseBody getAppSettings(long app, String lang)
app
- the App IDlang
- the localization language settingGetAppSettingsResponseBody
public GetAppSettingsResponseBody getAppSettings(GetAppSettingsRequest request)
request
- the request parameters. See GetAppSettingsRequest
GetAppSettingsResponseBody
public GetAppSettingsPreviewResponseBody getAppSettingsPreview(long app)
app
- the App IDGetAppSettingsPreviewResponseBody
public GetAppSettingsPreviewResponseBody getAppSettingsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingGetAppSettingsPreviewResponseBody
public GetAppSettingsPreviewResponseBody getAppSettingsPreview(GetAppSettingsPreviewRequest request)
request
- the request parameters. See GetAppSettingsPreviewRequest
GetAppSettingsPreviewResponseBody
public DeployStatus getDeployStatus(long app)
app
- the App IDpublic GetDeployStatusResponseBody getDeployStatus(GetDeployStatusRequest request)
request
- the request parameters. See GetDeployStatusRequest
GetDeployStatusResponseBody
public List<FieldRight> getFieldAcl(long app)
app
- the App IDpublic GetFieldAclResponseBody getFieldAcl(GetFieldAclRequest request)
request
- the request parameters. See GetFieldAclRequest
GetFieldAclResponseBody
public List<FieldRight> getFieldAclPreview(long app)
app
- the App IDpublic GetFieldAclPreviewResponseBody getFieldAclPreview(GetFieldAclPreviewRequest request)
request
- the request parameters. See GetFieldAclPreviewRequest
GetFieldAclPreviewResponseBody
public Map<String,FieldProperty> getFormFields(long app)
app
- the App IDpublic Map<String,FieldProperty> getFormFields(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetFormFieldsResponseBody getFormFields(GetFormFieldsRequest request)
request
- the request parameters. See GetFormFieldsRequest
GetFormFieldsResponseBody
public Map<String,FieldProperty> getFormFieldsPreview(long app)
app
- the App IDpublic Map<String,FieldProperty> getFormFieldsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetFormFieldsPreviewResponseBody getFormFieldsPreview(GetFormFieldsPreviewRequest request)
request
- the request parameters. See GetFormFieldsPreviewRequest
GetFormFieldsPreviewResponseBody
public List<Layout> getFormLayout(long app)
app
- the App IDpublic GetFormLayoutResponseBody getFormLayout(GetFormLayoutRequest request)
request
- the request parameters. See GetFormLayoutRequest
GetFormLayoutResponseBody
public List<Layout> getFormLayoutPreview(long app)
app
- the App IDpublic GetFormLayoutPreviewResponseBody getFormLayoutPreview(GetFormLayoutPreviewRequest request)
request
- the request parameters. See GetFormLayoutPreviewRequest
GetFormLayoutPreviewResponseBody
public GetGeneralNotificationsResponseBody getGeneralNotifications(long app)
app
- the App IDGetGeneralNotificationsResponseBody
public GetGeneralNotificationsResponseBody getGeneralNotifications(GetGeneralNotificationsRequest request)
request
- the request parameters. See GetGeneralNotificationsRequest
GetGeneralNotificationsResponseBody
public GetGeneralNotificationsPreviewResponseBody getGeneralNotificationsPreview(long app)
app
- the App IDGetGeneralNotificationsPreviewResponseBody
public GetGeneralNotificationsPreviewResponseBody getGeneralNotificationsPreview(GetGeneralNotificationsPreviewRequest request)
request
- the request parameters. See GetGeneralNotificationsPreviewRequest
GetGeneralNotificationsPreviewResponseBody
public GetPerRecordNotificationsResponseBody getPerRecordNotifications(long app)
app
- the App IDGetPerRecordNotificationsResponseBody
public GetPerRecordNotificationsResponseBody getPerRecordNotifications(long app, String lang)
app
- the App IDlang
- the localization language settingGetPerRecordNotificationsResponseBody
public GetPerRecordNotificationsResponseBody getPerRecordNotifications(GetPerRecordNotificationsRequest request)
request
- the request parameters. See GetPerRecordNotificationsRequest
GetPerRecordNotificationsResponseBody
public GetPerRecordNotificationsPreviewResponseBody getPerRecordNotificationsPreview(long app)
app
- the App IDGetPerRecordNotificationsPreviewResponseBody
public GetPerRecordNotificationsPreviewResponseBody getPerRecordNotificationsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingGetPerRecordNotificationsPreviewResponseBody
public GetPerRecordNotificationsPreviewResponseBody getPerRecordNotificationsPreview(GetPerRecordNotificationsPreviewRequest request)
request
- the request parameters. See GetPerRecordNotificationsPreviewRequest
GetPerRecordNotificationsPreviewResponseBody
public List<AppPlugin> getPlugins(long app)
app
- the App IDpublic List<AppPlugin> getPlugins(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetAppPluginsResponseBody getPlugins(GetAppPluginsRequest request)
request
- the request parameters. See GetAppPluginsRequest
GetAppPluginsResponseBody
public List<AppPlugin> getPluginsPreview(long app)
app
- the App IDpublic List<AppPlugin> getPluginsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetAppPluginsPreviewResponseBody getPluginsPreview(GetAppPluginsPreviewRequest request)
request
- the request parameters. See GetAppPluginsPreviewRequest
GetAppPluginsPreviewResponseBody
public GetProcessManagementResponseBody getProcessManagement(long app)
app
- the App IDGetProcessManagementResponseBody
public GetProcessManagementResponseBody getProcessManagement(long app, String lang)
app
- the App IDlang
- the localization language settingGetProcessManagementResponseBody
public GetProcessManagementResponseBody getProcessManagement(GetProcessManagementRequest request)
request
- the request parameters. See GetProcessManagementRequest
GetProcessManagementResponseBody
public GetProcessManagementPreviewResponseBody getProcessManagementPreview(long app)
app
- the App IDGetProcessManagementPreviewResponseBody
public GetProcessManagementPreviewResponseBody getProcessManagementPreview(long app, String lang)
app
- the App IDlang
- the localization language settingGetProcessManagementPreviewResponseBody
public GetProcessManagementPreviewResponseBody getProcessManagementPreview(GetProcessManagementPreviewRequest request)
request
- the request parameters. See GetProcessManagementPreviewRequest
GetProcessManagementPreviewResponseBody
public List<RecordRight> getRecordAcl(long app)
app
- the App IDpublic List<RecordRight> getRecordAcl(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetRecordAclResponseBody getRecordAcl(GetRecordAclRequest request)
request
- the request parameters. See GetRecordAclRequest
GetRecordAclResponseBody
public List<RecordRight> getRecordAclPreview(long app)
app
- the App IDpublic List<RecordRight> getRecordAclPreview(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetRecordAclPreviewResponseBody getRecordAclPreview(GetRecordAclPreviewRequest request)
request
- the request parameters. See GetRecordAclPreviewRequest
GetRecordAclPreviewResponseBody
public GetReminderNotificationsResponseBody getReminderNotifications(long app)
app
- the App IDGetReminderNotificationsResponseBody
public GetReminderNotificationsResponseBody getReminderNotifications(long app, String lang)
app
- the App IDlang
- the localization language settingGetReminderNotificationsResponseBody
public GetReminderNotificationsResponseBody getReminderNotifications(GetReminderNotificationsRequest request)
request
- the request parameters. See GetReminderNotificationsRequest
GetReminderNotificationsResponseBody
public GetReminderNotificationsPreviewResponseBody getReminderNotificationsPreview(long app)
app
- the App IDGetReminderNotificationsPreviewResponseBody
public GetReminderNotificationsPreviewResponseBody getReminderNotificationsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingGetReminderNotificationsPreviewResponseBody
public GetReminderNotificationsPreviewResponseBody getReminderNotificationsPreview(GetReminderNotificationsPreviewRequest request)
request
- the request parameters. See GetReminderNotificationsPreviewRequest
GetReminderNotificationsPreviewResponseBody
public Map<String,Report> getReports(long app)
app
- the App IDpublic Map<String,Report> getReports(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetReportsResponseBody getReports(GetReportsRequest request)
request
- the request parameters. See GetReportsRequest
GetReportsResponseBody
public Map<String,Report> getReportsPreview(long app)
app
- the App IDpublic Map<String,Report> getReportsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetReportsPreviewResponseBody getReportsPreview(GetReportsPreviewRequest request)
request
- the request parameters. See GetReportsPreviewRequest
GetReportsPreviewResponseBody
public Map<String,View> getViews(long app)
app
- the App IDpublic Map<String,View> getViews(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetViewsResponseBody getViews(GetViewsRequest request)
request
- the request parameters. See GetViewsRequest
GetViewsResponseBody
public Map<String,View> getViewsPreview(long app)
app
- the App IDpublic Map<String,View> getViewsPreview(long app, String lang)
app
- the App IDlang
- the localization language settingpublic GetViewsPreviewResponseBody getViewsPreview(GetViewsPreviewRequest request)
request
- the request parameters. See GetViewsPreviewRequest
GetViewsPreviewResponseBody
public void move(long app, Long space)
app
- the App IDspace
- the Space ID of where the App will be moved to.public MoveAppResponseBody move(MoveAppRequest request)
request
- the request parameters. See MoveAppRequest
MoveAppResponseBody
public void revertApp(long app)
app
- the App IDpublic void revertApp(long app, Long revision)
app
- the App IDrevision
- the expected revision number of the App settingspublic UpdateAdminNotesResponseBody updateAdminNotes(UpdateAdminNotesRequest request)
request
- the request parameters. See UpdateAdminNotesRequest
UpdateAdminNotesResponseBody
public long updateAppAcl(long app, List<AppRightEntity> rights)
app
- the App IDrights
- the list of App permission settings, in order of priority.public long updateAppAcl(long app, List<AppRightEntity> rights, Long revision)
app
- the App IDrights
- the list of App permission settings, in order of priority.revision
- the expected revision number of the App settingspublic UpdateAppAclResponseBody updateAppAcl(UpdateAppAclRequest request)
request
- the request parameters. See UpdateAppAclRequest
UpdateAppAclResponseBody
public Map<String,ActionId> updateAppActions(long app, Map<String,AppAction> actions)
app
- the App IDactions
- the object that maps the Action name to the Action settingspublic Map<String,ActionId> updateAppActions(long app, Map<String,AppAction> actions, Long revision)
app
- the App IDactions
- the object that maps the Action name to the Action settingsrevision
- The expected revision number of the App settingspublic UpdateAppActionsResponseBody updateAppActions(UpdateAppActionsRequest request)
request
- the request parameters. See UpdateAppActionsRequest
UpdateAppActionsResponseBody
public UpdateAppCustomizeResponseBody updateAppCustomize(UpdateAppCustomizeRequest request)
request
- the request parameters. See UpdateAppCustomizeRequest
UpdateAppCustomizeResponseBody
public UpdateAppSettingsResponseBody updateAppSettings(UpdateAppSettingsRequest request)
request
- the request parameters. See UpdateAppSettingsRequest
UpdateAppSettingsResponseBody
public long updateFieldAcl(long app, List<FieldRight> rights)
app
- the App IDrights
- the list of Field permission settings, in order of prioritypublic long updateFieldAcl(long app, List<FieldRight> rights, Long revision)
app
- the App IDrights
- the list of Field permission settings, in order of priorityrevision
- the expected revision number of the App settingspublic UpdateFieldAclResponseBody updateFieldAcl(UpdateFieldAclRequest request)
request
- the request parameters. See UpdateFieldAclRequest
UpdateFieldAclResponseBody
public long updateFormFields(long app, List<FieldProperty> properties)
app
- the App IDproperties
- a list of field settingspublic long updateFormFields(long app, List<FieldProperty> properties, Long revision)
app
- the App IDproperties
- a list of field settingsrevision
- The expected revision number of the App settingspublic long updateFormFields(long app, Map<String,FieldProperty> properties)
app
- the App IDproperties
- an object that maps the field codes to the field settingspublic long updateFormFields(long app, Map<String,FieldProperty> properties, Long revision)
app
- the App IDproperties
- an object that maps the field codes to the field settingsrevision
- The expected revision number of the App settingspublic UpdateFormFieldsResponseBody updateFormFields(UpdateFormFieldsRequest request)
request
- the request parameters. See UpdateFormFieldsRequest
UpdateFormFieldsResponseBody
public long updateFormLayout(long app, List<Layout> layouts)
app
- the App IDlayouts
- the list of field layoutspublic long updateFormLayout(long app, List<Layout> layouts, Long revision)
app
- the App IDlayouts
- the list of field layoutsrevision
- the expected revision number of the App settingspublic UpdateFormLayoutResponseBody updateFormLayout(UpdateFormLayoutRequest request)
request
- the request parameters. See UpdateFormLayoutRequest
UpdateFormLayoutResponseBody
public UpdateGeneralNotificationsResponseBody updateGeneralNotifications(UpdateGeneralNotificationsRequest request)
request
- the request parameters. See UpdateGeneralNotificationsRequest
UpdateGeneralNotificationsResponseBody
public UpdatePerRecordNotificationsResponseBody updatePerRecordNotifications(UpdatePerRecordNotificationsRequest request)
request
- the request parameters. See UpdatePerRecordNotificationsRequest
UpdatePerRecordNotificationsResponseBody
public UpdateProcessManagementResponseBody updateProcessManagement(UpdateProcessManagementRequest request)
request
- the request parameters. See UpdateProcessManagementRequest
UpdateProcessManagementResponseBody
public long updateRecordAcl(long app, List<RecordRight> rights)
app
- the App IDrights
- a list of record permission settings, in order of priority.public long updateRecordAcl(long app, List<RecordRight> rights, Long revision)
app
- the App IDrights
- a list of record permission settings, in order of priority.revision
- the expected revision number of the App settingspublic UpdateRecordAclResponseBody updateRecordAcl(UpdateRecordAclRequest request)
request
- the request parameters. See UpdateRecordAclRequest
UpdateRecordAclResponseBody
public UpdateReminderNotificationsResponseBody updateReminderNotifications(UpdateReminderNotificationsRequest request)
request
- the request parameters. See UpdateReminderNotificationsRequest
UpdateReminderNotificationsResponseBody
public Map<String,ReportId> updateReports(long app, Map<String,Report> reports)
app
- the App IDreports
- an object that maps the Graph names to the Graph settingspublic Map<String,ReportId> updateReports(long app, Map<String,Report> reports, Long revision)
app
- the App IDreports
- an object that maps the Graph names to the Graph settingsrevision
- the expected revision number of the App settingspublic UpdateReportsResponseBody updateReports(UpdateReportsRequest request)
request
- the request parameters. See UpdateReportsRequest
UpdateReportsResponseBody
public Map<String,ViewId> updateViews(long app, Map<String,View> views)
app
- the App IDviews
- an object that maps the View names to the View settingspublic Map<String,ViewId> updateViews(long app, Map<String,View> views, Long revision)
app
- the App IDviews
- an object that maps the View names to the View settingsrevision
- the expected revision number of the App settingspublic UpdateViewsResponseBody updateViews(UpdateViewsRequest request)
request
- the request parameters. See UpdateViewsRequest
UpdateViewsResponseBody