Get a specific requirement
curl --request GET \
--url http://localhost:3000/api/models/{modelId}/requirements/{requirementId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/models/{modelId}/requirements/{requirementId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/models/{modelId}/requirements/{requirementId}', 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/{requirementId}",
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/{requirementId}"
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))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/models/{modelId}/requirements/{requirementId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/models/{modelId}/requirements/{requirementId}")
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
}Models/Requirements
Get a specific requirement
Retrieves a specific requirement by ID
GET
/
api
/
models
/
{modelId}
/
requirements
/
{requirementId}
Get a specific requirement
curl --request GET \
--url http://localhost:3000/api/models/{modelId}/requirements/{requirementId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/models/{modelId}/requirements/{requirementId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/models/{modelId}/requirements/{requirementId}', 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/{requirementId}",
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/{requirementId}"
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))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/models/{modelId}/requirements/{requirementId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/models/{modelId}/requirements/{requirementId}")
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the model
ID of the requirement
Response
Requirement details
Minimum string length:
1status
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>
required
Available options:
In Progress Show child attributes
Show child attributes
Available options:
add, update, delete, null Available options:
none, customer, safety, environmental, performance, reliability, maintainability, security, interface, design, business Show child attributes
Show child attributes
Show child attributes
Show child attributes