PUT Folder to Folder
Overview
The following table contains important information about the PUT
method in regards to putting a folder to another folder.
PUT Folder to Folder | |
---|---|
Method | PUT |
URL or Endpoint | /api/projects/projectId /folders/folderId |
Headers | Authorization |
Parameters | projectId, folderId, parentId |
Body | Check request body below. |
The description of the URL parameter is as follows:
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
projectId | Yes | string | The Id of the project. |
folderId | Yes | integer($int32) | The Id of the folder. |
The description of the parameter is as follows:
parentId Parameter | |
---|---|
Parameter Name | parentId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the parent. |
Request Body
The request does not contain a request body
Response
{
"success": true,
"errors": ["string"],
"messages": ["string"],
"result": {},
"resultInfo": "string",
"statusCode": 0
}
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false. |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
result | array[Object] | Returns the response object. |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed