Build integrations with the 2c8 API

Read and work with the models, objects, and documents stored on your 2c8 server. Build a model catalogue, inspect diagram content, or connect repository data to another system.

Get started API reference (Swagger)

Sample data — no connection to your server

Process library

Explore two models, then select their shapes and connections to see the API data behind them.

Handle an orderDispatch an order

Explore the sample →

What would you like to build?#

A model catalogue#

Find models and their names, types and descriptions. Use the results in a catalogue or another application.

Browse repository content

A view of a diagram's contents#

Read the objects placed in a model and the connections between them.

Inspect a canvas

Connected information#

Retrieve rich-text descriptions and discover documents associated with models.

Read descriptions and documents

Before you begin#

Have these three things ready:

Your 2c8 server address. Ask your administrator for the API base URL, including /mt-backend/api/v1.
An application API key. Your administrator creates and shares it securely.
A repository and model you recognize. Their names help you check that you reached the right data.

No administrator access yourself? Copy a request to send to your administrator.

Start with requests that only read data. An API key can have broad access; following a read-only tutorial does not make the key read-only.

See what a request returns#

For example, ask for models and their titles in a repository:

HTTP request

GET /mt-backend/api/v1/repositories/{repositoryId}/models?projection=SIMPLE&fields=titles&startAt=0&maxResults=10

The response includes entries like this one from our fictional Process library (one item from the data array):

JSON

{
  "uuid": "c022603a-4d79-4b5e-a82e-ce1f2916b2c0",
  "modelType": "GENERAL_MODEL",
  "titles": {
    "b030a9f8-a89c-41c4-a972-0da5763c4d95": {
      "title": "Handle an order"
    }
  }
}

Handle an order is the model's name. Its uuid is the identifier used in later requests. The key inside titles identifies a language. The quickstart explains where to enter the request and how to read the complete response, using either your server's Swagger or Bash.

Understand the data and get help#

Core concepts explains repositories, models and reusable objects with a worked example. Common tasks takes that example further. If a request does not work, start with symptom-based troubleshooting.

OpenAPI downloads#

The OpenAPI description is a machine-readable catalogue of the documented endpoints, inputs and responses. Developers can import it into API tools or use it to generate client types:

Choose either format; they describe the same API. Match the backend release shown on this page with your installation before relying on a separately hosted snapshot. Check your server's version.