Simplified teaching diagrams, not exact 2c8 notation. Choose a model, then a shape or connection. Both models reuse the same Customer symbol.
Handle an order
Illustrative layout. Select a shape or use the element buttons to inspect its data.
Customer
This shape is a vertex: one placement in this model. Its symbol is the reusable object behind it.
Vertex ID
baa2e42e-0b41-408d-a987-c5f93166cac4
Symbol ID
f2d2ee19-1582-4399-ab55-49b8c9ae1197
Customer appears in both models: the symbol ID stays the same, while the vertex ID and placement change.
Check order
This shape is a vertex: one placement in this model. Its symbol is the reusable object behind it.
Vertex ID
9be93a23-d344-4e36-b025-0123d77e8b11
Symbol ID
535eb24b-afd2-4dab-9d61-c7a4f2acb19b
Connection
This edge connects the two vertices and implicitly defines the modeled relation. There is no separate relation entity to fetch.
Edge ID
83091817-805f-4b1d-bf95-d87f94a89f4f
From vertex
baa2e42e-0b41-408d-a987-c5f93166cac4
To vertex
9be93a23-d344-4e36-b025-0123d77e8b11
Description
Check the order before dispatch.
A rich-text value in a configured field.
Associated document
Order checklist
Resolved metadata; this does not download a file. Placeholder URL: https://documents.example/order-checklist
Show the API requests
These are bundled example responses, not executed requests. Highlighted JSON belongs to the selected element. Canvas and language responses show relevant fields; your server can return more.
getRepositories
GET /api/v1/repositories?projection=SIMPLE&startAt=0&maxResults=10
Illustrative layout. Select a shape or use the element buttons to inspect its data.
Customer
This shape is a vertex: one placement in this model. Its symbol is the reusable object behind it.
Vertex ID
741269f4-2f7e-454c-a474-a64f4aaadf76
Symbol ID
f2d2ee19-1582-4399-ab55-49b8c9ae1197
Customer appears in both models: the symbol ID stays the same, while the vertex ID and placement change.
Dispatch order
This shape is a vertex: one placement in this model. Its symbol is the reusable object behind it.
Vertex ID
e83d0aa5-cc2b-46bd-af35-87a4a8ed46c2
Symbol ID
6ca1f77d-d782-460a-87a7-dc602838d71a
Connection
This edge connects the two vertices and implicitly defines the modeled relation. There is no separate relation entity to fetch.
Edge ID
0eebeb0f-d361-4c10-aee5-a1bfe41ccba1
From vertex
741269f4-2f7e-454c-a474-a64f4aaadf76
To vertex
e83d0aa5-cc2b-46bd-af35-87a4a8ed46c2
Description
Dispatch the checked order to the customer.
A rich-text value in a configured field.
Associated document
Order checklist
Resolved metadata; this does not download a file. Placeholder URL: https://documents.example/order-checklist
Show the API requests
These are bundled example responses, not executed requests. Highlighted JSON belongs to the selected element. Canvas and language responses show relevant fields; your server can return more.
getRepositories
GET /api/v1/repositories?projection=SIMPLE&startAt=0&maxResults=10
Build on the Quickstart: use your own server, API key and repository UUID. The examples continue the fictional Process library and Handle an order model. Replace their example values with values from your responses.
For Bash, set API_BASE_URL, API_KEY and REPOSITORY_ID as in the quickstart. For Swagger, use the same endpoints and parameters on your server. The requests below only read data, including the explicitly identified POST used to resolve document metadata.
Match that language's uuid to a key in each model's titles. Read the nested title to produce:
Model name
Type
Model ID
Handle an order
GENERAL_MODEL
c022603a-4d79-4b5e-a82e-ce1f2916b2c0
Dispatch an order
GENERAL_MODEL
a41979d0-f088-44e5-828c-bd12ce9e0196
Use the desired language when present. If it is missing, your integration can fall back to the default language; if that is missing too, show an explicit label such as “Untitled model.” This is a display policy for your integration, not an automatic API translation.
Read all pages of both lists using pagination. Keep each model UUID together with its repository UUID. Empty lists are valid.
Next: choose a model and inspect its canvas below. References: List models, Languages.
Match each edge's fromVertex and toVertex to those vertex IDs. Here the edge connects the first placement to the second.
Each vertex's symbol identifies the reusable modeled object. To read that object's metadata, use GET /repositories/{repositoryId}/symbols/{symbolId} with the returned symbol UUID.
The edge itself implicitly defines the modeled relation; there is no separate relation object to fetch. Other vertex-list endpoints can return a different representation of a symbol reference, so use the schema for the endpoint you called.
{
"startAt": 0,
"maxResults": 50,
"total": 1,
"data": [{
"descriptionType": "4f394d93-0d4a-4b0c-b512-d96f193b9a5a",
"content": {
"b030a9f8-a89c-41c4-a972-0da5763c4d95": {
"text": "<p>Check the order before dispatch.</p>"
}
}
}]
}
descriptionType identifies a configured field. Rich-text field values are generally called descriptions. Match the language key in content as you did for titles, then read text. It can contain HTML: apply your application's HTML-sanitization rules before displaying it. Read remaining pages if needed.
Here sourceId identifies the document provider and documents[].uuid is the provider's document key. Despite that field's name, not every provider uses UUID-formatted keys.
This endpoint uses POST to read document metadata because the list of keys is sent in a request body. It does not create a document. Do not assume other POST operations are read-only.
Save the following JSON as resolve-document.json, replacing both the language UUID and document key with values from your responses. Use a JSON editor so provider keys containing quotes are escaped correctly:
Match documentId.source and documentId.id to the requested reference rather than relying on response order. The example link is a placeholder. A returned link may lead to another application and require separate authentication; it is not a guarantee of a direct file download. Do not forward your 2c8 API key to that link. Handle missing/unavailable documents as reported by the endpoint.
Use pagination and field selection to keep requests bounded. Handle empty results, missing localized values and deleted resources. Follow the rate-limit and retry guidance when scheduling repeated reads.
Before adding create, update or delete operations, inspect their schemas and test in a suitable non-production repository. A read-only workflow does not make its API key read-only.