Folder
  • PDF

Folder

  • PDF

# Folder

Description

It is an API to manage folders for the WORKBOX service.

Search API

Searches the folder information.

Request URL

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/{folderId}

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request path parameter

Parameter Type Requirement status Description
folderId long Y Folder ID (FolderId)

Request examples

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/2485554

GET file-api/workbox-file-server/file-api/v1/folders/2485554
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Tue, 05 Apr 2022 01:44:52 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 38phmcpj30dr23cd9j68p34d9n 
{
  "id": 2485554,
  "type": 1,
  "folderType": 1,
  "path": "gildong001",
  "uprFolderId": 0,
  "size": 5076,
  "creYmdt": "2022-04-05T01:01:28.962+0000",
  "modYmdt": "2022-04-05T01:29:06.586+0000",
  "allSubFoldersCount": 0,
  "allSubFilesCount": 1,
  "creator": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "gildong hong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "modifier": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "gildong hong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "uploadYmdt": null,
  "userModYmdt": "2022-04-05T01:29:06.586+0000"
}

Create folder API

Creates a folder.

Request URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/{folderId}

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request path parameter

Parameter Type Requirement status Description
folderId long Y Folder ID (FolderId)

Request body parameter

Parameter Type Requirement status Description
action Integer Y Action
folderName String Y Folder name

Request examples

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/2485554

POST /file-api/workbox-file-server/file-api/v1/folders/2485554
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr
{
  "action": 1,
  "folderName": "string"
}

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Tue, 05 Apr 2022 06:52:56 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 36chj6srj4d3430db16lhmaopj 
{
  "folderType": 1,
  "creator": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "gildong hong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "uprFolderId": 2485554,
  "creYmdt": "2022-04-05T06:52:56.047+0000",
  "sharedMemberCount": 0,
  "sharedMembers": [],
  "id": 2487419,
  "name": "string",
  "path": "gildong001/string",
  "type": 1
}

Delete API

Delete a folder.

Request URL

DELETE https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/{folderId}

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request path parameter

Parameter Type Requirement status Description
folderId Long Y Folder ID (FileId)

Request examples

DELETE https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/2487419

DELETE /file-api/workbox-file-server/file-api/v1/folders/2487419
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-length: 0 
date: Tue, 05 Apr 2022 07:07:39 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 68d1i6gqj8cpi3ed9g60p34dhh 

Modify API

Modifies the folder name.

Request URL

PATCH https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/{folderId}

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request path parameter

Parameter Type Requirement status Description
folderId Long Y Folder ID (FolderId)

Request body parameter

Parameter Type Requirement status Description
folderId String Y Folder ID
newName String Y Name to be changed to

Request examples

PATCH https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/3387636

PATCH /file-api/workbox-file-server/file-api/v1/folders/3387636
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr
{
    "folderId": "2485554",
    "newName": "test_0001"
}

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-length: 0 
date: Tue, 05 Apr 2022 01:29:09 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 66dj46hgmad9l3eor46cs38dpm

Copy folder API

Copies the specified folder to a specific folder.

Request URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/copy-batch

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request body parameter

Parameter Type Requirement status Description
folders List<FolderItem> Y Folder information

Request examples

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/copy-batch

POST /file-api/workbox-file-server/file-api/v1/folders/copy-batch
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr
{
  "folders": [
    {
      "action": 1,
      "destFolderId": 2485554,
      "folderType": 1,
      "id": 2486398
    },
    {
      "action": 1,
      "destFolderId": 2485554,
      "folderType": 2,
      "id": 2485768
    }
  ]
}

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Wed, 06 Apr 2022 02:10:29 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 6adb66oo3ae1p36cr3cdim6dpn 
{
  "conflictContents": []
}

Move folder API

Moves the specified folder to a specific folder.

Request URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/move-batch

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request body parameter

Parameter Type Requirement status Description
folders List<FolderItem> Y Folder information
topMoveFolders List<Integer> N The value is configured by pairing the ID of the folder to be moved and the ID of the folder to be moved to.

Request examples

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/move-batch

POST /file-api/workbox-file-server/file-api/v1/folders/move-batch
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr
{
  "folders": [
    {
      "action": 1,
      "destFolderId": 2485554,
      "folderType": 2,
      "id": 2485768
    }
  ],
  "topMoveFolders": [
    2485768, 2485554
  ]
}

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Wed, 06 Apr 2022 01:58:27 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 30e9h6hgjadb230e31c8qj8c1p 
{
  "conflictContents": [],
  "topMoveFolders": [
    2485768,
    2485554
  ]
}

Search subfolder list API

Searches the subfolder list of a specified folder.

Request URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/{folderId}/list

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request path parameter

Parameter Type Requirement status Description
folderId Long Y Folder ID (FolderId)

