Skip to content
Plune Plune Plune Docs

Link a requirement to a case

PUT
/v1/test-cases/{id}/requirements/{requirementId}
 
curl --request PUT \
  --url https://beta-api.plune.ai/v1/test-cases/example/requirements/example \
  --header 'Authorization: Bearer <token>'

The case page’s side of PUT /v1/requirements/{id}/cases/{caseId}: the same link, the same audit entry on the requirement. 201 when made, 200 when it was there. An archived requirement takes no new case (409).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
requirementId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Already linked; the case’s requirements

Media type application/json
object
requirements
required
Array<object>
object
id
required
string
key
required
string
type
required
string
Allowed values: user_story feature epic
status
required
string
Allowed values: draft active done
title
required
string
Example 
{
  "requirements": [
    {
      "type": "user_story",
      "status": "draft"
    }
  ]
}

201

Section titled “201 ”

Linked; the case’s requirements

Media type application/json
object
requirements
required
Array<object>
object
id
required
string
key
required
string
type
required
string
Allowed values: user_story feature epic
status
required
string
Allowed values: draft active done
title
required
string
Example 
{
  "requirements": [
    {
      "type": "user_story",
      "status": "draft"
    }
  ]
}

401

Section titled “401 ”

No / invalid token or session

403

Section titled “403 ”

You are in the project as a reader

404

Section titled “404 ”

No such case or requirement in your projects

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

409

Section titled “409 ”

The requirement is archived

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

429

Section titled “429 ”

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the window rolls over