Unlink a File
get
/api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/unlinkDocument
Send a request to this endpoint to unlink a file.
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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : Integer
Type:
integer(int64)
Title:
Integer
404 Response
The requested file does not exist, or you do not have access to it.