• [0]: object ApiEntityDocument

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

• addressLine1(optional): string
  The first line of the address associated with the document.
• addressLine2(optional): string
  The second line of the address associated with the document.
• annotationCount(optional): object annotationCount
  Additional Properties Allowed: additionalProperties
• author(optional): string
  The system-generated identifier of a user assigned as an owner of this object.
• checkedOut(optional): boolean
  Read Only: true

  Indicates whether or not the document is checked-out.
• checkedOutBy(optional): string
  Read Only: true

  The user that checked out a document.
• checkedOutDate(optional): string(date-time)
  Read Only: true

  The date on which the document was last checked out.
• checkedOutUserId(optional): integer(int64)
  The system-generated identifier of a user.
• cityName(optional): string
  The name of the city associated with the document.
• comment(optional): string
  A document comment.
• countryCode(optional): string
  The code of the country associated with the document.
• description(optional): string
  Additional information about the document.
• documentConfiguredFields(optional): object ApiEntityDocumentConfiguredFields
• hasChildren(optional): boolean
  Read Only: true

  Indicates whether or not the document has children.
• id(optional): string
  The system-generated identifier of the document.
• isActualRoot(optional): boolean
  Read Only: true

  Indicates whether or not this document is the root node in a document structure.
• latitude(optional): number(double)
  The latitude of the location associated with the document.
• link(optional): string(url)
  Read Only: true
• locationName(optional): string
  The name of the location associated with the document.
• longitude(optional): number(double)
  The longitude of the location associated with the document.
• mimeType(optional): string
  Read Only: true

  The type of a document.
• name: string
  The name of the document.
• parentId: string
  The system-generated identifier of the parent object of the document.
• postalCode(optional): string
  The postal code of the location associated with the document.
• scope(optional): string
  Allowed Values: [ "GENERIC_PORTFOLIO", "PROJECT", "STRATEGY", "WORKSPACE", "IDEA", "PBS", "WBS", "ACTIVITY", "WORK_PACKAGE", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WORKFLOW_INSTANCE", "FORM_INSTANCE", "CONTRACT", "COMMITMENT", "TEMPLATE", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER_PROPOSAL", "PAYMENT_APPLICATION", "SUBMITTALS", "RFI", "CHANGE_EVENTS", "FUND", "PORTFOLIO_FUND", "CUSTOM_LOG_ITEM", "RISK" ]

  The object type the document is associated with, for example, workspace.
• scopeId(optional): integer(int64)
  UCR
• size(optional): integer(int64)
  Read Only: true

  The current size of the document in bytes.
• stateCode(optional): string
  The code of the state of the location associated with the document.
• stateName(optional): string
  The name of the state of the location associated with the document.
• syncToMobile(optional): boolean
  Indicates whether or not the document is synced with mobile devices.
• type(optional): string
  Read Only: true

  Allowed Values: [ "FOLDER", "DOCUMENT", "XLSX", "DOCX", "DOC", "XLS" ]

  The type of the 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.
• url(optional): string
  Read Only: true
• version(optional): string
  Read Only: true

  The current version of the document.

{
    "type":"object",
    "required":[
        "name",
        "parentId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the document."
        },
        "id":{
            "type":"string",
            "description":"The system-generated identifier of the document."
        },
        "type":{
            "type":"string",
            "description":"The type of the document",
            "readOnly":true,
            "enum":[
                "FOLDER",
                "DOCUMENT",
                "XLSX",
                "DOCX",
                "DOC",
                "XLS"
            ]
        },
        "size":{
            "type":"integer",
            "format":"int64",
            "description":"The current size of the document in bytes.",
            "readOnly":true
        },
        "comment":{
            "type":"string",
            "description":"A document comment."
        },
        "scopeId":{
            "type":"integer",
            "format":"int64",
            "description":"UCR"
        },
        "mimeType":{
            "type":"string",
            "description":"The type of a document.",
            "readOnly":true
        },
        "version":{
            "type":"string",
            "description":"The current version of the document.",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"Additional information about the document."
        },
        "parentId":{
            "type":"string",
            "description":"The system-generated identifier of the parent object of the document."
        },
        "url":{
            "type":"string",
            "readOnly":true
        },
        "scope":{
            "type":"string",
            "description":"The object type the document is associated with, for example, workspace.",
            "enum":[
                "GENERIC_PORTFOLIO",
                "PROJECT",
                "STRATEGY",
                "WORKSPACE",
                "IDEA",
                "PBS",
                "WBS",
                "ACTIVITY",
                "WORK_PACKAGE",
                "SCOPE_ITEM",
                "SCOPE_ITEM_ASSIGNMENT",
                "WORKFLOW_INSTANCE",
                "FORM_INSTANCE",
                "CONTRACT",
                "COMMITMENT",
                "TEMPLATE",
                "CHANGE_ORDER",
                "POTENTIAL_CHANGE_ORDER",
                "POTENTIAL_CHANGE_ORDER_PROPOSAL",
                "PAYMENT_APPLICATION",
                "SUBMITTALS",
                "RFI",
                "CHANGE_EVENTS",
                "FUND",
                "PORTFOLIO_FUND",
                "CUSTOM_LOG_ITEM",
                "RISK"
            ]
        },
        "countryCode":{
            "type":"string",
            "description":"The code of the country associated with the document."
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address associated with the document."
        },
        "stateName":{
            "type":"string",
            "description":"The name of the state of the location associated with the document."
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address associated with the document."
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code of the location associated with the document."
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The latitude of the location associated with the document."
        },
        "locationName":{
            "type":"string",
            "description":"The name of the location associated with the document."
        },
        "cityName":{
            "type":"string",
            "description":"The name of the city associated with the document."
        },
        "stateCode":{
            "type":"string",
            "description":"The code of the state of the location associated with the document."
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The longitude of the location associated with the document."
        },
        "checkedOutUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a user."
        },
        "checkedOutDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the document was last checked out.",
            "readOnly":true
        },
        "annotationCount":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int64"
            }
        },
        "documentConfiguredFields":{
            "description":"",
            "$ref":"#/definitions/ApiEntityDocumentConfiguredFields"
        },
        "isActualRoot":{
            "type":"boolean",
            "description":"Indicates whether or not this document is the root node in a document structure.",
            "readOnly":true
        },
        "syncToMobile":{
            "type":"boolean",
            "description":"Indicates whether or not the document is synced with mobile devices."
        },
        "checkedOut":{
            "type":"boolean",
            "description":"Indicates whether or not the document is checked-out.",
            "readOnly":true
        },
        "checkedOutBy":{
            "type":"string",
            "description":"The user that checked out a document.",
            "readOnly":true
        },
        "hasChildren":{
            "type":"boolean",
            "description":"Indicates whether or not the document has children.",
            "readOnly":true
        },
        "author":{
            "type":"string",
            "description":"The system-generated identifier of a user assigned as an owner of this object."
        },
        "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
        }
    }
}

• integer(int64)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int64"
    }
}

• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing the cost fields associated with the document.
• documentId(optional): integer(int64)
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing the cost fields associated with the document.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing the cost fields associated with the 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"An object containing the cost fields associated with the document.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"An object containing the cost fields associated with the document.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"An object containing the cost fields associated with the document.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "documentId":{
            "type":"integer",
            "format":"int64",
            "description":""
        },
        "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
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing the cost fields associated with the document.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing the cost fields associated with the document.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing the cost fields associated with the document.",
    "additionalProperties":{
        "type":"object"
    }
}