On this page
Use this API method to move an existing document or folder into another folder from the same or from a different project. The result is in JSON format and contains the list of attributes of the moved document.
Request URL
The request URL takes the following form:
PUT <ROOT>/rest/stonikbyte-documents-api/1.0/document/{documentID}/move
Parameters
Parameter | Description |
|---|---|
{documentID} | The id of the document to be moved |
Also, the body of the request must contain a JSON with the id of the destination folder.
Data | Description | Example |
|---|---|---|
idDestinationFolder | Required. The ID (key) of the folder when the document will be moved. | "21" |
A successful response
An HTTP 200 status response indicates a successful request. The result in JSON format will contain the list with the attributes of the moved document. See Obtaining the attributes of a document for a description of these attributes.
Error Response
If the REST call fails, the service returns one of the following HTTP statuses:
HTTP Status Code | Description |
|---|---|
401 Unauthorized | Returned for unauthenticated requests or in case of invalid Documents app license |
403 Forbidden | If the user does not have permissions |
400 Bad Request | In case of invalid parameters |
404 Not found | If the document or the destination folder no longer exists. |