Skip to main content
Version: 2.1.0

Create or update a model

Introduction​

This endpoint allows you to create a new model or update an existing one.

To update an existing one, the XML model file provided must use the same model->name value.

To create your XML model file see model description

warning

In case of update, check for model update restrictions

REST API​

How to​

The Regards REST API concept describe how REST interfaces must be handled to submit requests.

Endpoint​

EndpointVerb
/models/importPOST

Request content​

To create or update an existing model you have to provide the XML file with the request as a "multipart/form-data" content.

Example​

curl -X POST https://regards.com/api/v1/rs-dam/models/import \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/your/file.xml"

Response​

  • Code: 201 Created : Model successfully created or updated.
  • Code: 403 Forbidden : You don't have permission to create or update a model.
  • Code: 400 Bad request : Your data model file is not valid. Check file model format here