Working With Folder

Get the File Listing of a Specific Folder

This API allows you to get a list of all files of a specific folder from the specified Cloud Storage. If you do not pass storage name API will find the folder in GroupDocs Cloud Storage.

API Explorer

GroupDocs.Metadata Cloud API Reference lets you try out List Files in a Folder API right away in your browser. It allows you to effortlessly interact and try out every single operation that our APIs expose.

Request parameters

#
Parameter
#
Description

| path | Path of the file including file name and extension e.g. /Folder1/file.ext

Required. Can be passed as a query string parameter or as part of the URL

| storageName | Name of the storage. If not set, then default storage used

cURL Example

Request

curl -X GET "https://api.groupdocs.cloud/v1.0/metadata/storage/folder/metadatadocs?storageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{
  "value": [
    {
      "name": "four-pages.docx",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:35:38+00:00",
      "size": 8651,
      "path": "/metadatadocs/four-pages.docx"
    },
    {
      "name": "one-page.docx",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:17:34+00:00",
      "size": 351348,
      "path": "/metadatadocs/one-page.docx"
    },
    {
      "name": "password-protected.docx",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:35:40+00:00",
      "size": 10240,
      "path": "/metadatadocs/password-protected.docx"
    },
    {
      "name": "sample.mpp",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:29:10+00:00",
      "size": 289792,
      "path": "/metadatadocs/sample.mpp"
    },
    {
      "name": "three-layouts.dwf",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:26:42+00:00",
      "size": 15433,
      "path": "/metadatadocs/three-layouts.dwf"
    },
    {
      "name": "two-hidden-pages.vsd",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:17:36+00:00",
      "size": 457728,
      "path": "/metadatadocs/two-hidden-pages.vsd"
    },
    {
      "name": "uses-custom-font.pptx",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:32:30+00:00",
      "size": 39823,
      "path": "/metadatadocs/uses-custom-font.pptx"
    },
    {
      "name": "with-hidden-rows-and-columns.xlsx",
      "isFolder": false,
      "modifiedDate": "2019-03-20T12:17:37+00:00",
      "size": 15986,
      "path": "/metadatadocs/with-hidden-rows-and-columns.xlsx"
    }
  ]
}


SDKs

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the Folder API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.

SDK Examples

C#

Java

Create a New Folder

This API allows you to create a new folder in the specified Cloud Storage. If you do not pass storage name API will create New Folder in default Cloud Storage.

API Explorer

GroupDocs.Metadata Cloud API Reference lets you try out Create Folder API right away in your browser. It allows you to effortlessly interact and try out every single operation that our APIs expose.

Request parameters

#
Parameter
#
Description

| path | Target folder’s path e.g. Folder1/Folder2/. The folders will be created recursively

Required. Can be passed as a query string parameter or as part of the URL

| storageName | Name of the storage. If not set, then default storage used

cURL Example

Request

curl -X POST "https://api.groupdocs.cloud/v1.0/metadata/folder/metadatadocs?storageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{  
  "code": 200,
  "status": "OK"
}

SDKs

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the Folder API calls and lets you use GroupDocs for Cloud features in a native way for your preferred language.

SDK Examples

C#

Java

Delete a Particular Folder

This API allows you to delete a particular folder in the specified Cloud Storage. If you do not pass storage name API will create New Folder in default Cloud Storage. To remove recursively inner folder/files you need to pass a true value to a recursive parameter in Request. If it is set to false and folder contains data then API throws the exception.

API Explorer

GroupDocs.Metadata Cloud API Reference lets you try out Delete a Particular Folder API right away in your browser. It allows you to effortlessly interact and try out every single operation that our APIs expose.

Request parameters

#
Parameter
#
Description

| path | Folder path e.g. /Folder1

Required. Can be passed as a query string parameter or as part of the URL

| storageName | Name of the storage. If not set, then default storage used

cURL Example

Request

curl -X DELETE "https://api.groupdocs.cloud/v1.0/metadata/storage/folder/metadatadocs?storageName#MyStorage&recursive#true" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{  
  "code": 200,
  "status": "OK"
}

SDKs

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the Delete Folder API calls and lets you use GroupDocs for Cloud features in a native way for your preferred language.

SDK Examples

C#

Java

Copy Specific Folder

This API allows you to copy a folder to another location in the GroupDocs Cloud Storage. If you do not pass source and destination storage names API will copy Folder within default Cloud Storage.

API Explorer

GroupDocs.Metadata Cloud API Reference lets you try out Copy Folder API right away in your browser. It allows you to effortlessly interact and try out every single operation that our APIs expose.

Request parameters

#
Parameter
#
Description

| srcPath | Source folder path e.g. /Folder1

Required. Can be passed as a query string parameter or as part of the URL

|

destPath |

Destination folder path. Required

| srcStorageName | Name of the storage of source folder. If not set, then default storage used

|

destStorageName |

Name of the storage of destination folder. If not set, then default storage used

cURL Example

Request

curl -X PUT "https://api.groupdocs.cloud/v1.0/metadata/storage/folder/copy/metadatadocs?destPath#viewerdocs1&srcStorageName#MyStorage&destStorageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{  
  "code": 200,
  "status": "OK"
}

SDKs

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the Copy Folder API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.

SDK Examples

C#

Java

Move a Specific Folder

This API allows you to move a folder to another location in the GroupDocs Cloud Storage. If you do not pass source and destination storage names API will move Folder within default Cloud Storage.

API Explorer

GroupDocs.Metadata Cloud API Reference lets you try out Move a Folder API right away in your browser. It allows you to effortlessly interact and try out every single operation that our APIs expose.

Request parameters

#
Parameter
#
Description

| srcPath | Source folder path e.g. /Folder1

Required. Can be passed as a query string parameter or as part of the URL

|

destPath |

Destination folder path. Required

| srcStorageName | Name of the storage of source folder. If not set, then default storage used

|

destStorageName |

Name of the storage of destination folder. If not set, then default storage used

cURL Example

Request

curl -X PUT "https://api.groupdocs.cloud/v1.0/metadata/storage/folder/move/metadatadocs?destPath#viewerdocs1&srcStorageName#MyStorage&destStorageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"  

Response

{  
  "code": 200,
  "status": "OK"
}

SDKs

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the Move Folder API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.

SDK Examples

C#

Java