Skip to main content

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
MethodPUT
URL or Endpoint/api/projects/projectId/folders/folderId
HeadersAuthorization
ParametersprojectId, folderId, parentId
BodyCheck request body below.

The description of the URL parameter is as follows:

Parameter NameMandatoryTypeDescription
projectIdYesstringThe Id of the project.
folderIdYesinteger($int32)The Id of the folder.

The description of the parameter is as follows:

parentId Parameter
Parameter NameparentId
MandatoryYes
Typestring
DescriptionUnique 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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
resultInfostringReturns extra information about the result.
statusCodeinteger($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