Jump to

• Request
• Response

View all References of a File

get

/api/restapi/document/file/{id}/references

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

Request

Path Parameters

• id(required): integer(int64)
  The system-generated identifier 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<ApiEntityReference>

Type: array

Title: List<ApiEntityReference>

Show Source

• Array of: object ApiEntityReference
  Title: ApiEntityReference

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

Nested Schema : ApiEntityReference

Type: object

Title: ApiEntityReference

Show Source

• code: string
  Maximum Length: 60

  The code of the object the file is linked to.
• documentId: string
  Maximum Length: 0

  The system-generated identifier of a document.
• link: string (url)
  Read Only: true

  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 the object the file is linked to.
• objectId: integer (int64)
  The system-generated identifier of the object the file is linked to.
• referenceId: integer (int64)
  The system-generated identifier of an object reference.
• scope: string
  Allowed Values: [ "project", "pbs", "wbs", "activity", "workPackage", "scopeItem", "scopeItemAssignment", "workflowInstance", "formInstance", "contract", "commitment", "changeOrder", "potentialChangeOrder", "potentialChangeOrderProposal", "paymentApplication", "submittals", "rfi", "changeEvents", "fund", "portfolioFund", "customLogItem", "risk", "programRisk", "constraint", "customLogItemProgram", "programFund", "workManagerTask" ]

  The object name the file is linked to.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityReference",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the object the file is linked to.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "objectId":{
            "type":"integer",
            "description":"The system-generated identifier of the object the file is linked to.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The object name the file is linked to.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "project",
                "pbs",
                "wbs",
                "activity",
                "workPackage",
                "scopeItem",
                "scopeItemAssignment",
                "workflowInstance",
                "formInstance",
                "contract",
                "commitment",
                "changeOrder",
                "potentialChangeOrder",
                "potentialChangeOrderProposal",
                "paymentApplication",
                "submittals",
                "rfi",
                "changeEvents",
                "fund",
                "portfolioFund",
                "customLogItem",
                "risk",
                "programRisk",
                "constraint",
                "customLogItemProgram",
                "programFund",
                "workManagerTask"
            ]
        },
        "code":{
            "maxLength":60,
            "type":"string",
            "description":"The code of the object the file is linked to.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "documentId":{
            "maxLength":0,
            "type":"string",
            "description":"The system-generated identifier of a document.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "referenceId":{
            "type":"integer",
            "description":"The system-generated identifier of an object reference.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

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