Show Source

• [0]: object ApiEntityAnnotation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityAnnotation"
    }
}

Show Source

• annotationDate(optional): object TimezoneSensitiveDateTime
• annotationId(optional): integer(int64)
  The system-generated identifier of an annotation.
• annotations(optional): object annotations
  Additional Properties Allowed: additionalProperties

  The annotations of the document.
• annotionString(optional): string
  A document annotation.
• link(optional): string(url)
  Read Only: true
• name(optional): string
  The name of an annotation.
• ownerId(optional): integer(int64)
  The system-generated identifier of the user that authored the annotation.
• pageNum(optional): integer(int64)
  The page number an annotation is associated with.
• ucrObjectId(optional): string
  The system-generated identifier of a document.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• version(optional): string
  The version label associated with the annotation.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of an annotation."
        },
        "annotations":{
            "type":"object",
            "description":"The annotations of the document.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "version":{
            "type":"string",
            "description":"The version label associated with the annotation."
        },
        "ownerId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the user that authored the annotation."
        },
        "annotationDate":{
            "description":"The date on which an annotation was added to a document.",
            "$ref":"#/definitions/TimezoneSensitiveDateTime"
        },
        "annotionString":{
            "type":"string",
            "description":"A document annotation."
        },
        "ucrObjectId":{
            "type":"string",
            "description":"The system-generated identifier of a document."
        },
        "pageNum":{
            "type":"integer",
            "format":"int64",
            "description":"The page number an annotation is associated with."
        },
        "annotationId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of an annotation."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Show Source

• wrappedDateTime(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "wrappedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"The annotations of the document.",
    "additionalProperties":{
        "type":"object"
    }
}