Jump to

• Request
• Response

View all File Versions

get

/api/restapi/document/file/{id}/version

Send a request to this endpoint to view versions of a file with file ID given as a {id} path parameter.

Request

Path Parameters

• id(required): integer(int64)
  The system-generated identifier of a file.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityFileVersion>

Type: array

Title: List<ApiEntityFileVersion>

Show Source

• Array of: object ApiEntityFileVersion
  Title: ApiEntityFileVersion

{
    "title":"List<ApiEntityFileVersion>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFileVersion",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFileVersion

Type: object

Title: ApiEntityFileVersion

Show Source

• comments: string
  Maximum Length: 4000

  A comment associated with a file version.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• size: integer (int64)
  The size of a file in bytes.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• version: string
  Maximum Length: 255

  The version of a file.

{
    "title":"ApiEntityFileVersion",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "size":{
            "type":"integer",
            "description":"The size of a file in bytes.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "version":{
            "maxLength":"255",
            "type":"string",
            "description":"The version of a file.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "comments":{
            "maxLength":"4000",
            "type":"string",
            "description":"A comment associated with a file version.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested file does not exist, or you do not have access to it.

Back to Top