Метки¶
Назначение меток¶
URI: /BumsCommonApiV01/Tags/assign.api|xml
Входные параметры¶
Поле |
Тип |
Допустимые значения |
Описание |
---|---|---|---|
SubjectType |
string |
task (задача), project (проект) |
Тип объекта |
SubjectIds |
array |
Массив из идентификаторов объектов, которые нужно пометить |
|
TagIds |
array |
Массив идентификаторов меток |
Выходные данные¶
–
Создание новой метки¶
URI: /BumsCommonApiV01/Tags/create.api|xml
Входные параметры¶
Поле |
Тип |
Допустимые значения |
Описание |
---|---|---|---|
SubjectType |
string |
task (задача), project (проект) |
Тип объекта |
Model[Name] |
string |
Название метки |
|
Model[IsGlobal] |
bool |
Является ли новая метка глобальной |
Выходные данные¶
Поле |
Тип |
Описание |
|
Id |
integer |
ID метки |
|
Name |
string |
Название метки |
Удалить метки¶
URI: /BumsCommonApiV01/Tags/delete.api|xml
Входные параметры¶
Параметр |
Тип |
Допустимые значения |
Значение по умолчанию |
Описание |
|
Id |
integer |
идентификатор метки для удаления |
|||
Id |
array<integer> |
массив идентификаторов меток для удаления |
Список меток¶
URI: /BumsCommonApiV01/Tags/list.api|xml
Входные параметры¶
Поле |
Тип |
Допустимые значения |
Описание |
---|---|---|---|
SubjectType |
string |
task (задача), project (проект), event |
Тип объекта |
IncludeGlobal |
bool |
Нужно ли включать в список меток глобальные метки |
Выходные данные¶
Поле |
Тип |
Описание |
|
Id |
integer |
Код метки |
|
Name |
string |
Название метки |
|
TimeCreated |
datetime |
Дата и время создания |
|
IsGlobal |
bool |
Является ли метка глобальной, то есть не привязанной к конкретному пользователю |
|
UserId |
integer |
Код пользователя, к которому привязана метка |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"data":
{
"tags":
[
{
"Id":1001128,
"Name":"Персональный тэг",
"TimeCreated":"2011-05-17 19:26:23",
"IsGlobal":"false",
"UserId":100234
},
]
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<data>
<tags>
<item>
<id>1001128</id>
<name>Персональный тэг</name>
<time_created>2011-05-17 19:26:23</time_created>
<is_global>0</is_global>
<user_id>100234</user_id>
</item>
</tags>
</data>
</response>
Список меток¶
URI: /BumsCommonApiV01/Tags/search.api|xml
Входные параметры¶
Поле |
Тип |
Допустимые значения |
Описание |
---|---|---|---|
SubjectType |
string |
task (задача), project (проект) |
Тип объекта |
TagIds |
array |
Массив идентификаторов тэгов, по которым нужно произвести поиск |
Выходные данные¶
Формат выходных данных зависит от типа объекта, по которому производился поиск. Описание для конкретного объекта можно найти в соответствующем разделе документации.
Обновление существующей метки¶
URI: /BumsCommonApiV01/Tags/update.api|xml
Входные параметры¶
Поле |
Тип |
Описание |
---|---|---|
Id |
integer |
Код метки |
Model[Name] |
string |
Название метки |
Выходные данные¶
—