POST
/
api
/
models
/
{modelId}
/
requirements
curl --request POST \
  --url https://app.dalus.io/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
}

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
​
title
string
required

Title of the requirement

​
description
string

Description of the requirement

​
status
enum<string>

Status of the requirement

Available options:
draft,
active,
completed,
archived
​
priority
enum<string>

Priority of the requirement

Available options:
low,
medium,
high,
critical

Response

201
application/json
Requirement created successfully
​
id
string
required

The id of the requirement

​
level
string
required

The level of the requirement

​
name
string
required

The name of the requirement

​
statement
string
required

The statement of the requirement

​
systems
string[]
required

The systems that are related to the requirement

​
status
required
Available options:
In Progress
​
constraints
object[]
​
parentId
string
​
pendingState
enum<string> | null
Available options:
add,
update,
delete
​
type
enum<string>
Available options:
none,
safety,
environmental,
performance,
reliability,
maintainability,
security,
interface,
design
​
autoUpdate
boolean
Get all requirements for a modelOpenAPI Specification