Application API
Application
Living application
Description
Manage applications. This enables you to build to build a consistent functional applicative environment for users to interact with business processes and business data from one place.
提供了管理应用程序的接口,用来的业务流程与业务数据进行交互的场所。
Identifier
The ID of the application (a long value).
Representation
{
"id":"id of the application",
"token":"token of the application used to build the application URL",
"displayName":"display name of the application",
"version":"version of the application",
"description":"description of the application",
"profileId":"profile authorized to access this application",
"creationDate":"creation date of the application",
"createdBy":"user that created the application",
"updatedBy":"user that that updated the application",
"lastUpdateDate":"last update date of the application"},
"homePageId":"id of the application page used as the home page"
}
Methods
The methods used for this resource are:
- POST - Create an application
- GET - Get the application information
- PUT - Update an application
- DELETE - Remove an application
Application Menu
Description
Manage the set of menus in an application. This set of menus enables a user to navigate to the application pages.
There are two types of menu item:
- A top-level item appears in the navigation bar of the application. A top-level item can be clickable, leading to a page, or can be a parent for a menu of clickable items.
- A child menu item becomes visible in a menu when the parent is selected. A child menu item is clickable and leads to a page.
Each menu item has an index that defines the position in the menu. For a top-level menu item, this is the position in the the navigation bar counting from the left. For a child menu item, this is the position in the menu counting from the top.
Identifier
The ID of the application menu item (a long value).
Representation
{
"id":"_id of the application menu item_",
"parentMenuId":"_id of the parent menu of this menu item, or -1 for a top-level item_",
"applicationPageId":"_id of the application page targeted by this menu item, or -1 if there is no targeted page (that is, the item is a parent menu)_",
"applicationId":"_id of the application related to this menu item_",
"menuIndex":"_index of the menu item_",
"displayName":"_label to display for this menu in the application navigation bar or menu_"
}
Methods
The methods used for this resource are:
- POST - Create a menu item
- GET - Read a menu item or search for a menu item
- PUT - Update a menu item
- DELETE - Remove a menu item
Application Page
Description
An application page is a custom page that has been associated with an application. Use this resource to manage application pages and define the paths used to access them. This list of pages will be used to build the application menus.
Identifier
The ID of the application page (a long value).
Representation
{
"id":"_id of the application page_",
"token":"_token use to access the page using a URL : ../appName/pageToken/_",
"applicationId":"_id of the application related to this page_",
"pageId":"_id of the custom page to display_"
}
Methods
The methods used for this resource are:
- POST - Create an application page
- GET - Read an application page or search for an application page
- DELETE - Remove an application page