Model Inventory

Delete a model inventory by ID

Changed on

Deletes a model inventory record and its project/framework associations. Optionally deletes linked model risks when deleteRisks=true. Records deletion in change history and fires "model_deleted" automations.

delete/modelInventory/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/modelInventory/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Model inventory ID

Query parameters

deleteRisks'true' | 'false'

When "true", also deletes associated rows from the model_risks table.

Response

Model inventory deleted

messagestring
datastring

Example response

{
  "message": "OK",
  "data": "Model inventory deleted successfully"
}

Changes

  • 55cdc040840cRevision changes
    • info

      added the new optional query request parameter deleteRisks

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

  • c419b1e72a65Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api operation id deleteModelInventoryById was added

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security JWTAuth was removed from the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status