POST
/
api
/
models
/
{modelId}
/
parts
curl --request POST \
  --url http://localhost:3000/api/models/{modelId}/parts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "metadata": {}
}'
{
  "label": "<string>",
  "requirements": [
    "<string>"
  ],
  "documents": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "type": "pdf"
    }
  ],
  "attributes": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>",
      "unitName": "<string>",
      "prefix": "<string>",
      "lastUpdated": 123,
      "constraints": [
        "<string>"
      ],
      "isLeftAligned": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
modelId
string
required

ID of the model

Body

application/json
​
type
string
required

Type of part (e.g., entity, attribute)

​
name
string
required

Name of the part

​
description
string

Description of the part

​
metadata
object

Additional metadata for the part

Response

201
application/json
Part created successfully

A part in the model representing a physical or logical component

​
label
string
required

The label of the part

​
requirements
string[]
required

The linked requirements

​
documents
object[]
required

The linked documents

​
attributes
object[]
required

The attributes of the part

Get all parts for a modelGet a specific port