Skip to main content
GET
/
api
/
models
/
{modelId}
/
requirements
Get all requirements for a model
curl --request GET \
  --url http://localhost:3000/api/models/{modelId}/requirements \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "level": "<string>",
    "name": "<string>",
    "statement": "<string>",
    "systems": [
      "<string>"
    ],
    "functions": [
      "<string>"
    ],
    "status": "In Progress",
    "constraints": [
      {
        "limit": 123,
        "operator": ">",
        "variableId": "<string>",
        "id": "<string>",
        "type": "attribute"
      }
    ],
    "parentId": "<string>",
    "pendingState": "add",
    "type": "none",
    "autoUpdate": true,
    "customFields": {},
    "updatedAt": "<string>",
    "info": {
      "comment": "<string>",
      "reference": {
        "file": "<string>",
        "pageNumber": 123,
        "text": "<string>"
      }
    },
    "schemaVersion": 1
  }
]

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

Response

List of requirements

id
string
required
level
string
required
name
string
required
statement
string
required
Minimum length: 1
systems
string[]
required
status
required
Available options:
In Progress
functions
string[]
constraints
object[]
parentId
string
pendingState
enum<string> | null
Available options:
add,
update,
delete
type
Available options:
none,
customer,
safety,
environmental,
performance,
reliability,
maintainability,
security,
interface,
design,
business
autoUpdate
boolean
customFields
object
updatedAt
string
info
object
schemaVersion
number
default:1
I