Баримт бичиг / API лавлах
Шошго
Холбоосыг шошгоор ангилах.
Add and remove tags on up to 100 links at once. Atomic: a link that would exceed 20 tags makes the call 422 tags_limit listing the link ids in error.fields.
Шаардлагатай API түлхүүрийн хамрах хүрээ: tags.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (BulkTags)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
linkIds | string[] | тийм | |
addTagIds | string[] | | |
removeTagIds | string[] | | |
Хариу: 200 UpdatedCount
List tags: search over the folded name (prefix matches first), sorted by name with the Mongolian ICU collation or by creation time.
Шаардлагатай API түлхүүрийн хамрах хүрээ: tags.read
Параметр (8)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
search | query | string | | |
ids | query | string | | Comma separated tag ids. |
sortBy | query | string | | `name` (default) or `createdAt`. |
sortOrder | query | string | | `asc` (default) or `desc`. |
page | query | integer (int32) | | |
pageSize | query | integer (int32) | | |
withCounts | query | boolean | | |
Хариу: 200 TagDto[]
POST/v1/workspaces/{workspaceId}/tags
Create a tag. 409 for a duplicate folded name, 402 over the plan limit.
Шаардлагатай API түлхүүрийн хамрах хүрээ: tags.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (CreateTag)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | тийм | |
color | string | | Random among red, yellow, green, blue, purple, brown, gray when omitted. |
Хариу: 201 TagDto
GET/v1/workspaces/{workspaceId}/tags/{tagId}
Retrieve one tag with its link count.
Шаардлагатай API түлхүүрийн хамрах хүрээ: tags.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
tagId | path | string | тийм | |
Хариу: 200 TagDto
PATCH/v1/workspaces/{workspaceId}/tags/{tagId}
Rename and/or recolor. At least one field; 409 when the folded name collides with another tag.
Шаардлагатай API түлхүүрийн хамрах хүрээ: tags.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
tagId | path | string | тийм | |
Хүсэлтийн бие (PatchTag)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | | |
color | string | | |
Хариу: 200 TagDto
DELETE/v1/workspaces/{workspaceId}/tags/{tagId}
Delete a tag permanently: detached from every link, links untouched, no link.updated events. Returns { "id": ... }.
Шаардлагатай API түлхүүрийн хамрах хүрээ: tags.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
tagId | path | string | тийм | |
Хариу: 200 DeletedDto