Folder

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

API for managing folders in WORKBOX

Query API

Queries folder information

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	long	Y	Folder ID

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": "Honggildong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "modifier": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "Honggildong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "uploadYmdt": null,
  "userModYmdt": "2022-04-05T01:29:06.586+0000",
  "lock": null,
  "onlineEditUrl": null
}

Parameter	Type	Description
id	long	Folder ID
type	Integer	Type
folderType	Integer	Folder type
path	String	Folder path
uprFolderId	long	Parent folder ID (0 : top-level folder)
size	long	Size
creYmdt	Date	Creation date and time (yyyy-MM-dd'T'HH:mm:ss.SSSZ)
modYmdt	Date	Modification date and time (yyyy-MM-dd'T'HH:mm:ss.SSSZ)
allSubFoldersCount	long	Number of subfolders
allSubFilesCount	long	Number of subfiles
creator	UserVo	Creator (user)
modifier	UserVo	Modifier (user)
uploadYmdt	Date	Upload date and time (null if folder type)
lock	FileLockInfoVo	File lock info (null if folder type)
onlineEditUrl	String	Online edit URL (null if folder type)

Folder create API

Creates a folder.

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	long	Y	Folder ID

Request body parameters

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": "Honggildong",
    "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
}

Parameter	Type	Description
folderType	Integer	Folder type
creator	UserVo	Creator
uprFolderId	long	Parent folder ID
creYmdt	Date	Creation date and time (yyyy-MM-dd'T'HH:mm:ss.SSSZ)
sharedMemberCount	int	Number of shared users
sharedMembers	List<UserVo>	Shared user list
id	long	Folder ID
name	String	Folder name
path	String	Folder path
type	Integer	Type

Folder permission API

Specifies folder permissions

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	long	Y	Folder ID

Request body parameters

Parameter	Type	Requirement status	Description
addFolderAuth	List	Y	Account info of user to whom folder permission is to be assigned
deleteFolderAuth	List	Y	Account info of user from whom folder permission is to be removed

Request examples


POST /file-api/workbox-file-server/file-api/v1/folders/2485554/auth
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
{
  "addFolderAuth": [gildong001@sample.co.kr,gildong002@sample.co.kr]
}

Response examples

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

Delete API

Deletes a folder.

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	Long	Y	Folder ID

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

Edit API

Modifies folder name

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	Long	Y	Folder ID

Request body parameters

Parameter	Type	Requirement status	Description
folderId	String	Y	Folder ID
newName	String	Y	New name

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

Folder copy API

Copies a specific folder to another folder

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request body parameters

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

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": []
}

Parameter	Type	Description
conflictContents	List<CopyResultItem>	Duplicate folder history (folder name conflict)

Folder move API

Moves a specific folder to another folder

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request body parameters

Parameter	Type	Requirement status	Description
folders	`List<FolderItem>`	Y	Folder info
topMoveFolders	`List<Integer>`	N	Set value by pairing the ID of the folder to be moved with the ID of the destination folder

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
  ]
}

Parameter	Type	Description
conflictContents	List<CopyResultItem>	Duplicate folder history (folder name conflict)
topMoveFolders	List	Set value by pairing the ID of the folder to be moved with the ID of the destination folder

Subfolder list query API

Queries a list of subfolders in a specified folder

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	Long	Y	Folder ID

Request body parameters

Parameter	Type	Requirement status	Description
includeFile	Boolean	Y	File inclusion status
includeFolder	Boolean	Y	Folder inclusion status
onlyGenByMe	Boolean	Y	Whether to include only self-created files/folders
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": "Honggildong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    }
  ],
  "creator": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "Honggildong",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "creYmdt": "2022-04-05T01:01:28.962+0000",
  "modifier": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "Honggildong",
    "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": "Honggildong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T05:16:43.578+0000",
      "modifier": {
        "us+E5erId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "Honggildong",
        "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": "Honggildong",
          "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": "Honggildong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T01:04:32.185+0000",
      "modifier": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "Honggildong",
        "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": "Honggildong",
          "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
}

Parameter	Type	Description
total	Integer	Total number of queries
pageNum	Integer	Page number
pageSize	Integer	Page size
totalPage	Integer	Total number of pages
folderId	long	Folder ID
folderName	String	Folder name
folderPath	String	Folder path
folderType	Integer	Folder type
uprFolderId	long	Parent folder ID
masters	List<UserVo>	Master authority list
creator	UserVo	Creator info
creYmdt	Date	Creation date
modifier	UserVo	Modifier info
modYmdt	Date	Modification date
sharedMemberCount	long	Number of shared users
folderAuth	Integer	Folder permissions
resourceVos	List<ResourceVo>	Resource list
ancestors	List<AncestorFolderVo>	Parent folder list
companyName	String	Company name
isStarred	boolean	Favorites status

