API docs by Redocly

MagicBridge Plugin API (2.0.0)

Download OpenAPI specification:

Model Bridge LLC: info@themodelbridge.com

REST API for interacting with internal MSOSA model data

Base URL (default): 'http://localhost:8090/mb/v2'

Elements

Model elements such as AppliedStereotype, Package, or TaggedValue

Get list of elements

Retrieve a list of model elements with optional filtering and pagination

query Parameters
filter
string
Default: null
Example: filter=name eq 'Widget' or (class eq 'LiteralReal' and value gt 0.5)

Filter expression for elements. Supports operators eq, ne, gt, ge, lt, le, or, and, not and parentheses ().

select
string
Default: null
Example: select=name, id, value

Select specific properties to return

limit
integer [ 1 .. 100000 ]
Default: 100
Example: limit=100

Maximum number of results to return (1-100000).

offset
integer >= 0
Default: 0
Example: offset=10

Number of results to skip.

aux
boolean
Default: false
Example: aux=true

Include auxiliary elements.

expand
string
Default: null
Example: expand=ownedElement($select=name,ID;$filter=class eq 'Property')

expand related entities. supports nested $select, $filter and $expand

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get element by ID

Retrieve a specific model element by its unique identifier

path Parameters
id
required
string
Example: _1234x_1_1234567_1234567891234_123456_12345

Unique identifier of the element

query Parameters
select
string
Default: null
Example: select=name, id, value

Select specific properties to return

expand
string
Default: null
Example: expand=ownedElement($select=name,ID;$filter=class eq 'Property')

expand related entities. supports nested $select, $filter and $expand

Responses

Response samples

Content type
application/json
Example
{
  • "appliedStereotype": [
    ],
  • "class": "Abstraction",
  • "client": [
    ],
  • "clientDependency": [
    ],
  • "ID": "string",
  • "mapping": {
    },
  • "mdExtensions": [
    ],
  • "name": "string",
  • "nameExpression": {
    },
  • "namespace": {
    },
  • "ownedComment": [
    ],
  • "ownedElement": [
    ],
  • "owner": {
    },
  • "owningPackage": {
    },
  • "owningTemplateParameter": {
    },
  • "qualifiedName": "string",
  • "relatedElement": [
    ],
  • "source": [
    ],
  • "supplier": [
    ],
  • "supplierDependency": [
    ],
  • "syncElement": {
    },
  • "taggedValue": [
    ],
  • "target": [
    ],
  • "templateParameter": {
    },
  • "visibility": {
    }
}

Diagrams

Diagram images

Get diagram image by ID

Retrieve a diagram image as a base64 encoded string by its element ID. Supports multiple image return types.

path Parameters
id
required
string
Example: _1234x_1_1234567_1234567891234_123456_12345

Unique identifier of the diagram element

query Parameters
format
string
Default: "png"
Example: format=jpeg

Specify the image format to be returned: tiff, gif, png, jpeg, bmp.

Responses

Response samples

Content type
text/plain
iVBORw0KGgoAAAANSUhEUgAA...

Projects

Loaded and active projects.

Get loaded projects

Returns a list containing the names and IDs of all currently loaded projects.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get active project

Returns the ID and name of the currently active project as a json object.

Responses

Response samples

Content type
application/json
{
  • "id": "_2024x_2_62b0208_1768963887375_811485_2845",
  • "name": "example_project_one"
}

Set active project

Sets the active project to the specified project ID. Project must be loaded. Project IDs are dynamic and can change on project re-load or restart of MSOSA. See currently loaded project IDs via /projects.

Request Body schema: application/json
required
id
required
string

ID of the loaded project to be set as the active project.

Responses

Request samples

Content type
application/json
{
  • "id": "_2024x_2_62b0208_1768870314838_439651_4946"
}

Response samples

Content type
application/json
{
  • "details": {
    },
  • "code": "string",
  • "message": "string"
}