Request body parameter

Parameter Type Requirement status Description
includeFile Boolean Y File inclusion status
includeFolder Boolean Y Folder inclusion status
onlyGenByMe Boolean Y Whether to include only the files/folders you created
pageNum Integer Y Page number
pageSize Integer Y Page size

Request examples

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/2485554/list

POST /file-api/workbox-file-server/file-api/v1/folders/2485554/list
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr
{
  "includeFile": true,
  "includeFolder": true,
  "onlyGenByMe": true,
  "pageNum": 1,
  "pageSize": 10
}

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Tue, 05 Apr 2022 05:17:40 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 62p1j70p64cr368d1i65h3ec9p

{
  "total": 2,
  "pageNum": 1,
  "pageSize": 10,
  "totalPage": 1,
  "folderId": 2485554,
  "folderName": "gildong001",
  "folderPath": "gildong001",
  "folderType": 1,
  "uprFolderId": 0,
  "masters": [
    {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "gildong hong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    }
  ],
  "creator": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "gildong hong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "creYmdt": "2022-04-05T01:01:28.962+0000",
  "modifier": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "gildong hong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "modYmdt": "2022-04-05T01:29:06.586+0000",
  "sharedMemberCount": 1,
  "folderAuth": 1,
  "companyName": "REAL workbox1",
  "starred": false,
  "hasSubFolder": true,
  "resources": [
    {
      "id": 2486666,
      "name": "0001",
      "path": "gildong001/0001",
      "size": 0,
      "type": 1,
      "folderType": 1,
      "uprFolderId": 2485554,
      "rootFolderId": 2485554,
      "creator": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T05:16:43.578+0000",
      "modifier": {
        "us+E5erId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "modYmdt": "2022-04-05T05:16:43.578+0000",
      "sharedMemberCount": 1,
      "folderAuth": 1,
      "hasSubFolder": true,
      "prohibited": false,
      "prohibitCode": 0,
      "checkSum": null,
      "masters": [
        {
          "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
          "userNm": "gildong hong",
          "userPhoto": null,
          "loginId": "gildong@sample.co.kr"
        }
      ],
      "userModYmdt": "2022-04-05T05:16:43.578+0000",
      "fullText": null,
      "thumbnailUrl": null,
      "starred": false,
      "isStarred": false,
      "userModYmdtMills": 1649135803578
    },
    {
      "id": 18614377,
      "name": "test_newName_0001",
      "path": "gildong001/test_newName_0001",
      "size": 5076,
      "type": 2,
      "folderType": 1,
      "uprFolderId": 2485554,
      "rootFolderId": 2485554,
      "creator": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T01:04:32.185+0000",
      "modifier": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "modYmdt": "2022-04-05T04:18:02.416+0000",
      "sharedMemberCount": 1,
      "folderAuth": 1,
      "hasSubFolder": false,
      "prohibited": false,
      "prohibitCode": 0,
      "checkSum": "013faeb7b49494ffec714a3536cc079c",
      "masters": [
        {
          "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
          "userNm": "gildong hong",
          "userPhoto": null,
          "loginId": "gildong@sample.co.kr"
        }
      ],
      "userModYmdt": "2022-04-05T01:04:32.185+0000",
      "fullText": null,
      "thumbnailUrl": null,
      "starred": false,
      "isStarred": false,
      "userModYmdtMills": 1649120672185
    }
  ],
  "ancestors": [],
  "isStarred": false
}

Search personal folder list API

Searches the list of files and subfolders under a personal folder.

Request URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/private-list

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request body parameter

Parameter Type Requirement status Description
pageNum int Y Page number
pageSize int Y Page size

Request examples

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/private-list

POST /file-api/workbox-file-server/file-api/v1/folders/private-list
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr
{
    "pageNum": 1,
    "pageSize": 10
}

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Tue, 05 Apr 2022 02:07:01 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 3id34c8omcohl38cpk75i68cb2 
{
  "rootFolderId": 2242698,
  "total": 1,
  "pageNum": 1,
  "pageSize": 10,
  "totalPage": 1,
  "resourceVos": [
    {
      "id": 2485768,
      "name": "test_pri_0001",
      "path": "test_pri_0001",
      "size": 0,
      "type": 1,
      "folderType": 2,
      "uprFolderId": 2242698,
      "rootFolderId": 2242698,
      "creator": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T01:57:06.844+0000",
      "modifier": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "modYmdt": "2022-04-05T01:57:06.844+0000",
      "sharedMemberCount": 1,
      "folderAuth": 1,
      "hasSubFolder": false,
      "prohibited": false,
      "prohibitCode": 0,
      "checkSum": null,
      "masters": [
        {
          "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
          "userNm": "gildong hong",
          "userPhoto": null,
          "loginId": "gildong@sample.co.kr"
        }
      ],
      "userModYmdt": "2022-04-05T01:57:06.844+0000",
      "fullText": null,
      "thumbnailUrl": null,
      "starred": false,
      "isStarred": false,
      "userModYmdtMills": 1649123826844
    }
  ]
}

Folder download API

Downloads the files and subfolders in a folder.

Request URL

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/{folderId}/download-zip

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request path parameter

Parameter Type Requirement status Description
folderId Long Y Folder ID (FolderId)

Request examples

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/2485554/download-zip

GET /file-api/workbox-file-server/file-api/v1/folders/2485554/download-zip
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-max-age: 3600 
connection: keep-alive 
content-disposition: attachment;filename*=UTF-8''gildong_20220405.zip 
content-type: application/zip 
date: Tue, 05 Apr 2022 01:28:08 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
E5 transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 3ce1ocosjae1h36phn6hh3ep1p 

Downloads the gildong_20220405.zip file

Search shared folder list API

Searches the list of folders that exist under the top level shared folder.

Request URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/shared-list

Request header

Header name Description
x-ncp-apigw-timestamp This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Value of access key ID issued on the NAVER Cloud Platform portal
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-workbox-loginId Login email address for WORKBOX service
x-ncp-workbox-loginId:{Login ID}
Content-Type It specifies the content type of the request body as application/json.
Content-Type: application/json

Request examples

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/folders/shared-list

POST /file-api/workbox-file-server/file-api/v1/folders/shared-list
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp : 1649054672370
x-ncp-iam-access-key: toAvmFdP1rtPTMz2dpdy
x-ncp-apigw-signature-v2 : sks3TlqeoWnd08TkfdmfAjrdjTekRhRlAhRhWlvmeka=
x-ncp-workbox-loginId : gildong@sample.co.kr

Response examples

HTTP/1.1 200 OK
access-control-allow-credentials: true 
access-control-allow-methods: GET,POST,PUT,DELETE,OPTIONS 
access-control-allow-origin: https://workbox.apigw.ntruss.com 
access-control-max-age: 3600 
connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Tue, 12 Apr 2022 01:07:31 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
transfer-encoding: chunked 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 34cr1c9gjecr364c33cgr66or4 
[
  {
    "id": 2485554,
    "name": "gildong001",
    "path": "gildong001",
    "size": 0,
    "type": 1,
    "folderType": 1,
    "uprFolderId": 0,
    "rootFolderId": 2485554,
    "creator": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "gildong hong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "creYmdt": "2022-04-05T01:01:28.962+0000",
    "modifier": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "gildong hong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "modYmdt": "2022-04-05T01:29:06.586+0000",
    "sharedMemberCount": 1,
    "folderAuth": 1,
    "hasSubFolder": true,
    "prohibited": false,
    "prohibitCode": 0,
    "checkSum": null,
    "masters": [
      {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      }
    ],
    "userModYmdt": "2022-04-05T01:29:06.586+0000",
    "fullText": null,
    "thumbnailUrl": null,
    "starred": false,
    "isStarred": false,
    "userModYmdtMills": 1649122146586
  },
  {
    "id": 2486398,
    "name": "gildong002",
    "path": "gildong002",
    "size": 0,
    "type": 1,
    "folderType": 1,
    "uprFolderId": 0,
    "rootFolderId": 2486398,
    "creator": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "gildong hong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "creYmdt": "2022-04-05T04:19:22.618+0000",
    "modifier": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "gildong hong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "modYmdt": "2022-04-05T04:19:22.623+0000",
    "sharedMemberCount": 1,
    "folderAuth": 1,
    "hasSubFolder": false,
    "prohibited": false,
    "prohibitCode": 0,
    "checkSum": null,
    "masters": [
      {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "gildong hong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      }
    ],
    "userModYmdt": "2022-04-05T04:19:22.623+0000",
    "fullText": null,
    "thumbnailUrl": null,
    "starred": false,
    "isStarred": false,
    "userModYmdtMills": 1649132362623
  }
]

Response

Returned as an HTTP status code and delivered as body information.

HTTP status code Response message Description
200 OK General request made successfully
201 Created Resource successfully created
400 Bad Request Used for general request failure (usually used to respond to a request format that the server can't understand)
500 Internal Server Error - Response code to general server errors
While 4xx error codes represent client-side errors,
5xx error codes represent server-side errors.

Type

Code Description
1 Folder
2 File

Folder type

Code Description
1 Public (shared folder)
2 Private (personal folder)

Action

Code Description
1 Normal (skip), default
2 Overwrite
3 Rename

FolderItem

Parameter Type Requirement status Description
id long Y Folder ID
destFolderId Long Y ID of the folder where the copied folder will be located
action int N Action
folderType Integer N Folder type

Was this article helpful?

What's Next