Create a new requirement

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>"
}
'

import requests

url = "http://localhost:3000/api/models/{modelId}/requirements"

payload = {
    "title": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: '<string>', description: '<string>'})
};

fetch('http://localhost:3000/api/models/{modelId}/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/models/{modelId}/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/models/{modelId}/requirements"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/api/models/{modelId}/requirements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/models/{modelId}/requirements")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "level": "<string>",
  "name": "<string>",
  "statement": "<string>",
  "systems": [
    "<string>"
  ],
  "status": "In Progress",
  "functions": [
    "<string>"
  ],
  "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
}

POST

api

models

{modelId}

requirements

Create a new requirement

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>"
}
'

import requests

url = "http://localhost:3000/api/models/{modelId}/requirements"

payload = {
    "title": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: '<string>', description: '<string>'})
};

fetch('http://localhost:3000/api/models/{modelId}/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/models/{modelId}/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/models/{modelId}/requirements"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/api/models/{modelId}/requirements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/models/{modelId}/requirements")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "level": "<string>",
  "name": "<string>",
  "statement": "<string>",
  "systems": [
    "<string>"
  ],
  "status": "In Progress",
  "functions": [
    "<string>"
  ],
  "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

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

Requirement created successfully

string

required

level

string

required

name

string

required

statement

string

required

Minimum string length: 1

systems

string[]

required

status

required

Available options:

In Progress

functions

string[]

constraints

object[]

Show child attributes

parentId

string

pendingState

enum<string> | null

Available options:

add,

update,

delete,

null

type

Available options:

none,

customer,

safety,

environmental,

performance,

reliability,

maintainability,

security,

interface,

design,

business

autoUpdate

boolean

customFields

object

Show child attributes

updatedAt

string

info

object

Show child attributes

schemaVersion

number

default:1

Get Started

Feature Guides

API Reference

Create a new requirement

Authorizations

Path Parameters

Body

Response