Jump to

• Request
• Response

View Annotations of a Version of a File

get

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

Send a request to this endpoint to view all annotations of a given version of a file with version number given as a {version} path parameter and file ID given as a {id} path parameter.

Request

Path Parameters

• id(required): integer(int64)
  The system-generated identifier of a file.
• version(required): integer(int64)
  The version 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<ApiEntityAnnotation>

Type: array

Title: List<ApiEntityAnnotation>

Show Source

• Array of: object ApiEntityAnnotation
  Title: ApiEntityAnnotation

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

Nested Schema : ApiEntityAnnotation

Type: object

Title: ApiEntityAnnotation

Show Source

• annotationDate: string (date-time)
  The date on which an annotation was added to a file.
• annotationId: integer (int64)
  The system-generated identifier of an annotation.
• annotations: object annotations
  The annotations of a file.
• annotationString: string
  Maximum Length: 2147483647
  A file annotation.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• name: string
  Maximum Length: 255

  The name of an annotation.
• ownerId: integer (int64)
  The system-generated identifier of the user that authored the annotation.
• pageNum: integer (int64)
  The page number an annotation is associated with.
• ucrObjectId: string
  Maximum Length: 18

  The system-generated identifier of an object whether the file is created.
• updateDate: string (date-time)
  Date when the record was last updated.
• version: string
  Maximum Length: 255

  The version label associated with the annotation.

{
    "title":"ApiEntityAnnotation",
    "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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of an annotation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "annotations":{
            "type":"object",
            "description":"The annotations of a file.",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:document_resource_annotations"
            }
        },
        "version":{
            "maxLength":"255",
            "type":"string",
            "description":"The version label associated with the annotation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ownerId":{
            "type":"integer",
            "description":"The system-generated identifier of the user that authored the annotation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pageNum":{
            "type":"integer",
            "description":"The page number an annotation is associated with.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ucrObjectId":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of an object whether the file is created.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "annotationDate":{
            "type":"string",
            "description":"The date on which an annotation was added to a file.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "annotationId":{
            "type":"integer",
            "description":"The system-generated identifier of an annotation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "annotationString":{
            "type":"string",
            "description":"Maximum Length: 2147483647<br />A file annotation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : annotations

Type: object

The annotations of a file.

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