Show Source

• [0]: object ApiEntityEntityReference

{
    "title":"List<ApiEntityEntityReference>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityEntityReference"
    }
}

Show Source

• entityReferenceId(optional): integer(int64)
  The system-generated identfier of a reference.
• fromId(optional): integer(int64)
  The system-generated identifier of the object the reference is from.
• fromType: string
  Allowed Values: [ "PCO", "RISK", "RFI", "ACTIVITY", "WORK_MANAGER_TASK", "CHANGE_EVENT", "PROJECT", "IDEA" ]

  The type of the object the reference is from.
• fromTypeRecordCode: string
  The user-specified identifier of an object associated with a reference.
• link(optional): string(url)
  Read Only: true
• projectCode: string
  The user-specified identfier of a project.
• toId(optional): integer(int64)
  The system-generated identifier of the object a reference is a reference to.
• toType: string
  Allowed Values: [ "PCO", "RISK", "RFI", "ACTIVITY", "WORK_MANAGER_TASK", "CHANGE_EVENT", "PROJECT", "IDEA" ]

  The type of the object a reference refers to.
• toTypeRecordCode: string
  The user-specified identifier of an object associated with a reference.
• 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.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "type":"object",
    "required":[
        "fromType",
        "fromTypeRecordCode",
        "projectCode",
        "toType",
        "toTypeRecordCode",
        "workspaceCode"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identfier of a project."
        },
        "toTypeRecordCode":{
            "type":"string",
            "description":"The user-specified identifier of an object associated with a reference."
        },
        "entityReferenceId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identfier of a reference."
        },
        "fromTypeRecordCode":{
            "type":"string",
            "description":"The user-specified identifier of an object associated with a reference."
        },
        "fromId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the object the reference is from."
        },
        "toId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the object a reference is a reference to."
        },
        "toType":{
            "type":"string",
            "description":"The type of the object a reference refers to.",
            "enum":[
                "PCO",
                "RISK",
                "RFI",
                "ACTIVITY",
                "WORK_MANAGER_TASK",
                "CHANGE_EVENT",
                "PROJECT",
                "IDEA"
            ]
        },
        "fromType":{
            "type":"string",
            "description":"The type of the object the reference is from.",
            "enum":[
                "PCO",
                "RISK",
                "RFI",
                "ACTIVITY",
                "WORK_MANAGER_TASK",
                "CHANGE_EVENT",
                "PROJECT",
                "IDEA"
            ]
        },
        "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
        }
    }
}