フォルダ

印刷する
共有
PDF

フォルダ

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

WORKBOXサービスのフォルダ管理のための APIです。

照会 API

フォルダ情報を照会します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	long	Y	フォルダ ID(FolderId)

リクエスト例

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

レスポンス例

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

パラメータ	タイプ	説明
id	long	フォルダ ID(FolderId)
type	Integer	タイプ
folderType	Integer	フォルダタイプ
path	String	フォルダパス
uprFolderId	long	上位フォルダ ID(0:最上位)
size	long	容量
creYmdt	Date	作成日時(yyyy-MM-dd「T」HH:mm:ss.SSSZ)
modYmdt	Date	修正日時(yyyy-MM-dd「T」HH:mm:ss.SSSZ)
allSubFoldersCount	long	下位フォルダ数
allSubFilesCount	long	下位ファイル数
creator	UserVo	作成者
modifier	UserVo	修正者
uploadYmdt	Date	アップロード日時(フォルダタイプ日時 null)
lock	FileLockInfoVo	ファイルロックの情報(フォルダタイプ日時 null)
onlineEditUrl	String	オンライン編集リンク URL(フォルダタイプ日時 null)

フォルダ作成 API

フォルダを作成します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	long	Y	フォルダ ID(FolderId)

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
action	Integer	Y	アクション
folderName	String	Y	フォルダ名

リクエスト例

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

レスポンス例

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": "山田太郎",
    "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
}

パラメータ	タイプ	説明
folderType	Integer	フォルダタイプ
creator	UserVo	作成者
uprFolderId	long	上位フォルダ ID
creYmdt	Date	作成日時(yyyy-MM-dd「T」HH:mm:ss.SSSZ)
sharedMemberCount	int	共有したユーザー数
sharedMembers	List<UserVo>	共有したユーザーリスト
id	long	フォルダ ID
name	String	フォルダ名
path	String	フォルダパス
type	Integer	タイプ

フォルダ権限の指定 API

フォルダの権限を指定します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	long	Y	フォルダ ID(FolderId)

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
addFolderAuth	List	Y	フォルダの権限を追加するユーザーアカウントの情報
deleteFolderAuth	List	Y	フォルダの権限を削除するユーザーアカウントの情報

リクエスト例


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

レスポンス例

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

削除 API

フォルダを削除します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	Long	Y	フォルダ ID(FileId)

リクエスト例

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

レスポンス例

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

修正 API

フォルダ名を修正します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	Long	Y	フォルダ ID(FolderId)

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
folderId	String	Y	フォルダ ID
newName	String	Y	変更する名前

リクエスト例

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

レスポンス例

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

フォルダコピー API

特定のフォルダに指定したフォルダをコピーします。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
folders	`List<FolderItem>`	Y	フォルダ情報

リクエスト例

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

レスポンス例

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

パラメータ	タイプ	説明
conflictContents	List<CopyResultItem>	重複した発生状況の内訳

フォルダ移動 API

特定のフォルダに指定したフォルダを移動します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
folders	`List<FolderItem>`	Y	フォルダ情報
topMoveFolders	`List<Integer>`	N	移動させるフォルダ ID、移動先のフォルダ IDをセットにして値を設定

リクエスト例

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

レスポンス例

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

パラメータ	タイプ	説明
conflictContents	List<CopyResultItem>	重複した発生状況の内訳
topMoveFolders	List	移動させるフォルダ ID、移動先のフォルダ IDをセットにして値を設定

下位フォルダリストの照会 API

指定フォルダの下位リストを照会します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	Long	Y	フォルダ ID(FolderId)

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
includeFile	Boolean	Y	ファイルの包含有無
includeFolder	Boolean	Y	フォルダの包含有無
onlyGenByMe	Boolean	Y	本人が作成したファイル/フォルダのみの包含有無
pageNum	Integer	Y	ページ番号
pageSize	Integer	Y	ページサイズ

リクエスト例

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
}

レスポンス例

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": "山田太郎",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    }
  ],
  "creator": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "山田太郎",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "creYmdt": "2022-04-05T01:01:28.962+0000",
  "modifier": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "山田太郎",
    "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": "山田太郎",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T05:16:43.578+0000",
      "modifier": {
        "us+E5erId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "山田太郎",
        "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": "山田太郎",
          "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": "山田太郎",
        "userPhoto": null,
        "loginId": "gildong@sample.co.kr"
      },
      "creYmdt": "2022-04-05T01:04:32.185+0000",
      "modifier": {
        "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
        "userNm": "山田太郎",
        "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": "山田太郎",
          "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
}

パラメータ	タイプ	説明
total	Integer	全ての照会数
pageNum	Integer	ページ番号
pageSize	Integer	ページサイズ
totalPage	Integer	全ページ
folderId	long	フォルダ ID
folderName	String	フォルダ名
folderPath	String	フォルダパス
folderType	Integer	フォルダタイプ
uprFolderId	long	上位フォルダ ID
masters	List<UserVo>	マスター権限を持つユーザーリスト
creator	UserVo	作成者の情報
creYmdt	Date	作成日時
modifier	UserVo	修正者の情報
modYmdt	Date	修正日時
sharedMemberCount	long	共有したメンバー数
folderAuth	Integer	フォルダ権限
resourceVos	List<ResourceVo>	リソースリスト
ancestors	List<AncestorFolderVo>	上位フォルダリスト
companyName	String	会社名
isStarred	boolean	ブックマークの有無

