Configure the REST API app
2 min
The OCP database is not included in the free version of OCP. The free version syncs data in real-time without using the OCP database, letting you access public apps and data syncs.
Contact your Customer Success Manager if you have any questions.
The REST API app provides a central source for information on the Optimizely Connect Platform (OCP) API endpoints. The OCP REST API lets you manage your objects with the following endpoints:
- Update ObjectUpdate Object – Update an existing object in your OCP database. This endpoint lets you upload data to your OCP database, so you must first use the other endpoints to create the necessary database schema to support your data import.
- Create objectCreate object– Create an object in OCP. Define its fields and how it relates to other objects. This endpoint only affects the database schema and does not let you upload data within that schema.
- List objectsList objects – List the details of all objects in your OCP account.
- Get objectGet object– List the details of a specific object in your OCP account.
- Create fieldCreate field – Create a field on an object in your OCP database. This endpoint only affects the database schema and does not let you upload data within that schema.
- List fieldsList fields– List the details of all fields for a specific object in your OCP database.
- Get fieldGet field– List the details of a single field for a specific object in your OCP database.
- Create relationshipCreate relationship – Create a relationship between objects in OCP. This endpoint only affects the database schema and does not let you upload data within that schema.
- List relationsList relations– List the details of all relationships of a specific object in OCP.
- Get relationGet relation– List the details of a single relationship of a specific object in OCP.
Note
This app does not actually let you use the OCP REST API. It only provides resources for using the API.
Install the app
- Go to Data Setup > App Directory.
- Select the Rest API app.
- Click Install App. The Settings tab displays.
- View the API resources with the following options:
- Raw OpenAPI definition – Click to view the API definition in raw YAML format.
- Go to Redoc documentation – Click to view the API definition in a structured, user-friendly format.
- Go to Swagger documentation – Click to explore and test the endpoints dynamically.