ファイル

印刷する
共有
PDF

ファイル

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

説明

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

照会 API

ファイル情報を照会する。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
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パラメータ

パラメータ	タイプ	要否	説明
fileId	long	Y	ファイル ID(FileId)

リクエスト例

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/18614377

GET file-api/workbox-file-server/file-api/v1/files/18614377
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:05:10 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: 32p9p70p32pj36acph6com2p1g 
{
  "id": 18614377,
  "type": 2,
  "folderType": 1,
  "path": "gildong/naver.jpg",
  "uprFolderId": 2485554,
  "size": 5076,
  "creYmdt": "2022-04-05T01:04:32.185+0000",
  "modYmdt": "2022-04-05T01:04:32.000+0000",
  "allSubFoldersCount": 0,
  "allSubFilesCount": 0,
  "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": "2022-04-05T01:04:32.000+0000",
  "userModYmdt": "2022-04-05T01:04:32.185+0000",
  "onlineEditUrl": "https://sample.ncloudworkbox.com/LinkOnlineEdit/18614377"
}

パラメータ	タイプ	説明
id	long	ファイル ID(FileId)
name	String	ファイル名
type	Integer	タイプ
folderType	Integer	フォルダのタイプ
path	String	ファイルパス
uprFolderId	long	上位フォルダ ID
size	long	容量
creYmdt	Date	作成日時
modYmdt	Date	修正日時
allSubFoldersCount	long	下位フォルダ数
allSubFilesCount	long	下位ファイル数
creator	UserVo	作成者の情報
modifier	UserVo	修正者の情報
uploadYmdt	Date	アップロード日時
userModYmdt	Date	ユーザーの修正日時
lock	FileLockInfoVo	ファイルのロック情報
onlineEditUrl	String	ファイルのオンライン編集 URL

削除 API

ファイルを削除します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
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パラメータ

パラメータ	タイプ	要否	説明
fileId	Long	Y	ファイル ID(FileId)

リクエスト例

DELETE https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/18629575

DELETE /file-api/workbox-file-server/file-api/v1/files/18629575
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 06:10:21 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 3copjc5i32opj3gd9i74sjgcr2

修正 API

ファイル名を修正します。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
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パラメータ

パラメータ	タイプ	要否	説明
fileId	Long	Y	ファイル ID(FileId)

リクエスト Queryパラメータ

パラメータ	タイプ	要否	説明
newName	String	Y	変更する名前

リクエスト例

PATCH https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/18614377?newName=test_newName_0001

PATCH /file-api/workbox-file-server/file-api/v1/files/18614377?newName=test_newName_0001
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 04:18:02 GMT 
 server: nginx 
 strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
 x-ncp-apigw-response-origin: ENDPOINT 
 x-ncp-trace-id: 32c1o75hmae1j68c1p6oom4d1j

ファイルのダウンロード API

ファイルをダウンロードします。

リクエスト URL

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/{fileId}/download

リクエストヘッダ

ヘッダ名	説明
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パラメータ

パラメータ	タイプ	要否	説明
fileId	Long	Y	ファイル ID(FileId)

リクエスト例

GET https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/18618459/download

GET /file-api/workbox-file-server/file-api/v1/files/18618459/download
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''naver.jpg 
content-length: 5076 
content-type: image/jpeg 
date: Tue, 05 Apr 2022 04:26:42 GMT 
server: nginx 
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000; includeSubDomains 
x-ncp-apigw-response-origin: ENDPOINT 
x-ncp-trace-id: 3gp326tj38pho38ohp6os38opm 
파일 다운로드

ファイルのアップロード API

特定のフォルダにファイルをアップロードします。

リクエスト URL

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

リクエストヘッダ

ヘッダ名	説明
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を multipart/form-dataに指定 `Content-Type: multipart/form-data`

リクエスト Queryパラメータ

パラメータ	タイプ	要否	説明
action	int	Y	1: Normal 2: Overwrite 3: Rename
size	int	Y	ファイルサイズ
actionForm	formData	N	formで転送する際に利用される formData
file	formData	Y	アップロードするファイル

リクエスト例

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files?action=1&folderId=2485554&size=5076

