Skip to main content
GET
/
api
/
models
/
{modelId}
/
parts
Get all parts for a model
curl --request GET \
  --url http://localhost:3000/api/models/{modelId}/parts \
  --header 'Authorization: Bearer <token>'
[
  {
    "label": "<string>",
    "requirements": [
      "<string>"
    ],
    "documents": [
      {
        "id": "<string>",
        "name": "<string>",
        "url": "<string>",
        "type": "pdf"
      }
    ],
    "attributeIds": [
      "<string>"
    ],
    "notes": "<string>",
    "actualState": "<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

Query Parameters

​
type
string

Filter parts by type

Response

List of parts

​
label
string
required

The label of the part

​
requirements
string[]
required

The linked requirements

​
documents
object[]
required

The linked documents

​
attributeIds
string[]
required

The IDs of the attributes on the part

​
notes
string

Additional notes about the part

​
actualState
string

State ID of the actual state of the part