個人フォルダリストの照会 API

個人フォルダ内のファイルおよび下位フォルダリストを照会します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
pageNum	int	Y	ページ番号
pageSize	int	Y	ページサイズ

リクエスト例

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
}

レスポンス例

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

パラメータ	タイプ	説明
rootFolderId	long	最上位フォルダ ID
total	Integer	全ての照会数
pageNum	Integer	ページ番号
pageSize	Integer	ページサイズ
totalPage	Integer	全ページ
resourceVos	List<ResourceVo>	リソースリスト

フォルダダウンロード API

フォルダにあるファイルと下位フォルダをダウンロードします。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
folderId	Long	Y	フォルダ ID(FolderId)

リクエスト例

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

レスポンス例

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ファイルダウンロード

共有フォルダリストの照会 API

最上位共有フォルダ内に存在するフォルダリストを照会します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルから発行された Access Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-workbox-loginId	WORKBOXサービスのログインメールアドレス `x-ncp-workbox-loginId:{Login ID}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエスト例

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

レスポンス例

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": "山田太郎",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "creYmdt": "2022-04-05T01:01:28.962+0000",
    "modifier": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "山田太郎",
      "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": "山田太郎",
        "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": "山田太郎",
      "userPhoto": null,
      "loginId": "gildong@sample.co.kr"
    },
    "creYmdt": "2022-04-05T04:19:22.618+0000",
    "modifier": {
      "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
      "userNm": "山田太郎",
      "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": "山田太郎",
        "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
  }
]

タイプ	説明
List<ResourceVo>	リソースリスト

レスポンス

HTTPステータスコードでリターンされ、 Body情報として転送します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
201	Created	リソース作成成功に対するレスポンスコード
400	Bad Request	一般的なリクエスト失敗に使用(多くの場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード 4XX番台のエラーコードが、クライアント側のエラーを表示するために使用され、 5XX番台のエラーコードは、サーバ側のエラーを表示するために使用される

タイプ

コード	説明
1	フォルダ
2	ファイル

フォルダタイプ

コード	説明
1	Public(共有フォルダ)
2	Private(個人フォルダ)

フォルダ権限

コード	説明
1	Master(管理者)
2	Write(書く)
3	Read(読む)

アクション

コード	説明
1	Normal(スキップ)、デフォルト値
2	Overwrite(上書き)
3	Rename(名前変更)

禁止事由

コード	説明
0	NONE
1	PROHIBITED
2	MALICIOUS
3	REPORTED
4	BLOCKED

FolderItem

パラメータ	タイプ	要否	説明
id	long	Y	フォルダ ID
destFolderId	Long	Y	コピーされたフォルダが位置するフォルダ ID
action	int	N	アクション
folderType	Integer	N	フォルダタイプ

UserVo

パラメータ	タイプ	説明
userId	String	ユーザー ID
userNm	String	ユーザー名
userPhoto	String	ユーザー画像 URL Link
loginId	String	ログイン ID

FileLockInfoVo

パラメータ	タイプ	説明
fileId	long	ファイル ID
creYmdt	Date	作成日時
createUserId	String	作成したユーザー ID
createUser	UserVo	作成したユーザー

CopyResultItem

パラメータ	タイプ	説明
destFolderId	long	対象フォルダ ID
src	CopyResultContentItem	対象フォルダの情報
exist	CopyResultContentItem	重複したフォルダの情報
canOverwrite	boolean	上書きの有無

CopyResultContentItem

パラメータ	タイプ	説明
name	String	対象名
type	int	タイプ
size	long	容量
creYmdt	Date	作成日時
modYmdt	Date	修正日時
lock	FileLockInfoVo	ロックされたファイルの情報

ResourceVo

パラメータ	タイプ	説明
id	long	ファイル IDまたはフォルダ ID
name	String	ファイル名またはファイル ID
size	long	容量
type	Integer	タイプ
folderType	Integer	フォルダタイプ
uprFolderId	long	上位フォルダ ID
rootFolderId	long	最上位フォルダ ID(タイプがフォルダの場合)
creator	UserVo	作成者の情報
creYmdt	Date	作成日時
modifier	UserVo	修正者の情報
modYmdt	Date	修正日時
sharedMemberCount	long	共有したユーザー数
folderAuth	Integer	フォルダ権限
isStarred	boolean	ブックマーク登録の確認
hasSubFolder	boolean	下位フォルダの有無
prohibited	boolean	禁止の可否
prohibitCode	int	禁止事由
checkSum	String	ファイルの場合にチェックサム、フォルダの場合に null
masters	List<UserVo>	マスターユーザーの情報
userModYmdt	Date	ユーザーの修正日時
fullText	String
thumbnailUrl	String	サムネイル URL
lock	FileLockInfoVo	ロックされたファイルの情報

AncestorFolderVo

パラメータ	タイプ	説明
folderId	long	フォルダ ID
folderType	Integer	フォルダタイプ
folderPath	String	フォルダパス
folderName	String	フォルダ名

この記事は役に立ちましたか?

What's Next

ファイル