GET Folder with Children

Overview

---

The following table contains important information about the GET method in regards to getting folder with children.

GET Folder with Children
Method	GET
URL or Endpoint	/api/projects/projectId/folders/folderId/children
Headers	Authorization
Parameters	projectId, folderId
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.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": ["string"],
  "messages": ["string"],
  "result": {
    "folder": {
      "id": 0,
      "projectId": 0,
      "name": "string",
      "parentId": 0
    },
    "children": [
      {
        "id": 0,
        "projectId": 0,
        "name": "string",
        "parentId": 0
      }
    ]
  },
  "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.
folder	Object	The parent folder object.
id	integer($int32)	The id of the folder.
projectId	integer($int32)	The id of the project.
name	string	The name of the folder.
parentId	integer($int32)	The Id of the parent folder.
children	array[Object]	The array of children folders.
id	integer($int32)	The id of the child folder.
projectId	integer($int32)	The id of the project.
name	string	The name of the child folder.
parentId	integer($int32)	The Id of the parent child folder.
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