ファイル
  • 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 リクエストボディのコンテンツタイプをapplication/jsonに指定
Content-Type: application/json

リクエストパスパラメータ

パラメータ タイプ 必須の有無 説明
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"
}

削除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 リクエストボディのコンテンツタイプをapplication/jsonに指定
Content-Type: application/json

リクエストパスパラメータ

パラメータ タイプ 必須の有無 説明
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 リクエストボディのコンテンツタイプをapplication/jsonに指定
Content-Type: application/json

リクエストパスパラメータ

パラメータ タイプ 必須の有無 説明
fileId Long Y ファイルID(FileId)

リクエストクエリパラメータ

パラメータ タイプ 必須の有無 説明
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 リクエストボディのコンテンツタイプをapplication/jsonに指定
Content-Type: application/json

リクエストパスパラメータ

パラメータ タイプ 必須の有無 説明
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 リクエストボディのコンテンツタイプをmultipart/form-dataに指定
Content-Type: multipart/form-data

リクエストクエリパラメータ

パラメータ タイプ 必須の有無 説明
action int Y 1:Nomal 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
}

ファイルコピー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 リクエストボディのコンテンツタイプをapplication/jsonに指定
Content-Type: application/json

リクエストボディパラメータ

パラメータ タイプ 必須の有無 説明
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": []
}

ファイル移動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 リクエストボディのコンテンツタイプをapplication/jsonに指定
Content-Type: application/json

リクエストボディパラメータ

パラメータ タイプ 必須の有無 説明
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
  ]
}

レスポンス

HTTPステータスコードでリターンされ、ボディ情報として伝達する。

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

アクション

コード 説明
1 Nomal(飛ばして進む)、デフォルト値
2 Overwrite(上書き)
3 Rename(名前変更)

FileItem

パラメータ タイプ 必須の有無 説明
id long Y ファイルID
destFolderId Long Y コピーされたファイルが位置するフォルダID、0にセッティングすると最上位フォルダ
action int N アクション

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

What's Next