API docs by Redocly

MagicBridge Plugin API (1.0.0)

Download OpenAPI specification:

Model Bridge LLC: info@themodelbridge.com

REST API for interacting with internal MSOSA API

Elements

Model elements such as Diagram, Package, or TaggedValue

Get all 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=ownedelements($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=ownedelements($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": {
    }
}