Баримт бичиг / API лавлах
Хавтас
Холбоосыг бүлэглэж, хандалтыг удирдах.
GET/v1/workspaces/{workspaceId}/folders
List the folders the caller can see; each carries effectiveAccess.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.read
Параметр (5)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
search | query | string | | |
page | query | integer (int32) | | |
pageSize | query | integer (int32) | | |
withCounts | query | boolean | | |
Хариу: 200 FolderDto[]
POST/v1/workspaces/{workspaceId}/folders
Create a folder. Free plans get 402 (D9), read/private on Pro 403.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (CreateFolder)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | тийм | |
description | string | | |
accessLevel | string | | `write` (default), `read` or null (private). `read` and null need Business. |
Хариу: 201 FolderDto
PUT/v1/workspaces/{workspaceId}/folders/default
Set (or clear) the caller's default folder. Per user and workspace.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (DefaultFolderBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
folderId | string | | A folder id, or null to clear. |
Хариу: 200 DefaultFolderDto
GET/v1/workspaces/{workspaceId}/folders/{folderId}
Retrieve one folder; 404 when the caller cannot see it.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
Хариу: 200 FolderDto
PATCH/v1/workspaces/{workspaceId}/folders/{folderId}
Edit a folder. Name and description need editor; accessLevel needs owner.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
Хүсэлтийн бие (PatchFolder)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | | |
description | string | | |
accessLevel | string | | |
Хариу: 200 FolderDto
DELETE/v1/workspaces/{workspaceId}/folders/{folderId}
Delete a folder permanently: links become unfiled, per-user roles, requests, the folder's public analytics page and webhook scope entries are removed with it.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
Хариу: 200 DeletedDto
GET/v1/workspaces/{workspaceId}/folders/{folderId}/access-requests
Access requests of a folder (owner only); open requests past their expiry are not listed as open.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.read
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
status | query | string | | `open` (default), `approved`, `declined`, `expired` or `all`. |
Хариу: 200 AccessRequestDto[]
POST/v1/workspaces/{workspaceId}/folders/{folderId}/access-requests
Ask for edit access. A second call returns the existing open request (200).
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
Хүсэлтийн бие (CreateAccessRequest)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
message | string | | Optional note to the folder owners, up to 500 characters. |
Хариу: 200 AccessRequestDto, 201 AccessRequestDto
POST/v1/workspaces/{workspaceId}/folders/{folderId}/access-requests/{requestId}/approve
Approve a request as editor or owner (owner only); never above the requester's workspace role cap.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
requestId | path | string | тийм | |
Хүсэлтийн бие (ApproveBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
access | string | | `editor` (default) or `owner`. |
Хариу: 200 AccessRequestDto
POST/v1/workspaces/{workspaceId}/folders/{folderId}/access-requests/{requestId}/decline
Decline a request (owner only).
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
requestId | path | string | тийм | |
Хариу: 200 AccessRequestDto
GET/v1/workspaces/{workspaceId}/folders/{folderId}/users
Per-user roles of a folder (owner only).
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
Хариу: 200 FolderUserDto[]
PUT/v1/workspaces/{workspaceId}/folders/{folderId}/users/{userId}
Set a member's folder role. Needs owner access and Business or above; the stored access is clamped by the member's workspace role.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
userId | path | string | тийм | |
Хүсэлтийн бие (PutFolderUser)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
access | string | тийм | `owner`, `editor`, `viewer` or `none`. |
Хариу: 200 FolderUserDto
DELETE/v1/workspaces/{workspaceId}/folders/{folderId}/users/{userId}
Remove a member's folder override: they fall back to the workspace-level setting.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
folderId | path | string | тийм | |
userId | path | string | тийм | |
Хариу: 204
POST/v1/workspaces/{workspaceId}/links/move
Move up to 100 links to a folder (or out of any folder). Atomic; needs write access to the destination and every source folder; emits no link.updated.
Шаардлагатай API түлхүүрийн хамрах хүрээ: folders.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (MoveLinks)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
linkIds | string[] | тийм | |
folderId | string | | Destination folder id, or null to unfile. |
Хариу: 200 UpdatedCount