Redgate Data Modeler’s document-oriented API functionality allows users to easily fetch:

1. Lists of models and SQL scripts as a document tree in the JSON format.
2. A physical data model as an XML file or a corresponding SQL result.
3. A logical data model as an XML file.
4. An SQL script.
5. A migration script.

Examples

All the following examples use the curl tool. We assumed there is a “$TOKEN” variable available, which stores the public token generated as described in an earlier section of this article. A “:” character in the user parameter (-u option) is intended.

You can use the following command to declare the “$TOKEN” variable:

Download a Document Tree

To fetch a document tree, we need to make a GET HTTPS request to https://datamodeler.redgate-platform.com/drive with the following HTTP headers:

1. An accept header with a JSON mime type: Accept: application/json
2. An authorization header with a username equal to $TOKEN and an empty password, in the following format: Authorization: Basic (base64($TOKEN:))

Here is the corresponding curl example:

The result is a JSON file with a list of the documents (logical and physical models, SQL scripts to which you have access) in your Redgate Data Modeler account. Please note that the link property is a valid document URL and can be used for further requests.