Поле формы описывается JSON объектом, который содержит уникальный номер поля, название, его тип, текущее значение и дополнительную информацию о правилах его заполнения.
{ "id": 15, "name": "Summary", "type": "text", "value": "Printer does not print", "info": { "immutable_step": 1, "required_step": 1 } }
Запрос | id | name | type | value | info | parent_id | row_id |
GET /forms | |||||||
GET /forms/{form-id}/register | |||||||
GET /tasks/{task-id} | |||||||
POST /tasks/{task-id}/comments | |||||||
POST /tasks |
* Необходимо указать хотя бы один из этих параметров
Бывают простые и составные типы полей. В качестве значения простые типы принимают значения стандартных типов данных (строка, число, дата), составные — JSON объект.
Тип | Описание | Пример |
---|---|---|
text |
"value": "IT Conference" |
|
money |
"value": 1365.27 |
|
number |
"value": 157.2134 |
|
date | Формат даты: YYYY-MM-DD |
"value": "2017-03-16" |
time | Формат времени: HH:mm |
"value": "17:26" |
checkmark |
Возможные значения:
|
"value": "checked" |
due_date | Формат даты: YYYY-MM-DD |
"value": "2017-03-16" |
due_date_time | Формат даты: YYYY-MM-DDThh:mm:ssZ |
"value": "2017-03-16T14:53:23Z" |
"value": "consumer@mycompany.com" |
||
phone |
"value": "+7 800 555 3565" |
|
flag | Возможные значения:
|
"value": "unchecked" |
step | только для чтения |
"value": 1 |
status | только для чтения Возможные значения:
|
"value": "open" |
creation_date | только для чтения Формат даты: YYYY-MM-DD возвращается дата по UTC |
"value": "2017-03-18" |
note | только для чтения |
"value": "This is a tooltip" |
catalog
Чтение:
"value": { "item_id": 51234 "headers": [ "Vendor Name", "Vendor Code" ], "values": [ "GE", "123" ] }
Запись:
Для записи значения можно передать как идентификатор элемента в каталоге:"value": { "item_id": 23 }так и название элемента:
"value": { "item_name": "GE" }
file
Чтение:
"value": [{ "id": 17563, "name": "S15294-16.pdf", "size": 541512, "md5": "202cb962ac59075b964b07152d234b70", "url": "https://api.pyrus.com/files/17563", "version": 2, "root_id": 17562 }]
Запись:
"value": [ "66fcc656-9182-4d4a-9d1f-ece882cd12cd", "3b5ff13b-e561-4b56-9db2-bea4f8677429" ]
Запись новой версии файла:
"value": [ { "guid": "3bd62948-4f78-4e29-a3f7-8c36a304454b", "root_id": 17562 }]Загрузить файл и получить его идентификатор можно с помощью метода files/upload.
person
Чтение:
"value": { "id": 1730, "first_name": "Jane", "last_name": "Doe", "email": "Jane.Doe@gmail.com", "type": "user" }
Запись:
Для записи можно передать как идентификатор пользователя:"value": { "id": 1730, }так и его email:
"value": { "email": "Jane.Doe@gmail.com", }
author (только для чтения)
Чтение:
"value": { "id": 1730, "first_name": "Jane", "last_name": "Doe", "email": "Jane.Doe@gmail.com", "type": "user" }
table
Чтение:
"value": [ { "row_id": 0, "cells": [ { "id": 6, "type": "date", "name": "Date", "value": "2017-08-26", "parent_id": 5, "row_id": 0, }, { "id": 9, "type": "money", "name": "Amount", "value": 10000, "parent_id": 5, "row_id": 0, } ] }, { "row_id": 1, "cells": [ { "id": "6", "type": "date", "name": "Date", "value": "2017-08-27", "parent_id": 5, "row_id": 1, }, { "id": 9, "type": "money", "name": "Amount", "value": 306.25, "parent_id": 5, "row_id": 1, } ]} ]
Запись:
"value": [{ "row_id": 0, "delete": true }, { "row_id": 1, "cells": [ { "id": 9, "value": 351.25 }, { "id": 6, "value": "2017-08-21" } ] }]
multiple_choice
Чтение:
"value": { "choice_ids": [5], "choice_names": ["Yes"] "fields": [ { "id": 6, "type": "text", "name": "Comment", "value": "Additional information about choice", "parent_id": 4 }, { "id": 9, "type": "number", "name": "Quantity", "value": 15, "parent_id": 4 } ] }
Запись:
"value": { "choice_ids": [5] "fields": [ { "id": 9, "value": 1 } ] }
title
Чтение:
"value": { checkmark: "checked", "fields": [ { "id": "3", "type": "date", "name": "Date", "value": "2017-08-19", "parent_id": 2 }, { "id": "4", "type": "text", "name": "Description", "value": "My issue", "parent_id": 2 } ] }
Запись:
"value": { "fields": [ { "id": 4, "value": "It is not an issue" } ] }
form_link
Чтение:
"value": { "task_ids": [1573], "subject": "Expense report" }
Запись:
"value": { "task_ids" : [1753] }
project (устарело, только для чтения)
Чтение:
"value": { "projects: [ { "id": 1, "name": "Root Project" }, { "id": 3, "name": "Child Project", "parent": { "id": 2, "name": "Another root project" } } ] }
Объект info может содержать 2 ключа для всех типов полей:
Нумерация шагов начитается с единицы.
Помимо перечисленных ключей, объект info в зависимости от типа будет содержать один из дополнительных ключей, описанных ниже:
Тип | Ключ | Пример |
---|---|---|
multiple_choice | options |
"options": [ { "choice_id": 0, "choice_value": "Not Set" }, { "choice_id": 1, "choice_value": "Yes", "fields": { "id": 4, "type": "text", "name": "Reason", "parent_id": 3, } }, { "choice_id": 2, "choice_value": "No", }, { "choice_id": 3, "choice_value": "MayBe", "deleted": true } ] |
catalog | catalog_id |
"catalog_id": 165 |
table | columns |
"columns": [ { "id": 9, "type": "money", "name": "Amount", "parent_id": 5, }, { "id": 6, "type": "date", "name": "Date", "parent_id": 5, } ] |
title | fields |
"fields": [ { "id": 9, "type": "money", "name": "Amount", "parent_id": 5, }, { "id": 6, "type": "date", "name": "Date", "parent_id": 5, } ] |
form_link | form_id |
"form_id": 1453 |