Private folder list query API

Queries a list of files and subfolders in a private folder

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request body parameters

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": "Honggildong",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T01:57:06.844+0000",
      "modifier": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "Honggildong",
        "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": "Honggildong",
          "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
    }
  ]
}

Parameter	Type	Description
rootFolderId	long	Top-level folder ID
total	Integer	Total number of queries
pageNum	Integer	Page number
pageSize	Integer	Page size
totalPage	Integer	Total number of pages
resourceVos	List<ResourceVo>	Resource list

Folder download API

Downloads files and subfolders from a folder

Request URL

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

Request headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to application/json `Content-Type: application/json`

Request path parameters

Parameter	Type	Requirement status	Description
folderId	Long	Y	Folder ID

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 

gildong_20220405.zip file download

Shared folder list query API

Queries a list of folders in 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 headers

Header	Description
x-ncp-apigw-timestamp	It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued from the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	Login email address for WORKBOX `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Set the request body content type to 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": "Honggildong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "creYmdt": "2022-04-05T01:01:28.962+0000",
    "modifier": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "Honggildong",
      "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": "Honggildong",
        "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": "Honggildong",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "creYmdt": "2022-04-05T04:19:22.618+0000",
    "modifier": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "Honggildong",
      "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": "Honggildong",
        "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
  }
]

Type	Description
List<ResourceVo>	Resource list

Responses

Returned as HTTP status codes in the response body

HTTP status code	Response message	Description
200	OK	Normal successful request
201	Created	Successful resource creation
400	Bad Request	Request failure (common response when a request received is in a format that the server cannot parse)
500	Internal Server Error	- Common server error Error codes in the 400 range indicate client-side errors Error codes in the 500 range indicate server-side errors

Types

Code	Description
1	Folder
2	File

Folder types

Code	Description
1	Public folder (shared)
2	Private folder

Folder permissions

Code	Description
1	Master (admin)
2	Write
3	Read

Actions

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

Reasons for prohibited action

Code	Description
0	NONE
1	PROHIBITED
2	MALICIOUS
3	REPORTED
4	BLOCKED

FolderItem

Parameter	Type	Requirement status	Description
id	long	Y	Folder ID
destFolderId	Long	Y	- ID of the destination folder to which the file will be copied
action	int	N	Action
folderType	Integer	N	Folder type

UserVo

Parameter	Type	Description
userId	String	User ID
userNm	String	User name
userPhoto	String	URL for user photo
loginId	String	Login ID

FileLockInfoVo

Parameter	Type	Description
fileId	long	File ID
creYmdt	Date	Creation date and time
createUserId	String	Creator’s user ID
createUser	UserVo	Creator (user)

CopyResultItem

Parameter	Type	Description
destFolderId	long	Destination folder ID
src	CopyResultContentItem	Destination folder info
exist	CopyResultContentItem	Duplicate folder info
canOverwrite	boolean	Overwrite status

CopyResultContentItem

Parameter	Type	Description
name	String	Target name
type	int	Type
size	long	Size
creYmdt	Date	Creation date and time
modYmdt	Date	Modification date and time
lock	FileLockInfoVo	Locked file info

ResourceVo

Parameter	Type	Description
id	long	File or folder ID
name	String	File name or file ID
size	long	Size
type	Integer	Type
folderType	Integer	Folder type
uprFolderId	long	Parent folder ID
rootFolderId	long	Top-level folder ID (if type is folder)
creator	UserVo	Creator info
creYmdt	Date	Creation date and time
modifier	UserVo	Modifier info
modYmdt	Date	Modification date and time
sharedMemberCount	long	Number of shared users
folderAuth	Integer	Folder permissions
isStarred	boolean	Favorites status
hasSubFolder	boolean	Subfolder presence status
prohibited	boolean	Prohibition status
prohibitCode	int	Reason for prohibited action
checkSum	String	Checksum if file, null if folder
masters	List<UserVo>	Master user info
userModYmdt	Date	User modification date and time
fullText	String
thumbnailUrl	String	Thumbnail URL
lock	FileLockInfoVo	Locked file info

AncestorFolderVo

Parameter	Type	Description
folderId	long	Folder ID
folderType	Integer	Folder type
folderPath	String	Folder path
folderName	String	Folder name

Was this article helpful?

What's Next

File