폴더

인쇄
공유
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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(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	폴더 아이디(FolderId)
type	Integer	타입
folderType	Integer	폴더 타입
path	String	폴더 경로
uprFolderId	long	상위 폴더 아이디(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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(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	상위 폴더 아이디
creYmdt	Date	생성일시(yyyy-MM-dd'T'HH:mm:ss.SSSZ)
sharedMemberCount	int	공유한 사용자 수
sharedMembers	List<UserVo>	공유한 사용자 리스트
id	long	폴더 아이디
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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(FolderId)

요청 Body 파라미터

파라미터	타입	필수 여부	설명
folderId	String	Y	폴더 아이디
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	네이버 클라우드 플랫폼 포털에서 발급받은 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	네이버 클라우드 플랫폼 포털에서 발급받은 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	이동될 폴더 아이디, 이동할 폴더 아이디로 짝을 지어 값을 설정

요청 예시

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	이동될 폴더 아이디, 이동할 폴더 아이디로 짝을 지어 값을 설정

하위 폴더 리스트 조회 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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(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	폴더 아이디
folderName	String	폴더명
folderPath	String	폴더 경로
folderType	Integer	폴더 타입
uprFolderId	long	상위 폴더 아이디
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	네이버 클라우드 플랫폼 포털에서 발급받은 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	최상위 폴더 아이디
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	네이버 클라우드 플랫폼 포털에서 발급받은 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	폴더 아이디(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	네이버 클라우드 플랫폼 포털에서 발급받은 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	Nomal(넘어가기) 기본값
2	Overwrite(덮어쓰기)
3	Rename(이름변경)

금지 사유

코드	설명
0	NONE
1	PROHIBITED
2	MALICIOUS
3	REPORTED
4	BLOCKED

FolderItem

파라미터	타입	필수 여부	설명
id	long	Y	폴더 아이디
destFolderId	Long	Y	복사된 폴더가 위치할 폴더 아이디
action	int	N	액션
folderType	Integer	N	폴더 타입

UserVo

파라미터	타입	설명
userId	String	사용자 아이디
userNm	String	사용자 이름
userPhoto	String	사용자 사진 URL Link
loginId	String	로그인 아이디

FileLockInfoVo

파라미터	타입	설명
fileId	long	파일 아이디
creYmdt	Date	생성일시
createUserId	String	생성한 사용자 아이디
createUser	UserVo	생성한 사용자

CopyResultItem

파라미터	타입	설명
destFolderId	long	대상 폴더 아이디
src	CopyResultContentItem	대상 폴더 정보
exist	CopyResultContentItem	중복 폴더 정보
canOverwrite	boolean	덮어쓰기 여부

CopyResultContentItem

파라미터	타입	설명
name	String	대상 이름
type	int	타입
size	long	크기
creYmdt	Date	생성일시
modYmdt	Date	수정일시
lock	FileLockInfoVo	잠긴 파일 정보

ResourceVo

파라미터	타입	설명
id	long	파일 아이디 or 폴더 아이디
name	String	파일명 or 파일 아이디
size	long	크기
type	Integer	타입
folderType	Integer	폴더 타입
uprFolderId	long	상위 폴더 아이디
rootFolderId	long	최상위 폴더 아이디(타입이 폴더일경우)
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	폴더 아이디
folderType	Integer	폴더 타입
folderPath	String	폴더 경로
folderName	String	폴더명

이 문서가 도움이 되었습니까?

What's Next

파일