Jump to

• Request
• Response

Revert a Diagram to a Specified Revision

post

/api/diagram/Diagrams/updateRevision

Reverts a diagram to a specified revision.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• id(required): integer
  The diagram ID that has to be reverted.

  Example: 5
• Message: string
  The message associated with the change (optional).

  Example: Some changes made
• Revision(required): integer
  The revision number to which the diagram has to be reverted.

  Example: 4

{
    "type":"object",
    "required":[
        "id",
        "Revision"
    ],
    "properties":{
        "id":{
            "description":"The diagram ID that has to be reverted.",
            "type":"integer",
            "example":5,
            "required":true
        },
        "Revision":{
            "description":"The revision number to which the diagram has to be reverted.",
            "type":"integer",
            "example":4,
            "required":true
        },
        "Message":{
            "description":"The message associated with the change (optional).",
            "type":"string",
            "example":"Some changes made"
        }
    }
}

Back to Top

Response

200 Response

Successful operation

Body ()

Root Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top