POST /file-api/workbox-file-server/file-api/v1/files?action=1&folderId=2485554&size=5076
HOST: workbox.apigw.ntruss.com
Content-Type: multipart/form-data
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, 05 Apr 2022 07:21:22 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: 62d9icpgj0pj338cb264qjie1i 
{
  "folderId": 2485554,
  "folderType": 1,
  "fileType": "jpg",
  "creYmdt": "2022-04-05T07:21:21.923+0000",
  "modYmdt": "2022-04-05T07:21:21.923+0000",
  "folderNm": "gildong001",
  "folderPath": "gildong001",
  "creator": {
    "userId": "bb891238-88cf-50f9-572e-9fe0111234a3",
    "userNm": "山田太郎",
    "userPhoto": null,
    "loginId": "gildong@sample.co.kr"
  },
  "filePath": "gildong001/naver.jpg",
  "sharedMemberCount": 0,
  "sharedMembers": null,
  "userModYmdt": "2022-04-05T07:21:21.923+0000",
  "id": 18637745,
  "name": "naver.jpg",
  "size": 5076,
  "userModYmdtMills": 1649143281923
}

パラメータ	タイプ	説明
id	long	ファイル ID
folderId	long	フォルダ ID
folderType	Integer	フォルダタイプ
name	String	ファイル名
size	long	容量
fileType	String	ファイルタイプ
creYmdt	Date	作成日時
modYmdt	Date	修正日時
folderNm	String	フォルダ名
folderPath	String	フォルダパス
creator	UserVo
filePath	String	ファイルパス
sharedMemberCount	int	共有したユーザー数
sharedMembers	List<UserVo>	共有したユーザーリスト
userModYmdt	Date	ユーザーの修正日
userModYmdtMills	long	ユーザーの修正時間

ファイルコピー API

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

リクエスト URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/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パラメータ

パラメータ	タイプ	要否	説明
files	`List<FileItem>`	Y	ファイル情報

リクエスト例

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

POST /file-api/workbox-file-server/file-api/v1/files/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
{
  "files": [
    {
      "action": 1,
      "destFolderId": 2486666,
      "id": 18637745
    },
{
      "action": 1,
      "destFolderId": 2486666,
      "id": 18614377
    }
  ]
}

レスポンス例

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 09:15:42 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: 3cp9i65j66p9j6ae1gc8qjid31 
{
  "conflictContents": []
}

パラメータ	タイプ	説明
conflictContents	List<CopyResultItem>	重複したファイルリスト

ファイル移動 API

特定のフォルダにファイルを移動します。

リクエスト URL

POST https://workbox.apigw.ntruss.com/file-api/workbox-file-server/file-api/v1/files/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パラメータ

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

リクエスト例

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

POST /file-api/workbox-file-server/file-api/v1/files/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
{
  "files": [
    {
      "action": 1,
      "destFolderId": 2485768,
      "id": 18651018
    },
    {
      "action": 1,
      "destFolderId": 2485768,
      "id": 18651017
    }
  ],
"topMoveFolders":[18651018, 2485768, 18651017, 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 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": [
    18651018,
    2485768,
    18651017,
    2485768
  ]
}

パラメータ	タイプ	説明
conflictContents	List<CopyResultItem>	重複したファイルリスト
topMoveFolders	`List<Long>`	移動させるフォルダ ID、移動先のフォルダ IDをセットにして値を設定

レスポンス

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

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

タイプ

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

フォルダタイプ

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

アクション

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

FileItem

パラメータ	タイプ	要否	説明
id	long	Y	ファイル ID
destFolderId	Long	Y	コピーされたファイルが位置するフォルダ ID、0にセッティングすると最上位フォルダ
action	int	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	ロックされたファイルの情報

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

What's Next

Ncloud Chat の概要

説明
照会 API
削除 API
修正 API
ファイルのダウンロード API
ファイルのアップロード API
ファイルコピー API
ファイル移動 API
レスポンス
タイプ
フォルダタイプ
アクション
FileItem
UserVo
FileLockInfoVo
CopyResultItem
CopyResultContentItem

タグ

WORKBOX