Delete a diagram version

Use this resource to delete a specific version of a diagram. You must specify the diagram name and the version number.

This endpoint is available from version 8.0.43 onwards.

Request

To delete a diagram version, send a DELETE request to the endpoint defined below.

URL: /diagrams/{id}/version/{version}

Method: DELETE

Authorization: required (user with role System Administrator)

DELETE /ibis/rest/diagrams/{id}/version/{version} HTTP/1.1
Host: localhost:8080

You cannot delete a diagram version if it is the first version, the latest version, or tagged as active.

Path Parameters

The following table lists the path parameters for this request.

Name Description Required Allowed values

id

Enter the name of the diagram.

yes

Any string

version

Enter the version number of the diagram.

yes

Any integer

Response

The response confirms the deletion of the diagram version.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "responsedata": "Deleted the diagram's {Diagram name} version {Diagram version}"
}

Errors

This request might return one of the following error codes:

Authorization Failed (401)

Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>
Server Error (500)

Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.

Service Unavailable (503)

In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.