Skip to main content
GET
/
api
/
models
/
{modelId}
/
interfaces
/
{interfaceId}
Get a specific interface
curl --request GET \
  --url http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceId": "<string>",
  "targetId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "source": "<string>",
  "target": "<string>",
  "data": {
    "label": "<string>",
    "connections": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "Matter",
        "direction": "in",
        "subType": "Fixed",
        "variableId": "<string>",
        "propertyIds": [
          "<string>"
        ],
        "colorGroup": "<string>",
        "matterState": "solid",
        "referenceEdgeId": "<string>"
      }
    ],
    "notes": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

modelId
string<uuid>
required

ID of the model

interfaceId
string<uuid>
required

ID of the interface

Response

Interface details

An interface between parts in the model consisting of connections

id
string<uuid>
required

Unique identifier for the interface The id of the edge

type
string
required

The type of the edge

source
string
required

The source node id

target
string
required

The target node id

data
object
required

The data associated with the edge

modelId
string<uuid>

ID of the model this interface belongs to

sourceId
string

ID of the source part

targetId
string

ID of the target part

name
string

Name of the interface

description
string

Description of the interface

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp