Set Regulation Status

POST 
/api/v1/catalog/releases/project/:projectIdentifier/version/:version/regulation-status/:regulation

Set Regulation Status

Request

Path Parameters

projectIdentifier stringrequired

Project identifier (ID or name)

version stringrequired

Component Version of the regulation

regulation stringrequired

Name of the regulation

Header Parameters

X-Project-Token string

application/json

Body

required

value stringrequired

Value of the regulation

reportDetails string

Report Details of the regulation

Responses

200

application/json

Schema

Schema

projectIdentifier stringrequired

Project identifier (ID or name)

version stringrequired

Component Version of the regulation

regulation stringrequired

Name of the regulation

value stringrequired

Value of the regulation

reportDetails string

Report Details of the regulation

isCompliant booleanrequired

Compliancy of the regulation

createdAt date-timerequired

Creation date of the regulation status

updatedAt date-timerequired

Update date of the regulation status

regulationSnapshot

object

name stringrequired

Name of the regulation

description string

Description of the regulation

config string

Configuration of the regulation

typeId numberrequired

Type Id of the regulation

Example (from schema)

{
  "projectIdentifier": "string",
  "version": "string",
  "regulation": "string",
  "value": "string",
  "reportDetails": "string",
  "isCompliant": true,
  "createdAt": "2026-01-01T11:09:06.536Z",
  "updatedAt": "2026-01-01T11:09:06.536Z",
  "regulationSnapshot": {
    "name": "string",
    "description": "string",
    "config": "string",
    "typeId": 0
  }
}

Loading...