Справочник сущностей
Форма
Атрибут | Пример |
---|---|
id Идентификатор формы | "id": 36120 |
name Название формы | "name": "Payments" |
steps Список шагов маршрутизации. Объект, ключи которого — номера шагов, а значения — их названия | "steps": { "1": "Manager", "2": "Accounting", "4": "CEO" } |
fields Массив полей формы | "fields": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Amsterdam", "info": { "code": "PurposeCode" } }, { "id": 2, "type": "money", "name": "Amount", "value": 10306.25, "info": { "code": "AmountCode" } } ] |
deleted_or_closed Признак того, что форма закрыта или удалена | "deleted_or_closed": false |
print_forms Массив печатных форм | "print_forms": [ { "print_form_id": 2633, "print_form_name": "templateA.docx" }, { "print_form_id": 2645, "print_form_name": "templateB.xlsx" } ] |
folder Путь из вложенных папок, по которому размещена форма | "folder": [folder1] |
Задача реестра формы
Атрибут | Пример |
---|---|
id Идентификатор задачи | "id": 11610 |
create_date Дата создания задачи в формате YYYY-MM-DDThh:mm:ssZ | "create_date": "2017-08-20T12:31:14Z" |
last_modified_date Дата последнего изменения задачи в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
close_date Дата завершения задачи в формате YYYY-MM-DDThh:mm:ssZ | "close_date": "2017-08-23T10:20:11Z" |
current_step Текущий этап | "current_step": 1 |
fields Массив полей формы | "fields": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Amsterdam", "code": "PurposeCode" }, { "id": 2, "type": "money", "name": "Amount", "value": 10306.25, "code": "AmountCode" } ] |
Задача с комментариями
Атрибут | Пример |
---|---|
id Идентификатор задачи | "id": 11610 |
text Текст задачи "text": "Help with printer" | |
create_date Дата создания задачи в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
last_modified_date Дата последнего изменения задачи в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
author Автор задачи | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
due_date Срок задачи. Дата в формате YYYY-MM-DD | "due_date": "2018-03-21" |
due Срок задачи со временем. Дата в формате YYYY-MM-DDThh:mm:ssZ | "due": "2018-03-22T03:22:15Z" |
duration Продолжительность события в минутах | "duration": 120 |
close_date Дата завершения задачи. Дата в формате YYYY-MM-DDThh:mm:ssZ | "close_date" : "2018-02-14T12:44:25" |
current_step Текущий этап | "current_step": 1 |
list_ids Массив идентификаторов списков | "list_ids": [2646, 30304, 65349] |
responsible Ответственный за задачу | "responsible": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
participants Массив участников задачи | "participants": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } ] |
subscribers Массив наблюдателей задачи, состоящий из пользователей и их согласований | "subscribers": [ { "person": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "approval_choice": "approved" } ] |
attachments Массив приложенных к задаче файлов | "attachments": [ { "id": 6647, "name": "contract-142.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC3", "url": "https://pyrus.com/services/attachment?id=6647", "version": 2, "root_id": 17562 } ] |
parent_task_id Идентификатор надзадачи | "parent_task_id": 5444 |
linked_task_ids Массив идентификаторов связанных задач | "linked_task_ids": [12334, 44355, 72345] |
comments Массив комментариев к задаче | "comments": [ { "id": 13767, "text": "Help with printer", "create_date": "2017-08-17T15:32:11Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } } ] |
Комментарий к задаче
Атрибут | Пример |
---|---|
id Идентификатор комментария | "id": 176324 |
text Текст комментария | "text": "this is my comment" |
formatted_text Текст комментария, содержащий форматирование html | "<s>strikethrough text</s>" |
create_date Дата создания комментария в формате YYYY-MM-DDThh:mm:ssZ | "create_date": "2017-08-23T13:12:27Z" |
author Автор комментария | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
added_list_ids Массив списков, в которые была включена задача | "added_list_ids": [1374, 1444] |
removed_list_ids Массив списков, из которых была удалена задача | "removed_list_ids": [1374] |
reassigned_to Пользователь, на которого была переназначена задача | "reassigned_to": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
approval_choice Решение пользователя в задаче. Возможные значения: approved (утверждено), rejected (против), acknowledged (прочитано), revoked (отозвано) | "approval_choice": "approved" |
participants_added Массив участников, добавленных в задачу | "participants_added": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
participants_removed Массив участников, удаленных из задачи | "participants_removed": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_added Массив наблюдателей, добавленных в задачу | "subscribers_added": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_removed Массив наблюдателей, удаленных из задачи | "subscribers_removed": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_rerequested Массив наблюдателей, от которых требуется повторное согласование | "subscribers_rerequested": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
due_date Срок задачи. Дата в формате YYYY-MM-DD | "due_date": "2018-03-21" |
due Срок задачи со временем. Дата в формате YYYY-MM-DDThh:mm:ssZ | "due": "2018-03-22T03:22:15Z" |
duration Продолжительность события в минутах | "duration": 120 |
attachments Массив приложенных к комментарию файлов | "attachments": [ { "id": 6652, "name": "contract-147.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC4", "url": "https://pyrus.com/services/attachment?id=6652", "version": 2, "root_id": 17562 } ] |
action Действие над задачей. Возможные значения: finished, reopened | "action": "finished" |
spent_minutes Затраченное время в минутах | "spent_minutes": 30 |
mentions Массив пользователей, упомянутых в комментарии | "mentions": [111852] |
reply_note_id Идентификатор комментария, на который был сделан ответ | "reply_note_id": 111851 |
Задача по форме с комментариями
Атрибут | Пример |
---|---|
id Идентификатор задачи | "id": 11610 |
create_date Дата создания задачи в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
last_modified_date Дата последнего изменения задачи в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
author Автор задачи | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
close_date Дата завершения задачи. Дата в формате YYYY-MM-DDThh:mm:ssZ | "close_date" : "2018-02-14T12:44:25" |
form_id Идентификатор шаблона формы | "form_id": 1474 |
responsible Ответственный за задачу | "responsible": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
approvals Массив шагов согласования. Каждый шаг — это массив состоящий из пользователей и их согласования | "approvals": [ [ { "person": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "approval_choice": "approved" } ], [ { "person": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" }, "approval_choice": "waiting" } ] ] |
subscribers Массив наблюдателей задачи, состоящий из пользователей и их согласований | "subscribers": [ { "person": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "approval_choice": "approved" } ] |
attachments Массив приложенных к задаче файлов | "attachments": [ { "id": 6647, "name": "contract-142.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC3", "url": "https://pyrus.com/services/attachment?id=6647", "version": 2, "root_id": 17562 } ] |
parent_task_id Идентификатор надзадачи | "parent_task_id": 5444 |
linked_task_ids Массив идентификаторов связанных задач | "linked_task_ids": [12334, 44355, 72345] |
fields Массив полей формы | "fields": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Amsterdam", "code": "PurposeCode" }, { "id": 2, "type": "money", "name": "Amount", "value": 10306.25, "code": "AmountCode" } ] |
comments Массив комментариев к задаче | "comments": [ { "id": 13767, "text": "Help with printer", "create_date": "2017-08-17T15:32:11Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } } ] |
Комментарий к задаче по форме
Атрибут | Пример |
---|---|
id Идентификатор комментария | "id": 176324 |
text Текст комментария | "text": "this is my comment" |
formatted_text Текст комментария, содержащий форматирование html | "<s>strikethrough text</s>" |
create_date Дата создания комментария в формате YYYY-MM-DDThh:mm:ssZ | "create_date": "2017-08-23T13:12:27Z" |
author Автор комментария | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
added_list_ids Массив списков, в которые была включена задача | "added_list_ids": [1374, 1444] |
removed_list_ids Массив списков, из которых была удалена задача | "removed_list_ids": [1374] |
reassigned_to Пользователь, на которого была переназначена задача | "reassigned_to": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type ": "user" } |
approval_choice Решение пользователя в задаче. Возможные значения: approved (утверждено), rejected (против), acknowledged (прочитано), revoked (отозвано) | "approval_choice": "approved" |
changed_step Номер этапа, на который перешла задача. Нумерация начинается с единицы | "changed_step": 2 |
approvals_added Массив добавленных шагов согласования. Каждый шаг — это массив состоящий из пользователя и номера этапа | "approvals_added": [[ { "person": { "id": 1733, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" }, "step": 1 }, { "person": { "id": 1732, "first_name": "Sarah", "last_name": "Parker", "email": "Parker@gmail.com", "type": "user" }, "step": 1 } ], [ { "person": { "id": 1731, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, "step": 2 } ]] |
approvals_removed Массив удаленных шагов согласования. Каждый шаг — это массив состоящий из пользователя и номера этапа | "approvals_removed": [[ { "person": { "id": 1733, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" }, "step": 1 } ]] |
approvals_rerequested Массив перезапрошенных шагов согласования. Каждый шаг — это массив состоящий из пользователя и номера этапа | "approvals_rerequested": [[ { "person": { "id": 1732, "first_name": "Sarah", "last_name": "Parker", "email": "Parker@gmail.com", "type": "user" }, "step": 1 } ]] |
subscribers_added Массив наблюдателей, добавленных в задачу | "subscribers_added": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" }, { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_removed Массив наблюдателей, удаленных из задачи | "subscribers_removed": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
subscribers_rerequested Массив наблюдателей, от которых требуется повторное согласование | "subscribers_rerequested": [ { "id": 1332, "first_name": "Jane", "last_name": "Doe", "email": "Jane@gmail.com", "type": "user" } ] |
comment_as_roles Список ролей от имени которых была прокомментирована задача | "comment_as_roles": [ { "id": 288556, "name": "Role1" } ] |
field_updates Массив измененных полей формы | "field_updates": [ { "id": 1, "type": "text", "name": "Purpose", "value": "IT conference in Moscow", "code": "PurposeCode" } ] |
due_date Срок задачи. Дата в формате YYYY-MM-DD | "due_date": "2018-03-21" |
due Срок задачи со временем. Дата в формате YYYY-MM-DDThh:mm:ssZ | "due": "2018-03-22T03:22:15Z" |
duration Продолжительность события в минутах | "duration": 120 |
attachments Массив приложенных к комментарию файлов | "attachments": [ { "id": 6652, "name": "contract-147.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC4", "url": "https://pyrus.com/services/attachment?id=6652", "version": 2, "root_id": 17562 } ] |
action Действие над задачей. Возможные значения: finished, reopened | "action": "finished" |
channel | "channel": { "type": "email", "from": { "email": "John@gmail.com" } } |
spent_minutes Затраченное время в минутах | "spent_minutes": 30 |
mentions Массив пользователей, упомянутых в комментарии | "mentions": [111852] |
reply_note_id Идентификатор комментария, на который был сделан ответ | "reply_note_id": 111851 |
Внешний канал
Атрибут | Пример |
---|---|
type Тип канала. Возможные значения: email, telegram, facebook, vk, viber, mobile_app, web_widget, moy_sklad, zadarma, amo_crm | "type": "email" |
to Имя получателя. Заполняется только для исходящих комментариев.Состоит из свойства email (для канала email) или name (для остальных каналов) | "to": { "email": "John@gmail.com" } |
from Имя отправителя. Заполняется только для входящих комментариев.Состоит из свойства email (для канала email) или name (для остальных каналов) | "from": { "name": "John Doe" } |
Справочник
Атрибут | Пример |
---|---|
catalog_id Идентификатор справочника | "catalog_id": 422 |
catalog_headers Массив колонок справочника Возможные типы колонок: workflow, text | "catalog_headers": [ { "name": "City", "type": "text" } { "name": "Street", "type": "text" } ] |
items Массив элементов справочника | "items": [ { "item_id": 1385, "values": [ "Costa Mesa", "2130 Fulton Streen" ] }, { "item_id": 1389, "values": [ "Norwalk", "650 Davis Street" ] } ] |
source_type Предназначение справочника. Возможные значения: default, fill_table, department_catalog, hierarchical | "source_type": "default" |
Организация
Атрибут | Пример |
---|---|
organization_id Идентификатор организации | "organization_id": 2181 |
name Наименование организации | "name": "My Organization" |
persons Массив сотрудников организации | "persons": [ { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } ] |
roles Массив ролей организации | "roles": [ { "id": 1733, "name": "Some Role", "member_ids": [1725, 1733], "type": "role" } ] |
department_catalog_id Каталог оргструктуры | "department_catalog_id": 1234 |
Список задач
Атрибут | Пример |
---|---|
id Идентификатор списка | "id": 1352 |
name Наименование списка | "name": "Branch offices" |
children Массив подсписков | "children": [ { "id": 1465, "name": "Moscow" }, { "id": 3763, "name": "San Francisco" } ] |
Задача в списке
Атрибут | Пример |
---|---|
id Идентификатор задачи | "id": 11610 |
create_date Дата создания задачи в формате YYYY-MM-DDThh:mm:ssZ | "create_date": "2017-08-20T12:31:14Z" |
last_modified_date Дата последнего изменения задачи в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
close_date Дата завершения задачи в формате YYYY-MM-DDThh:mm:ssZ | "close_date": "2017-08-23T10:20:11Z" |
author Автор задачи | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
responsible Ответственный за задачу | "responsible": { "id": 1733, "first_name": "John", "last_name": "Snow", "email": "John@gmail.com", "type": "user" } |
text Текст задачи | "text": "Help with printer" |
due_date Срок задачи в UTC. Дата в формате YYYY-MM-DD | "due_date": "2018-03-21" |
Пользователь
Атрибут | Пример |
---|---|
id Идентификатор пользователя | "id": 4221 |
first_name Имя пользователя | "first_name": "John" |
last_name Фамилия пользователя | "last_name": "Snow" |
native_first_name Имя на родном языке | "native_first_name": "John" |
native_last_name Фамилия на родном языке | "native_last_name": "John" |
Адрес электронной почты | "email": "John@gmail.com" |
skype Контакт skype | "skype": "skype_some_nickname" |
phone Номер рабочего телефона | "phone": "+74952345670" |
mobile_phone Номер мобильного телефона | "mobile_phone": "+79032345670" |
type Тип пользователя | "type": "user" |
status Статус | "status" : "В отпуске" |
position Должность пользователя | "position": "Head of sales" |
locale Локаль пользователя | "locale": "en-US" |
fired Уволен ли пользователь | "fired": true |
banned Заблокирован ли пользователь | "banned": true |
task_receiver Идентификатор пользователя, которому были переданы задачи после увольнения другого пользователя | "task_receiver": 17139 |
department_id* Идентификатор отдела пользователя | "department_id": 113 |
department_name* Название отдела пользователя | "department_name": "Marketing" |
* - данные поля применимы только к запросу получения контактов.
Бот
Атрибут | Пример |
---|---|
id Идентификатор бота | "id": 10812 |
name Имя бота | "name": "TextBot" |
is_enabled Включен ли бот | "is_enabled": true |
is_enabled Удален ли бот | "fired": false |
hook_url Адрес страницы-обработчика бота | "hook_url": "https://bots.pyrus.com/textbot" |
description Описание бота | "description": "Бот возвращает текст из настроек и утверждает задачу." |
bot_settings Настройки бота | "bot_settings": { "text": "Перенесено в архив" } |
login Логин бота | "login" : "bot@892ccfa1c8360e2e8309" |
send_only_last_comment Передавать только последний комментарий при вызове бота | "send_only_last_comment": true |
locale Локаль бота | "locale": "en-US" |
time_zone_offset Часовой пояс бота (смещение в минутах) | "time_zone_offset"": 180 |
Роль
Атрибут | Пример |
---|---|
id Идентификатор роли | "id": 422 |
name Название роли | "name": "TechSupport" |
fired Уволен ли пользователь | "fired": true |
banned Заблокирована ли роль | "banned": true |
member_ids Массив участников роли | "member_ids": [ 1732, 6307, 4333 ] |
Профиль
Атрибут | Пример |
---|---|
person_id Идентификатор пользователя | "person_id": 1732 |
first_name Имя пользователя | "first_name": "Jane" |
last_name Фамилия пользователя | "last_name": "Doe" |
Адрес электронной почты | "email": "jane.doe@gmail.com" |
locale Язык пользователя | "locale": "en-US" |
organization_id Идентификатор организации пользователя | "organization_id": 1834 |
organization Организация пользователя | "organization": { "organization_id": 1834, "name": "My Organiztion", "persons": [ { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob.Smith@gmail.com", "type": "user", "department_id": 13836, "department_name": "Marketing" } ], "roles": [ { "id": 1743, "name": "SomeRole", "member_ids": [ 1725, 1733 ], "type": "role" } ], "department_catalog_id": 1234 } |
Объявление
Атрибут | Пример |
---|---|
id Идентификатор объявления | "id": 11610 |
text Текст объявления | "text": "New announcement" |
create_date Дата создания объявления в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
last_modified_date Дата последнего изменения объявления в формате YYYY-MM-DDThh:mm:ssZ | "last_modified_date": "2017-08-23T10:20:11Z" |
author Автор объявления | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
attachments Массив приложенных к задаче файлов | "attachments": [ { "id": 6647, "name": "contract-142.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC3", "url": "https://pyrus.com/services/attachment?id=6647", "version": 2, "root_id": 17562 } ] |
comments Массив комментариев к объявлению | "comments": [ { "id": 13767, "text": "Help with printer", "create_date": "2017-08-17T15:32:11Z", "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } } ] |
Комментарий к объявлению
Атрибут | Пример |
---|---|
id Идентификатор комментария | "id": 176324 |
text Текст комментария | "text": "this is my comment" |
create_date Дата создания комментария в формате YYYY-MM-DDThh:mm:ssZ | "create_date": "2017-08-23T13:12:27Z" |
author Автор комментария | "author": { "id": 1731, "first_name": "Bob", "last_name": "Smith", "email": "Bob@gmail.com", "type": "user" } |
attachments Массив приложенных к комментарию файлов | "attachments": [ { "id": 6652, "name": "contract-147.docx", "size": 541512, "md5": "5EB63BBBE01EEED093CB22BB8F5ACDC4", "url": "https://pyrus.com/services/attachment?id=6652", "version": 2, "root_id": 17562 } ] |