Get all requirements for a model

curl --request GET \
  --url http://localhost:3000/api/models/{modelId}/requirements \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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
  }
]

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

Response

List of requirements

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

Get all requirements for a model

Authorizations

Path Parameters

Response