Show Source

• [0]: object ApiEntityReference

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

Show Source

• code(optional): string
  The code of the object the document is linked to.
• documentId(optional): string
  The system-generated identifier of a document.
• link(optional): string(url)
  Read Only: true
• name(optional): string
  The name of the object the document is linked to.
• objectId(optional): integer(int64)
  The system-generated identifier of a refernced object.
• referenceId(optional): integer(int64)
  The system-generated identifier of an object reference.
• 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.
• type(optional): string
  The type of the object the document is linked to.
• 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
        },
        "name":{
            "type":"string",
            "description":"The name of the object the document is linked to."
        },
        "type":{
            "type":"string",
            "description":"The type of the object the document is linked to."
        },
        "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"
            ]
        },
        "code":{
            "type":"string",
            "description":"The code of the object the document is linked to."
        },
        "objectId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a refernced object."
        },
        "referenceId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of an object reference."
        },
        "documentId":{
            "type":"string",
            "description":"The system-generated identifier of a document."
        },
        "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
        }
    }
}