Group similar requirements
Clusters a list of extracted requirement items into groups of similar or related items.
POST
/++groupSimilarRequirements
Requirements Analyser
Authentication
Requires an authenticated (logged-in) account.
Request
Content type: application/json
| Name | In | Type | Required | Description |
|---|---|---|---|---|
BODY | body | string | No | — |
items | body | string | No | — |
threshold | body | string | No | — |
ambiguity | body | string | No | Sent by the web client (found via frontend call-site tracing). |
conflicts | body | string | No | Sent by the web client (found via frontend call-site tracing). |
duplicates | body | string | No | Sent by the web client (found via frontend call-site tracing). |
Example request body
{
"BODY": "example_value",
"items": [
"... see the parameters/response fields below for the shape of each entry ..."
],
"threshold": "example_value",
"ambiguity": "example_value",
"conflicts": "example_value",
"duplicates": "example_value"
}
Responses
| Status | Meaning |
|---|---|
200 | Successful response. |
500 | Internal server error. |
401 | Unauthorized - authentication required. |
403 | Forbidden - the current user or Integrator registration does not have sufficient permissions. |
Example response (illustrative - field names only, values are placeholders)
{
"groups": "example_value"
}
