Сейсмический планировщик (предварительная версия)
Соединитель сейсмического планировщика предоставляет набор действий для взаимодействия с проектами планировщика включения, задачами и запросами.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Сейсмический |
| URL | https://seismic.com |
| Адрес электронной почты | support@seismic.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Сейсмический |
| Веб-сайт | https://seismic.com/ |
| Политика конфиденциальности | https://seismic.com/privacy-policy/ |
| Категории | Маркетинг; Продажи и CRM |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| GET-запрос |
Получение одного запроса. |
| Вывод задачи |
Получение одной задачи по идентификатору. |
| Запрос на обновление |
Обновление запроса. |
| Запросы на удаление |
Массовые запросы на удаление. |
| Обновление задачи |
Обновите существующую задачу. |
| Обновление комментария |
Обновите существующий комментарий. Требуется узел (проект, задача или запрос) и идентификатор комментария. |
| Обновление проекта |
Обновление и возврат проекта. |
| Получение задач |
Получение списка задач. |
| Получение запросов |
Получение списка запросов. |
| Получение комментариев |
Получение всех комментариев для данного проекта, задачи или запроса. Требуется идентификатор узла (проект, задача или запрос). |
| Получение комментария |
Получение одного комментария. Требуется узел (проект, задача или запрос) и идентификатор комментария. |
| Получение проекта |
Получение одного проекта по идентификатору. При желании верните задачи. |
| Получение проектов |
Получите список проектов с их атрибутами и связями. |
| Получение схем состояния |
Получение списка схем состояния задачи или запроса. Эти схемы содержат данные для задания состояний для конкретной работы. Пример: |
| Получение схемы состояния |
Получение отдельной схемы состояния по идентификатору. Эти схемы содержат данные для задания состояний для конкретной работы. Пример: |
| Создание задачи |
Создайте задачу. |
| Создание примечания |
Создайте комментарий к заданному проекту, задаче или запросу. Требуется идентификатор узла (проект, задача или запрос). |
| Создание проекта |
Создайте проект. |
| Создать запрос |
Создайте запрос. |
| Удаление задачи |
Удаление задачи. |
| Удаление комментария |
Удалите комментарий. Требуется узел (проект, задача или запрос) и идентификатор комментария. |
| Удаление проекта |
Удаление проекта. |
| Удаление проектов |
Удалите один или несколько проектов. |
| Удалить запрос |
Удаление запроса. |
GET-запрос
Получение одного запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор запроса
|
requestId | True | string |
Идентификатор запроса |
Возвращаемое значение
- Тело
- PlannerRequest
Вывод задачи
Получение одной задачи по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи |
Возвращаемое значение
- Тело
- PlannerTask
Запрос на обновление
Обновление запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор запроса
|
requestId | True | string |
Идентификатор запроса |
|
Идентификатор назначаемого получателя
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
|
Идентификатор содержимого
|
contentId | uuid |
Идентификатор содержимого |
|
|
Полный путь к DocCenter
|
docCenterFullPath | string |
Полный путь к расположению содержимого в DocCenter |
|
|
Основная версия
|
majorVersion | integer |
Количество основных версий |
|
|
Малая версия
|
minorVersion | integer |
Количество дополнительных версий |
|
|
Дата изменения
|
modifiedDate | date-time |
Дата последнего обновления ссылки на содержимое |
|
|
Номер заказа
|
orderNo | integer |
Число, указывающее порядок |
|
|
ИД профиля
|
profileId | uuid |
ИД профиля |
|
|
Идентификатор версии профиля
|
profileVersionId | uuid |
Идентификатор версии профиля |
|
|
Исходный материал
|
source | string |
Источник содержимого |
|
|
Идентификатор TeamSite
|
teamSiteId | string |
Идентификатор TeamSite |
|
|
Идентификатор эскиза
|
thumbnailId | string |
Идентификатор эскиза изображения |
|
|
Идентификатор версии
|
versionId | uuid |
Идентификатор версии содержимого |
|
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Справочник по формам
|
formRef |
Объект ссылки на форму |
||
|
Замечание
|
note | string |
Примечание, используемое для уведомлений об изменениях состояния |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированной даты окончания (дата выполнения) |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
|
Priority
|
priority | string |
Значение приоритета |
|
|
Код проекта
|
projectId | string |
Идентификатор проекта, к которому принадлежит запрос |
|
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага, указывающий состояние |
|
|
Название
|
title | string |
Заголовок запроса |
Возвращаемое значение
- Тело
- PlannerRequest
Запросы на удаление
Массовые запросы на удаление.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Тип контента
|
Content-Type | string |
Тип контента |
|
|
Идентификаторы запросов
|
ids | array of string |
Список идентификаторов запросов для удаления |
Возвращаемое значение
Обновление задачи
Обновите существующую задачу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи |
|
Идентификатор назначаемого получателя
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Description
|
description | string |
Описание задачи |
|
|
Родительский идентификатор
|
parentId | string |
Идентификатор задачи родительской задачи |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированного окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
|
Priority
|
priority | string |
Значение приоритета |
|
|
Код проекта
|
projectId | string |
Идентификатор проекта, к которому принадлежит задача |
|
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага, указывающий состояние задачи |
|
|
Название
|
title | string |
Название задачи |
Возвращаемое значение
- Тело
- PlannerTask
Обновление комментария
Обновите существующий комментарий. Требуется узел (проект, задача или запрос) и идентификатор комментария.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Идентификатор комментария
|
commentId | True | string |
Идентификатор комментария |
|
Полезные данные заметки
|
annotationPayload | string | ||
|
Тип заметки
|
annotationType | string | ||
|
Содержимое примечания
|
commentContent | string |
Содержимое комментария |
|
|
Разрешено
|
isResolved | boolean |
Значение true/false для разрешения комментария |
Возвращаемое значение
- Тело
- Comment
Обновление проекта
Обновление и возврат проекта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Код проекта
|
projectId | True | string |
Код проекта |
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Локализации
|
localizations | object |
Объект локализации |
|
|
Несколько значений
|
multipleValue | boolean |
Укажите, разрешает ли пользовательское свойство несколько значений. |
|
|
Имя
|
name | string |
Имя настраиваемого свойства |
|
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Description
|
description | string |
Описание проекта |
|
|
Активен
|
isActive | boolean |
Индикатор того, активен ли проект? |
|
|
Идентификатор диспетчера
|
managerId | string |
Идентификатор пользователя диспетчера проектов |
|
|
Максимальный ранг
|
maxRank | string |
Максимальное число ранга |
|
|
Min Rank
|
minRank | string |
Минимальный номер ранга |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированного окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
|
Название
|
title | string |
Название проекта |
Возвращаемое значение
- Тело
- PlannerProject
Получение задач
Получение списка задач.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Дата запланированного окончания из
|
plannedEndDateFrom | date-time |
Фильтрация по дате выполнения задачи (включительно) |
|
|
Запланированная дата окончания
|
plannedEndDateTo | date-time |
Фильтрация по дате выполнения задачи (эксклюзивная) |
|
|
Запланированная дата начала с
|
plannedStartDateFrom | date-time |
Фильтрация по дате начала задачи (включительно) |
|
|
Запланированная дата начала
|
plannedStartDateTo | date-time |
Фильтрация по дате начала задачи (эксклюзивная) |
|
|
Создано из
|
createdAtFrom | date-time |
Фильтрация по дате создания задачи (включительно) |
|
|
Создано по адресу
|
createdAtTo | date-time |
Фильтрация по дате создания задачи (эксклюзивная) |
|
|
Обновлено из
|
updatedAtFrom | date-time |
Фильтрация по дате обновления задачи (включительно) |
|
|
Обновлено до
|
updatedAtTo | date-time |
Фильтрация по дате обновления задачи (эксклюзивная) |
|
|
Идентификаторы задач
|
ids | array |
Фильтрация по списку идентификаторов задач |
|
|
Название
|
title | string |
Фильтрация по названию задачи |
|
|
Description
|
description | string |
Фильтрация по описанию задачи |
|
|
Идентификаторы назначаемого пользователя
|
assigneeIds | array |
Список идентификаторов пользователей для фильтрации по назначению |
|
|
Приоритеты
|
priorities | array |
Фильтрация по списку приоритетов |
|
|
Ключевые слова
|
keywords | string |
Фильтрация по ключевым словам |
|
|
Идентификаторы назначателя
|
assignerIds | array |
Список идентификаторов пользователей для фильтрации по пользователю, которому назначена задача |
|
|
Идентификаторы шагов
|
stepIds | array |
Фильтрация по идентификаторам значений состояния |
|
|
Идентификатор схемы состояния
|
statusSchemaId | string |
Фильтрация по идентификаторам схемы состояния |
|
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
|
Лимит
|
limit | integer |
Число для ограничения возвращаемых записей |
|
|
Сортировать
|
sort | array |
Сортировка по запросу |
|
|
Рекурсивный
|
recursive | boolean |
Включение подзадач в возвращаемый список |
|
|
Код проекта
|
projectId | string |
Фильтрация по идентификатору проекта |
|
|
Имеет проект
|
hasProject | boolean |
Фильтрация по задачам, связанным с проектом |
|
|
Настраиваемые свойства
|
customProperties | string |
Фильтрация по значениям настраиваемых свойств |
|
|
Идентификаторы последователей
|
followerIds | array |
Список идентификаторов пользователей для фильтрации по подписчикам |
|
|
Идентификаторы связанных узлов
|
associatedNodeIds | array |
Список идентификаторов сопоставлений для фильтрации по |
|
|
Идентификаторы создателя
|
creatorIds | array |
Список идентификаторов пользователей для фильтрации по создателю |
|
|
Включение ассоциаций
|
includeAssociations | boolean |
Включение данных ассоциации в ответ |
|
|
Родительский идентификатор
|
parentId | string |
Список идентификаторов задач для фильтрации по |
Возвращаемое значение
Получение запросов
Получение списка запросов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Дата запланированного окончания из
|
plannedEndDateFrom | date-time |
фильтр по дате выполнения запроса (включительно) |
|
|
Запланированная дата окончания
|
plannedEndDateTo | date-time |
фильтрация по дате выполнения запроса (эксклюзивная) |
|
|
Запланированная дата начала с
|
plannedStartDateFrom | date-time |
фильтр по дате начала запроса (включительно) |
|
|
Запланированная дата начала
|
plannedStartDateTo | date-time |
фильтр по дате начала запроса (монопольная) |
|
|
Создано из
|
createdAtFrom | date-time |
фильтр по дате создания запроса (включительно) |
|
|
Создано по адресу
|
createdAtTo | date-time |
фильтр по дате создания запроса (эксклюзивный) |
|
|
Обновлено из
|
updatedAtFrom | date-time |
фильтр по дате обновления запроса (включительно) |
|
|
Обновлено до
|
updatedAtTo | date-time |
фильтрация по обновленной дате запроса (монопольная) |
|
|
Идентификаторы запросов
|
ids | array |
Список идентификаторов запросов |
|
|
Название
|
title | string |
Значения ключевых слов для поиска по заголовкам запроса |
|
|
Идентификаторы назначаемого пользователя
|
assigneeIds | array |
Список идентификаторов пользователей назначаемых пользователей для фильтрации по |
|
|
Приоритеты
|
priorities | array |
Список значений приоритета, доступные значения: критические, высокие, средние, низкие |
|
|
Ключевые слова
|
keywords | string |
Значения ключевых слов для поиска |
|
|
Идентификаторы назначателя
|
assignerIds | array |
Список идентификаторов пользователей назначателя для фильтрации по |
|
|
Идентификаторы создателя
|
creatorIds | array |
Список идентификаторов пользователей создателей для фильтрации по |
|
|
Идентификаторы шагов
|
stepIds | array |
Список идентификаторов шагов для фильтрации по |
|
|
Идентификатор схемы состояния
|
statusSchemaId | string |
Идентификатор схемы состояния для фильтрации по |
|
|
Cursor
|
cursor | string |
Маркер, используемый для руководства по следующему окну страницы |
|
|
Лимит
|
limit | integer |
Количество элементов, возвращаемых на страницу, по умолчанию: 50 |
|
|
Сортировать
|
sort | array |
Сортировка по запросам |
|
|
Код проекта
|
projectId | string |
Идентификатор проекта, с который связан запрос |
|
|
Имеет проект
|
hasProject | boolean |
Фильтрация по запросу, если запросы связаны с проектом |
|
|
Настраиваемые свойства
|
customProperties | string |
Фильтрация по пользовательским свойствам |
|
|
Идентификаторы последователей
|
followerIds | array |
Список идентификаторов пользователей подписчиков |
|
|
Идентификаторы связанных узлов
|
associatedNodeIds | array |
Список идентификаторов связанных узлов для фильтрации по |
|
|
Объекты ссылки на содержимое
|
contentRefs | array |
Список ссылочных объектов содержимого |
|
|
Включение настраиваемых свойств формы запроса
|
includeRequestFormCustomProperties | boolean |
Указывает, следует ли включать настраиваемые свойства формы запроса, значение false по умолчанию |
Возвращаемое значение
Получение комментариев
Получение всех комментариев для данного проекта, задачи или запроса. Требуется идентификатор узла (проект, задача или запрос).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Идентификаторы создателя
|
creatorIds | array |
Список идентификаторов пользователей для запроса создателем |
|
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
|
Сортировать
|
sort | array |
Сортировка по запросу |
Возвращаемое значение
- Тело
- CommentQueryResponse
Получение комментария
Получение одного комментария. Требуется узел (проект, задача или запрос) и идентификатор комментария.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Идентификатор комментария
|
commentId | True | string |
Идентификатор комментария |
Возвращаемое значение
- Тело
- Comment
Получение проекта
Получение одного проекта по идентификатору. При желании верните задачи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Код проекта
|
projectId | True | string |
Код проекта |
|
Глубина связанных узлов
|
associatedNodesDepth | integer |
Число, указывающее глубину возвращаемых данных узла |
|
|
Включение работ
|
includeWorks | boolean |
Индикатор включения связанных данных задач |
Возвращаемое значение
- Тело
- PlannerProject
Получение проектов
Получите список проектов с их атрибутами и связями.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Дата запланированного окончания из
|
plannedEndDateFrom | date-time |
Фильтрация по запланированной дате окончания |
|
|
Запланированная дата окончания
|
plannedEndDateTo | date-time |
Фильтрация по запланированной дате окончания |
|
|
Запланированная дата начала с
|
plannedStartDateFrom | date-time |
Фильтрация по запланированной дате начала |
|
|
Запланированная дата начала
|
plannedStartDateTo | date-time |
Фильтрация по запланированной дате начала |
|
|
Идентификаторы проектов
|
ids | array |
Список идентификаторов проектов для запроса по |
|
|
Название проекта
|
title | string |
Заголовок проекта для запроса по |
|
|
Идентификаторы диспетчера
|
managerIds | array |
Список идентификаторов пользователей для запроса диспетчером |
|
|
Идентификаторы создателя
|
creatorIds | array |
Список идентификаторов пользователей для запроса создателем |
|
|
Идентификаторы связанных узлов
|
associatedNodeIds | array |
Список идентификаторов сопоставлений для запроса по |
|
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
|
Лимит
|
limit | integer |
Число для ограничения возвращаемых записей |
|
|
Сортировать
|
sort | array |
Сортировка запроса |
|
|
Настраиваемые свойства
|
customProperties | string |
Список настраиваемых свойств для запроса по |
|
|
Идентификаторы последователей
|
followerIds | array |
Список идентификаторов пользователей для запроса подписчиком |
|
|
Включение ассоциаций
|
includeAssociations | boolean |
Индикатор, позволяющий включить данные ассоциации |
Возвращаемое значение
Получение схем состояния
Получение списка схем состояния задачи или запроса. Эти схемы содержат данные для задания состояний для конкретной работы.
Пример: (Not started, In progress, Complete)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Значение по умолчанию
|
isDefault | boolean |
Получение схемы состояния по умолчанию |
|
|
Тип
|
type | string |
Запрос по типу узла |
|
|
Идентификаторы схемы состояния
|
ids | array |
Список идентификаторов схем состояния |
|
|
Идентификаторы создателя
|
creatorIds | array |
Список идентификаторов пользователей для запроса создателем |
|
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
|
Лимит
|
limit | integer |
Число для ограничения возвращаемых записей |
Возвращаемое значение
Получение схемы состояния
Получение отдельной схемы состояния по идентификатору. Эти схемы содержат данные для задания состояний для конкретной работы.
Пример: (Not started, In progress, Complete)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор схемы состояния
|
statusSchemaId | True | string |
Идентификатор схемы состояния |
Возвращаемое значение
- Тело
- StatusSchema
Создание задачи
Создайте задачу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор назначаемого получателя
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Description
|
description | string |
Описание задачи |
|
|
Родительский идентификатор
|
parentId | string |
Идентификатор задачи родительского объекта |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты начала |
|
|
Priority
|
priority | string |
Значения приоритета |
|
|
Код проекта
|
projectId | string |
Идентификатор проекта, с которым связана задача |
|
|
Название
|
title | string |
Название задачи |
Возвращаемое значение
- Тело
- PlannerTask
Создание примечания
Создайте комментарий к заданному проекту, задаче или запросу. Требуется идентификатор узла (проект, задача или запрос).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Полезные данные заметки
|
annotationPayload | string | ||
|
Тип заметки
|
annotationType | string |
Тип заметки |
|
|
Содержимое примечания
|
commentContent | string |
Содержимое комментария |
|
|
Разрешено
|
isResolved | boolean |
Значение true/false для разрешения комментария |
Возвращаемое значение
- Тело
- Comment
Создание проекта
Создайте проект.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Description
|
description | string |
Название описания |
|
|
Идентификатор диспетчера
|
managerId | string |
Идентификатор пользователя диспетчера |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты начала |
|
|
Название
|
title | string |
Название проекта |
Возвращаемое значение
- Тело
- PlannerProject
Создать запрос
Создайте запрос.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор назначаемого получателя
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
|
Идентификатор содержимого
|
contentId | uuid |
Идентификатор содержимого |
|
|
Полный путь к DocCenter
|
docCenterFullPath | string |
Полный путь к расположению содержимого в DocCenter |
|
|
Основная версия
|
majorVersion | integer |
Количество основных версий |
|
|
Малая версия
|
minorVersion | integer |
Количество дополнительных версий |
|
|
Дата изменения
|
modifiedDate | date-time |
Дата последнего обновления ссылки на содержимое |
|
|
Номер заказа
|
orderNo | integer |
Число, указывающее порядок |
|
|
ИД профиля
|
profileId | uuid |
ИД профиля |
|
|
Идентификатор версии профиля
|
profileVersionId | uuid |
Идентификатор версии профиля |
|
|
Исходный материал
|
source | string |
Источник содержимого |
|
|
Идентификатор TeamSite
|
teamSiteId | string |
Идентификатор TeamSite |
|
|
Идентификатор эскиза
|
thumbnailId | string |
Идентификатор эскиза изображения |
|
|
Идентификатор версии
|
versionId | uuid |
Идентификатор версии содержимого |
|
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Справочник по формам
|
formRef |
Объект ссылки на форму |
||
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты начала |
|
|
Priority
|
priority | string |
Значение приоритета |
|
|
Код проекта
|
projectId | string |
Идентификатор проекта, к которому принадлежит запрос |
|
|
Идентификатор схемы состояния
|
statusSchemaId | string | ||
|
Название
|
title | string |
Заголовок запроса |
Возвращаемое значение
- Тело
- PlannerRequest
Удаление задачи
Удаление задачи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи |
Возвращаемое значение
Удаление комментария
Удалите комментарий. Требуется узел (проект, задача или запрос) и идентификатор комментария.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Идентификатор комментария
|
commentId | True | string |
Идентификатор комментария |
Удаление проекта
Удаление проекта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Код проекта
|
projectId | True | string |
Код проекта |
|
Удаление задач
|
deleteTasks | boolean |
Кроме того, удалите связанные задачи |
Возвращаемое значение
Удаление проектов
Удалите один или несколько проектов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификаторы проектов
|
ids | True | array |
Список идентификаторов проектов |
|
Удаление задач
|
deleteTasks | boolean |
Кроме того, удалите связанные задачи |
Возвращаемое значение
Удалить запрос
Удаление запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор запроса
|
requestId | True | string |
Идентификатор запроса |
Определения
Ассоциация
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
description | string |
Описание ассоциации |
|
Имя
|
name | string |
Имя ассоциации |
|
GUID узла
|
nodeGuid | string |
Более длинный формат GUID |
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
GUID пространства
|
spaceGuid | string |
Более длинный формат GUID |
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
AsyncOperationResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификаторы асинхронных операций
|
asyncOperationIds | array of string |
Список идентификаторов асинхронных действий |
Комментарий
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Полезные данные заметки
|
annotationPayload | string | |
|
Тип заметки
|
annotationType | string | |
|
Содержимое примечания
|
commentContent | string | |
|
Создано в
|
createdAt | date-time |
Строка даты, созданная |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Идентификатор комментария
|
id | string |
Идентификатор комментария |
|
Разрешено
|
isResolved | boolean |
Значение true/false для разрешения комментария |
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
Тип узла
|
nodeType | string |
Тип узла комментария |
|
Индекс страницы
|
pageIndex | string |
Индекс нумерации страницы |
|
Родительский идентификатор
|
parentId | string |
Идентификатор родительского комментария |
|
Число ответов
|
replyCount | integer |
Количество ответов |
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
Обновлено в
|
updatedAt | date-time |
Строка даты обновления |
CommentQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Товары
|
items | array of Comment |
Список элементов в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
ContentRef
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор содержимого
|
contentId | uuid |
Идентификатор содержимого |
|
Полный путь к DocCenter
|
docCenterFullPath | string |
Полный путь к расположению содержимого в DocCenter |
|
Основная версия
|
majorVersion | integer |
Количество основных версий |
|
Малая версия
|
minorVersion | integer |
Количество дополнительных версий |
|
Дата изменения
|
modifiedDate | date-time |
Дата последнего обновления ссылки на содержимое |
|
Номер заказа
|
orderNo | integer |
Число, указывающее порядок |
|
ИД профиля
|
profileId | uuid |
ИД профиля |
|
Идентификатор версии профиля
|
profileVersionId | uuid |
Идентификатор версии профиля |
|
Исходный материал
|
source | string |
Источник содержимого |
|
Идентификатор TeamSite
|
teamSiteId | string |
Идентификатор TeamSite |
|
Идентификатор эскиза
|
thumbnailId | string |
Идентификатор эскиза изображения |
|
Идентификатор версии
|
versionId | uuid |
Идентификатор версии содержимого |
CustomProperty
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Разрешить несколько значений
|
allowMultipleValues | boolean |
Указывает, разрешено ли пользовательское свойство для нескольких значений |
|
Создан по идентификатору
|
createdById | string |
Идентификатор пользователя создателя |
|
Имеет домен значений
|
hasDomainOfValues | boolean |
Указывает, имеет ли настраиваемое свойство возможные значения |
|
Hint
|
hint | string |
Значение, описывающее указание, отображаемое под именем пользовательского свойства |
|
Идентификатор пользовательского свойства
|
id | string | |
|
Требуется
|
isRequired | boolean |
Указывает, является ли пользовательское свойство обязательным или нет |
|
Последнее изменение по идентификатору
|
lastModifiedById | string |
Идентификатор пользователя, который последний раз обновил пользовательское свойство |
|
Имя
|
name | string |
Имя настраиваемого свойства |
|
Параметр операции
|
operationSetting | string |
Объект, описывающий параметры для различных операций с пользовательским свойством |
|
Заказ
|
order | integer |
Число, указывающее порядок в списке настраиваемых свойств |
|
Возможные значения
|
possibleValues | array of PossibleValuesItem |
Список возможных значений для настраиваемого свойства (если применимо) |
|
Параметры области
|
scopeSettings | array of ScopeSettingsItemDefinition |
Объект, описывающий параметры для разных областей в пользовательском свойстве |
|
Scopes
|
scopes | array of string |
Список областей |
|
Имя схемы значения
|
valueSchemaName | string |
Имя схемы значения пользовательского свойства |
|
valueSchemaProperty
|
valueSchemaProperty | ValueSchemaPropertyDefinition |
Определение схемы значений |
|
Тип значения
|
valueType | string |
Тип значения пользовательского свойства |
CustomPropertyValues
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор пользовательского свойства
|
id | string | |
|
Локализации
|
localizations | object |
Объект локализации |
|
Несколько значений
|
multipleValue | boolean |
Укажите, разрешает ли пользовательское свойство несколько значений. |
|
Имя
|
name | string |
Имя настраиваемого свойства |
|
Ценности
|
values | array of CustomPropertyValuesValues |
Список значений настраиваемых свойств |
CustomPropertyValuesValues
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор значения
|
id | string | |
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
Подписчик
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор группы пользователей и пользователей
|
id | string |
Идентификатор группы пользователей и пользователей подписчика |
|
Тип
|
type | string |
Тип подписчика пользователя или группы пользователей |
Meta
Объект метаданных
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Query
|
query | array of MetaQueryInfo |
Объект Query |
MetaQueryInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сортировать
|
sort | array of string |
Сортировка запроса |
PlannerProject
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Фактическая длительность
|
actualDuration | integer |
Вычисляемая фактическая длительность в днях |
|
Фактическая дата окончания
|
actualEndDate | date-time |
Вычисляемая дата окончания с момента окончания проекта |
|
Фактическая дата начала
|
actualStartDate | date-time |
Вычисляемая дата начала с момента начала проекта |
|
Связанные узлы
|
associatedNodes | array of ProjectAssociatedNodes |
Список данных связи |
|
Associations
|
associations | array of Association |
Список связей (содержимое библиотеки) |
|
Копирование из
|
copyFrom | string |
Идентификатор проекта копируется из |
|
Создано в
|
createdAt | date-time |
Строка даты создания |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Настраиваемые свойства
|
customProperties | array of CustomPropertyValues |
Список настраиваемых свойств |
|
Description
|
description | string |
Описание проекта |
|
Подписчики
|
followers | array of Follower |
Список последователей |
|
Код проекта
|
id | string | |
|
Активен
|
isActive | boolean |
Индикатор о том, является ли проект активным или нет |
|
Шаблон
|
isTemplate | boolean |
Индикатор, если проект является шаблоном или нет |
|
Идентификатор диспетчера
|
managerId | string |
Идентификатор пользователя диспетчера проектов |
|
Максимальный ранг
|
maxRank | string |
Максимальное число ранга |
|
Min Rank
|
minRank | string |
Минимальный номер ранга |
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированного окончания |
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
Идентификатор пространства
|
spaceId | string | |
|
ИД шаблона
|
templateId | string |
Идентификатор шаблона проекта был создан из |
|
Название
|
title | string |
Название проекта |
|
Обновлено в
|
updatedAt | date-time |
Дата последнего обновления проекта |
|
Завод
|
works | array of PlannerTask |
Список задач и запросов |
PlannerProjectQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Объекты Project
|
items | array of PlannerProject |
Список элементов проекта в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
PlannerRequest
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор назначаемого получателя
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
Идентификатор назначателя
|
assignerId | string |
Идентификатор пользователя назначателя |
|
Associations
|
associations | array of Association |
Список связей (содержимое библиотеки) |
|
Объекты ссылки на содержимое
|
contentRefs | array of ContentRef |
Список ссылок на содержимое (содержимое WorkSpace и DocCenter) |
|
Создано в
|
createdAt | date-time |
Строка даты для созданной даты |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Настраиваемые свойства
|
customProperties | array of CustomPropertyValues |
Список настраиваемых свойств |
|
Подписчики
|
followers | array of Follower |
Список последователей |
|
Ссылка на форму
|
formRef |
Объект ссылки на форму |
|
|
Идентификатор запроса
|
id | string | |
|
Замечание
|
note | string |
Примечание для уведомлений об изменениях состояния |
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированного окончания |
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
Priority
|
priority | string |
Значение приоритета |
|
Код проекта
|
projectId | string |
Идентификатор проекта, с которым связан запрос |
|
Ранг
|
rank | string |
Ранжирование запроса в списке запросов |
|
requestFormCustomPropertyOption
|
requestFormCustomPropertyOption | RequestFormCustomProperties |
Настраиваемые свойства формы запроса |
|
Идентификатор пространства
|
spaceId | string | |
|
Идентификатор схемы состояния
|
statusSchemaId | string | |
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага, указывающий значение состояния |
|
Название
|
title | string |
Заголовок запроса |
|
Обновлено в
|
updatedAt | date-time |
Дата последнего обновления запроса |
PlannerRequestQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Запрос объектов
|
items | array of PlannerRequest |
Список объектов запроса в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
PlannerSubTask
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Фактическая длительность
|
actualDuration | integer |
Вычисляемая фактическая длительность в днях |
|
Фактическая дата окончания
|
actualEndDate | date-time |
Дата завершения работы над задачей |
|
Фактическая дата начала
|
actualStartDate | date-time |
Дата начала работы над задачей |
|
Идентификатор назначаемого получателя
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
Идентификатор назначателя
|
assignerId | string |
Идентификатор пользователя последнего пользователя для добавления назначаемого |
|
Associations
|
associations | array of Association |
Список связей для задачи |
|
Копирование из
|
copyFrom | string |
Идентификатор задачи, скопированный из |
|
Создано в
|
createdAt | date-time |
Дата создания задачи |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Настраиваемые свойства
|
customProperties | array of CustomPropertyValues |
Список настраиваемых свойств задачи |
|
Description
|
description | string |
Описание задачи |
|
Подписчики
|
followers | array of Follower |
Список подписчиков для задачи |
|
Идентификатор задачи
|
id | string | |
|
Шаблон
|
isTemplate | boolean |
Указывает, является ли задача частью шаблона |
|
Максимальный ранг
|
maxRank | string |
Максимальный ранг |
|
Min Rank
|
minRank | string |
Минимальный ранг |
|
Родительский идентификатор
|
parentId | string |
Идентификатор задачи родительского элемента, если задача является подзадакой |
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты окончания (дата выполнения) |
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты начала |
|
Priority
|
priority | string |
Значение приоритета |
|
Код проекта
|
projectId | string |
Идентификатор проекта, к которому принадлежит задача |
|
Ранг
|
rank | string |
Ранжирование задачи в списке задач |
|
Идентификатор пространства
|
spaceId | string | |
|
Идентификатор схемы состояния
|
statusSchemaId | string | |
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага схемы состояния |
|
ИД шаблона
|
templateId | string |
Идентификатор шаблона шаблона, к которому принадлежит задача |
|
Название
|
title | string |
Название задачи |
|
Тип
|
type | string |
Тип задачи |
|
Обновление по адресу
|
updatedAt | date-time |
Дата последнего обновления задачи |
PlannerTask
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Фактическая длительность
|
actualDuration | integer |
Вычисляемая фактическая длительность в днях |
|
Фактическая дата окончания
|
actualEndDate | date-time |
Дата завершения работы над задачей |
|
Фактическая дата начала
|
actualStartDate | date-time |
Дата начала работы над задачей |
|
Назначение идентификатора
|
assigneeId | string |
Идентификатор пользователя назначаемого |
|
Идентификатор назначателя
|
assignerId | string |
Идентификатор пользователя последнего пользователя для добавления назначаемого |
|
Associations
|
associations | array of Association |
Список связей для задачи |
|
Копирование из
|
copyFrom | string |
Идентификатор задачи, скопированный из |
|
Создано в
|
createdAt | date-time |
Дата создания задачи |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Настраиваемые свойства
|
customProperties | array of CustomPropertyValues |
Список настраиваемых свойств задачи |
|
Description
|
description | string |
Описание задачи |
|
Подписчики
|
followers | array of Follower |
Список подписчиков для задачи |
|
Идентификатор задачи
|
id | string | |
|
Шаблон
|
isTemplate | boolean |
Указывает, является ли задача частью шаблона |
|
Максимальный ранг
|
maxRank | string |
Максимальный ранг |
|
Min Rank
|
minRank | string |
Минимальный ранг |
|
Родительский идентификатор
|
parentId | string |
Идентификатор задачи родительского элемента, если задача является подзадакой |
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированной даты окончания (дата выполнения) |
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
Priority
|
priority | string |
Значение приоритета |
|
Код проекта
|
projectId | string |
Идентификатор проекта, к которому принадлежит задача |
|
Ранг
|
rank | string |
Ранжирование задачи в списке задач |
|
Идентификатор пространства
|
spaceId | string | |
|
Идентификатор схемы состояния
|
statusSchemaId | string | |
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага схемы состояния |
|
Идентификаторы вложенных задач
|
subTaskIds | array of string |
Список идентификаторов подзадак |
|
Вложенные задачи
|
subTasks | array of PlannerSubTask |
Список подзадач задачи |
|
ИД шаблона
|
templateId | string |
Идентификатор шаблона шаблона, к которому принадлежит задача |
|
Название
|
title | string |
Название задачи |
|
Тип
|
type | string |
Тип задачи |
|
Обновлено в
|
updatedAt | date-time |
Дата последнего обновления задачи |
PlannerTaskQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Объекты задач
|
items | array of PlannerTask |
Список объектов задач в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
Возможное значениеValuesItem
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор значения
|
id | string | |
|
Заказ
|
order | integer |
Число, указывающее порядок |
|
Ценность
|
value |
Фактические данные значений |
ProjectAssociatedNodes
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор узла
|
nodeId | string | |
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
Идентификатор пространства
|
spaceId | string |
RequestFormCustomProperties
Настраиваемые свойства формы запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | date-time |
Строка даты создания |
|
Настраиваемые свойства
|
customProperties | array of CustomProperty |
Список настраиваемых свойств |
ScopeSettingsItemDefinition
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Требуется
|
isRequired | boolean |
Индикатор того, является ли поле обязательным или нет |
|
Scope
|
scope | string |
Список типов узлов, к которым принадлежит определение настраиваемого свойства |
StatusSchema
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | date-time |
Строка даты создания |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Идентификатор схемы состояния
|
id | string | |
|
Значение по умолчанию
|
isDefault | boolean |
Индикатор о том, является ли схема состояния схемой по умолчанию |
|
Имя
|
name | string |
Имя схемы состояния |
|
Идентификатор пространства
|
spaceId | string | |
|
Этапы
|
steps | array of string |
Список шагов и их значений |
|
Переходы
|
transitions | array of array |
Список правил перехода |
|
items
|
transitions | array of integer | |
|
Тип
|
type | string |
Тип узла для схемы состояния можно использовать для |
|
Обновлено в
|
updatedAt | date-time |
Дата последнего обновления схемы состояния |
StatusSchemaQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Объекты схемы состояния
|
items | array of StatusSchema |
Список объектов схемы состояния в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
ValueSchemaPropertyDefinition
Определение схемы значений
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Максимальное число
|
max | string | |
|
Минимальное число
|
min | string |