Jump to

• Request
• Response

Link a File to another Object

get

/api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/linkDocument

Send a request to this endpoint to link a file to another object.

Request

Path Parameters

• id(required): integer(int64)
  The system-generated identifier of a file.
• scope(required): string
  The object type the file is associated with, for example, workspace.

  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" ]
• scopeId(required): integer(int64)
  The object ID the file is associated with, for example, The ID of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Integer

Type: integer(int64)

Title: Integer

404 Response

The requested file does not exist, or you do not have access to it.

Back to Top