POST
/
api
/
models
/
{modelId}
/
requirements
curl --request POST \
  --url http://localhost:3000/api/models/{modelId}/requirements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "status": "draft",
  "priority": "low"
}'
{
  "id": "<string>",
  "level": "<string>",
  "name": "<string>",
  "statement": "<string>",
  "systems": [
    "<string>"
  ],
  "status": "In Progress",
  "constraints": [
    {
      "limit": 123,
      "operator": ">",
      "variableId": "<string>",
      "id": "<string>",
      "type": "attribute"
    }
  ],
  "parentId": "<string>",
  "pendingState": "add",
  "type": "none",
  "autoUpdate": true,
  "info": {
    "comment": "<string>",
    "reference": {
      "file": "<string>",
      "pageNumber": 123,
      "text": "<string>"
    }
  }
}

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

Response

201
application/json
Requirement created successfully

The response is of type object.