Server procedures are different for each customer due to the variations in the OData
metadata and require server code updates for every activity. As a result, we do not
document the API Server Procedures as they support processes in the Web Client and
continually change due to our commitment to improve server code with frequent updates.
API Server Procedures are objects that represent any OData action, function, singleton, or entity that is configured in the application server code. The following API Server Procedures are examples of these types of OData actions:
-
Log out - Action used to log out.
-
GetNavigationOptions - Action used to retrieve an object's expansion information.
-
Regenerate metadata - Action used by client software to refresh the OData metadata based on the exposed schema model.
-
User singleton - Action used to get information about the user's selected roles and configurations.
API Server Procedures perform activities as the result of an https web request. Each server activity is represented by a API Server Procedure type and has a corresponding API Server Procedure instance, which is used for grouping and permissions.