Баримт бичиг / API лавлах

Шошго

Холбоосыг шошгоор ангилах.

POST/v1/workspaces/{workspaceId}/links/tags

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)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (BulkTags)
НэрТөрөлЗаавалТайлбар
linkIdsstring[]тийм
addTagIdsstring[]
removeTagIdsstring[]

Хариу: 200 UpdatedCount

GET/v1/workspaces/{workspaceId}/tags

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)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
searchquerystring
idsquerystringComma separated tag ids.
sortByquerystring`name` (default) or `createdAt`.
sortOrderquerystring`asc` (default) or `desc`.
pagequeryinteger (int32)
pageSizequeryinteger (int32)
withCountsqueryboolean

Хариу: 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)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (CreateTag)
НэрТөрөлЗаавалТайлбар
namestringтийм
colorstringRandom 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)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
tagIdpathstringтийм

Хариу: 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)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
tagIdpathstringтийм
Хүсэлтийн бие (PatchTag)
НэрТөрөлЗаавалТайлбар
namestring
colorstring

Хариу: 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)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
tagIdpathstringтийм

Хариу: 200 DeletedDto