Skip to main content
Version: v5.0

Object Model API Service

The Object Model API (OMAPI) Service provides you with your own REST endpoints for applications and projects so you can call scripts in your custom JavaScript model APIs. This allows you to focus on the business logic of your applications without having to write any back-end code.

API config and object model scripts#

Using the Object Model API Service, you can design an API config file to expose your APIs. Your model scripts can also access request data and utilize it for a given function.

Use cases#

Your model scripts can leverage the platform APIs to return the data and data structure you require. Here are some use case examples:

  • A user interface request
  • Integrate your application with a third-party system in a language, data structure, and with resource type definitions that it can understand
  • Use the endpoints for web hooks
  • Any other use case you can imagine

See the following figure for an example of a button click request that uses an object model API endpoint:

APIs#

API Config API#

Perform REST API functions for API configs, such as adding and deleting API configs, as well as listing pending additions and deletions.

For more information, see API Configs.

Object Model API permissions#

Get, create, update, or delete Object Model API permissions.

For more information, see Object Model API permissions.

Object Model API functions#

For information on Object Model API functions, see Script execution overview.