A set of REST API endpoints is dedicated to managing model extensions. You can use the
REST API to update the database schema.
Before you begin
To use the endpoints for managing model extensions, you must have the installer or
administrator role. Model extensions are related to the Decision Center schema.
About this task
You must use the endpoints in the following order to create a database schema.
Procedure
- Open the Decision Center
REST API Swagger (see Decision Center REST API).
- Use the following endpoint to retrieve the default model extension files:
/v1/DBAdmin/modelextensionfiles
This action retrieves a compressed archive that contains the default model and data extension
files, and all the default message files for the locales that are supported by default.
- To download an SQL script to update the database schema, use the following endpoint with
either the default model and data files or the user customized model and data files:
/v1/DBAdmin/createschema
The keepData flag is set to true by default to retain the data
in the current table. Set the flag to false to add statements to drop the table in
the SQL script.
When the SQL script is downloaded, you can modify it to comply with any requirements that your
organization might have, for example, credentials to modify schema.
- Run the SQL script by using the following endpoint to create the database schema:
/v1/DBAdmin/execute
The completion of the SQL script can be seen in the following endpoint:
/v1/DBAdmin/status
- Use the following endpoint to persist the model extension and data extension files. This
step is a mandatory after you run the SQL script.
/v1/DBAdmin/uploadextensionmodel
Now, you can use the model set in the tables.
- Use the following endpoint to upload a message file that corresponds to the used model
extensions:
/v1/DBAdmin/uploadmessagesfile
This endpoint needs to be called for every message file that must be uploaded.
- Use the following endpoint to verify the model extension files:
/v1/DBAdmin/modelextensionfiles