Managing Resources Using the API

From Connect
Jump to: navigation, search

Go Up to Developer Guide

Embarcadero Connect provides APIs to create, modify and delete resources such as glossaries, terms, and data sources.

Creating a Resource

To create a resource, you need to perform a POST request with the Content-Type HTTP header defined with the value application/json.

The body of your request must be a JSON object that defines the properties of your new resource, including at least the mandatory fields for the type of the target resource (glossaries, terms, data sources). For example, the following JSON object defines a glossary:

{
    "name": "My Glossary",
    "description": "My custom glossary.",
    "status": "In progress",
    "stewards": [
        { "name": "jane" }
    ]
}

The URL of the request, relative to the API root (for example, http://connect.example.com/api), can be one of the following:

Modifying a Resource

To modify the data of a resource, you need to perform a PUT request with the Content-Type HTTP header defined with the value application/json.

The body of your request must be a JSON object that defines the properties of your resource that you want to change. For example, the following JSON object changes the status of a glossary:

{
    "status": "Finished"
}

The URL of the request, relative to the API root (for example, http://connect.example.com/api), must include the ID of the target resource. This URL can be one of the following:

Deleting a Resource

To create a resource, you need to perform a DELETE request.

The URL of the request, relative to the API root (for example, http://connect.example.com/api), must include the ID of the target resource. This URL can be one of the following:

See Also

Personal tools
Next Version
Product Family Wiki