Сейсмические программы (предварительная версия)
Соединитель "Сейсмическая программа" предлагает коллекцию действий и триггеров, предназначенных для взаимодействия с ключевыми функциями в продукте "Сейсмические программы". К ним относятся программы, которые отслеживают ход выполнения и конфигурации текущей программы включения; задачи, средство управления работой, которое отслеживает действия вашей команды; и запросы, позволяющие внешним участникам команды отправлять рабочие запросы в свою команду.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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 |
Соединитель "Сейсмическая программа"
Соединитель "Сейсмическая программа" предлагает коллекцию действий и триггеров, предназначенных для взаимодействия с ключевыми функциями в продукте "Сейсмические программы". К ним относятся программы, которые отслеживают ход выполнения и конфигурации текущей программы включения; задачи, средство управления работой, которое отслеживает действия вашей команды; и запросы, позволяющие внешним участникам команды отправлять рабочие запросы в свою команду.
Издатель: Сейсмический
Предпосылки
Для клиента требуется учетная запись пользователя Seismic Premium.
Поддерживаемые операции
Получение комментариев
Получение списка комментариев на одном узле (программа, задача, запрос).
Получение комментария
Получите один комментарий к одному узлу (программе, задаче, запросу).
Создание комментария
Создайте комментарий к одному узлу (программе, задаче, запросу).
Обновление комментария
Обновите существующий комментарий на одном узле (программа, задача, запрос).
Удаление комментария
Удалите комментарий на одном узле (программа, задача, запрос).
Получение программ
Получение списка программ в клиенте.
Получение программы
Получение одной программы в клиенте.
Создание программы
Создайте программу в клиенте.
Обновление программы
Обновите существующую программу в клиенте.
Удаление программ
Удалите список программ в клиенте.
Удаление программы
Удаление программы в клиенте.
Получение запросов
Получение списка запросов в клиенте.
Получение запроса
Получение одного запроса в клиенте.
Создание запроса
Создайте запрос в клиенте.
Обновление запроса
Обновите один запрос в клиенте.
Удаление запроса
Удаление одного запроса в клиенте.
Запросы на удаление
Удалите список запросов в клиенте.
Получение задач
Получение списка задач в клиенте.
Получение задачи
Получение одной задачи в клиенте.
Создать задачу
Создайте задачу в клиенте.
Обновление задачи
Обновите одну задачу в клиенте.
Удаление задачи
Удаление одной задачи в клиенте.
Удаление задач
Удалите список задач в клиенте.
Получение схем состояния
Получение списка схем состояния.
Получение схемы состояния
Получение одной схемы состояния
Триггер: при создании программы
Триггер, использующий веб-перехватчик ProgramCreate для возврата данных программы после его создания
Триггер: при обновлении программы
Триггер, использующий веб-перехватчик ProgramUpdate для возврата данных программы после обновления.
Триггер: при удалении программы
Триггер, использующий веб-перехватчик ProgramDelete для возврата данных программы после удаления.
Триггер: при создании задачи
Триггер, использующий веб-перехватчик ProgramTaskCreate для возврата данных задачи после его создания
Триггер: при обновлении задачи
Триггер, использующий веб-перехватчик ProgramTaskUpdate для возврата данных задачи после обновления.
Триггер: при удалении задачи
Триггер, использующий веб-перехватчик ProgramTaskDelete для возврата данных задачи после удаления.
Триггер: при создании запроса
Триггер, использующий веб-перехватчик ProgramRequestCreate для возврата данных запроса после его создания
Триггер: при обновлении запроса
Триггер, использующий веб-перехватчик ProgramRequestUpdate для возврата данных запроса после его обновления
Триггер: при удалении запроса
Триггер, использующий веб-перехватчик ProgramRequestDelete для возврата данных запроса после удаления.
Получение учетных данных
Для клиента требуется учетная запись пользователя Seismic Premium. Если у вас нет достаточных разрешений, обратитесь к администратору системы Сейсмических данных.
Начало работы
Соединитель "Сейсмические программы" включает следующие действия. Каждое действие соответствует конечной точке API. Дополнительные сведения о полях и свойствах, связанных с действием, см. в статье для каждой соответствующей конечной точки API.
- Получение комментариев
- Получение комментария
- Создание комментария
- Обновление комментария
- Удаление комментария
- Получение программ
- Получение программы
- Создание программы
- Обновление программы
- Удаление программ
- Удаление программы
- Получение запросов
- Получение запроса
- Создание запроса
- Обновление запроса
- Удаление запросов
- Удаление запроса
- Получение задач
- Получение задачи
- Создание задачи
- Обновление задачи
- Удаление задач
- Удаление задачи
- Триггер: создание программы
- Триггер: обновление программы
- Триггер: удаление программы
- Триггер: создание задачи
- Триггер: обновление задачи
- Триггер: удаление задачи
- Триггер: создание запроса
- Триггер: обновление запроса
- Триггер: удаление запроса
Известные проблемы и ограничения
В настоящее время проблемы и ограничения не известны. Все API работают в соответствии с политикой сейсмического API, включая ограничения скорости. Ознакомьтесь с порталом разработчика По сейсмической аналитике для спецификаций, ограничений и стандартов API.
Инструкции по развертыванию
Используйте эти инструкции для развертывания этого соединителя в качестве пользовательского соединителя в Microsoft Power Automate и Power Apps.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| GET-запрос |
Получение одного запроса. |
| Вывод задачи |
Получение одной задачи по идентификатору. |
| Запрос на обновление |
Обновление запроса. |
| Запросы на удаление |
Массовые запросы на удаление. |
| Обновление задачи |
Обновите существующую задачу. |
| Обновление комментария |
Обновите существующий комментарий. Требуется узел (программа, задача или запрос) и идентификатор комментария. |
| Обновление программы |
Обновление и возврат программы. |
| Получение задач |
Получение списка задач. |
| Получение запросов |
Получение списка запросов. |
| Получение комментариев |
Получение всех комментариев для данной программы, задачи или запроса. Требуется идентификатор узла (программа, задача или запрос). |
| Получение комментария |
Получение одного комментария. Требуется узел (программа, задача или запрос) и идентификатор комментария. |
| Получение программ |
Получите список программ с их атрибутами и связями. |
| Получение программы |
Получение одной программы по идентификатору. При желании верните задачи. |
| Получение схем состояния |
Получение списка схем состояния задачи или запроса. Эти схемы содержат данные для задания состояний для конкретной работы. Пример: |
| Получение схемы состояния |
Получение отдельной схемы состояния по идентификатору. Эти схемы содержат данные для задания состояний для конкретной работы. Пример: |
| Создание задачи |
Создайте задачу. |
| Создание примечания |
Создайте комментарий к заданной программе, задаче или запросу. Требуется идентификатор узла (программа, задача или запрос). |
| Создание программы |
Создайте программу. |
| Создать запрос |
Создайте запрос. |
| Удаление задачи |
Удаление задачи. |
| Удаление комментария |
Удалите комментарий. Требуется узел (программа, задача или запрос) и идентификатор комментария. |
| Удаление программ |
Удалите одну или несколько программ. |
| Удаление программы |
Удаление программы. |
| Удалить запрос |
Удаление запроса. |
GET-запрос
Получение одного запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор запроса
|
requestId | True | string |
Идентификатор запроса |
Возвращаемое значение
- Тело
- ProgramRequest
Вывод задачи
Получение одной задачи по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи |
Возвращаемое значение
- Тело
- ProgramTask
Запрос на обновление
Обновление запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
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 | True |
Объект ссылки на форму |
|
|
Замечание
|
note | string |
Примечание, используемое для уведомлений об изменениях состояния |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированной даты окончания (дата выполнения) |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
|
Priority
|
priority | string |
Значение приоритета |
|
|
Идентификатор программы
|
programId | string |
Идентификатор программы, к которой принадлежит запрос |
|
|
Идентификатор шага
|
stepId | True | integer |
Идентификатор шага, указывающий состояние |
|
Название
|
title | True | string |
Заголовок запроса |
Возвращаемое значение
- Тело
- ProgramRequest
Запросы на удаление
Массовые запросы на удаление.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
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 |
Значение приоритета |
|
|
Идентификатор программы
|
programId | string |
Идентификатор программы, к которому принадлежит задача |
|
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага, указывающий состояние задачи |
|
|
Название
|
title | True | string |
Название задачи |
Возвращаемое значение
- Тело
- ProgramTask
Обновление комментария
Обновите существующий комментарий. Требуется узел (программа, задача или запрос) и идентификатор комментария.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Идентификатор комментария
|
commentId | True | string |
Идентификатор комментария |
|
Полезные данные заметки
|
annotationPayload | string | ||
|
Тип заметки
|
annotationType | string | ||
|
Содержимое примечания
|
commentContent | True | string |
Содержимое комментария |
|
Разрешено
|
isResolved | boolean |
Значение true/false для разрешения комментария |
Возвращаемое значение
- Тело
- Comment
Обновление программы
Обновление и возврат программы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор программы
|
programId | True | string |
Идентификатор программы |
|
Идентификатор типа этапа
|
phaseTypeId | True | string |
Идентификатор типа этапа |
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
|
Дата и время
|
datetime | date-time |
Время даты для этапа |
|
|
Имя
|
name | string |
Имя этапа |
|
|
associatedToField
|
associatedToField | string |
Поле, с которым связан этап, из PhaseType |
|
|
Description
|
description | string |
Описание этапа, который происходит из PhaseType |
|
|
Цвет
|
color | string |
Цвет фазы, поступающий из PhaseType |
|
|
Порядковый номер
|
ordinality | integer |
Порядок этапов, поступающих из PhaseType |
|
|
Archived
|
archived | boolean |
Индикатор, если программа архивирована или нет |
|
|
Включен
|
enabled | boolean |
Устаревший индикатор для архива |
|
|
Скрыть советы
|
hideTips | boolean |
Индикатор, если у пользователя есть скрытые советы или нет |
|
|
Дата запуска
|
launchDate | date-time |
Дата запуска |
|
|
Тип
|
type | string |
Тип объекта аудитории |
|
|
Идентификатор
|
id | string |
Идентификатор аудитории (группа пользователей, пользователь и т. д.) |
|
|
Трекеров
|
trackers | array of string |
Список отслеживания ключевых слов |
|
|
Темы
|
topics | array of string |
Список разделов ключевых слов |
|
|
Тип программы
|
programType | string |
Тип программы |
|
|
Метрика первого результата ключевого показателя эффективности
|
outcomeKpiFirst | string |
Метрика первого результата ключевого показателя эффективности |
|
|
Вторая метрика ключевого показателя эффективности
|
outcomeKpiSecond | string |
Вторая метрика ключевого показателя эффективности |
|
|
Третья метрика ключевого показателя эффективности
|
outcomeKpiThird | string |
Третья метрика ключевого показателя эффективности |
|
|
Тип метрик
|
metricType | string |
Тип метрик |
|
|
Целевое значение
|
targetValue | string |
Целевое значение указанного пользователем числа для цели |
|
|
Измеряется в
|
measuredIn | string |
Параметр для задания измерения метрики |
|
|
ТЕНДЕНЦИЯ
|
trend | string |
Параметр для задания отслеживания целевой тенденции |
|
|
Диапазон дат
|
dateRange | string |
Диапазон дат, заданный для тренда |
|
|
Скрытие из обзора
|
isHideFromOverView | boolean |
Параметр для скрытия цели метрик на странице обзора |
|
|
Description
|
description | string |
Описание ассоциации |
|
|
Имя
|
name | string |
Имя ассоциации |
|
|
GUID узла
|
nodeGuid | string |
Более длинный формат GUID |
|
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
|
GUID пространства
|
spaceGuid | string |
Более длинный формат GUID |
|
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
|
Идентификатор пользовательского свойства
|
id | string | ||
|
Локализации
|
localizations | object |
Объект локализации |
|
|
Несколько значений
|
multipleValue | boolean |
Укажите, разрешает ли пользовательское свойство несколько значений. |
|
|
Имя
|
name | string |
Имя настраиваемого свойства |
|
|
Идентификатор значения
|
id | string | ||
|
Ценность
|
value |
Значения данных для значения пользовательского свойства |
||
|
Description
|
description | string |
Описание программы |
|
|
Активен
|
isActive | boolean |
Индикатор того, активна ли программа? |
|
|
Идентификатор диспетчера
|
managerId | string |
Идентификатор пользователя диспетчера программ |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты запланированного окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты запланированного начала |
|
|
Название
|
title | True | string |
Название программы |
Возвращаемое значение
- Тело
- Program
Получение задач
Получение списка задач.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
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 |
Включение подзадач в возвращаемый список |
|
|
Идентификатор программы
|
programId | string |
Фильтрация по идентификатору программы |
|
|
Имеет программу
|
hasProgram | 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 |
Сортировка по запросам |
|
|
Идентификатор программы
|
programId | string |
Идентификатор программы, с который связан запрос |
|
|
Имеет программу
|
hasProgram | 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 |
Идентификатор пространства |
|
Дата запланированного окончания из
|
plannedEndDateFrom | date-time |
Фильтрация по запланированной дате окончания |
|
|
Запланированная дата окончания
|
plannedEndDateTo | date-time |
Фильтрация по запланированной дате окончания |
|
|
Запланированная дата начала с
|
plannedStartDateFrom | date-time |
Фильтрация по запланированной дате начала |
|
|
Запланированная дата начала
|
plannedStartDateTo | date-time |
Фильтрация по запланированной дате начала |
|
|
Дата запуска из
|
launchDateFrom | date-time |
Фильтрация по дате запуска |
|
|
Дата запуска до
|
launchDateTo | date-time |
Фильтрация по дате запуска |
|
|
Идентификаторы программ
|
ids | array |
Список идентификаторов программ для запроса по |
|
|
Название программы
|
title | string |
Название программы для запроса по |
|
|
Идентификаторы диспетчера
|
managerIds | array |
Список идентификаторов пользователей для запроса диспетчером |
|
|
Идентификаторы создателя
|
creatorIds | array |
Список идентификаторов пользователей для запроса создателем |
|
|
Идентификаторы связанных узлов
|
associatedNodeIds | array |
Список идентификаторов сопоставлений для запроса по |
|
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
|
Лимит
|
limit | integer |
Число для ограничения возвращаемых записей |
|
|
Сортировать
|
sort | array |
Сортировка запроса |
|
|
Настраиваемые свойства
|
customProperties | string |
Список настраиваемых свойств для запроса по |
|
|
Идентификаторы последователей
|
followerIds | array |
Список идентификаторов пользователей для запроса подписчиком |
|
|
Archived
|
archived | boolean |
Список архивных или неархивированных программ |
|
|
Аудитория
|
audience | array |
Список идентификаторов пользователей аудитории программы для запроса по |
|
|
Тип программы
|
programType | string |
Перечисление ProgramType для запроса по |
|
|
Метрика первого результата ключевого показателя эффективности
|
outcomeKpiFirst | string |
Перечисление метрики ключевых показателей эффективности первого результата для запроса |
|
|
Вторая метрика ключевого показателя эффективности
|
outcomeKpiSecond | string |
Вторая перечисление метрики ключевого показателя эффективности для запроса |
|
|
Третья метрика ключевого показателя эффективности
|
outcomeKpiThird | string |
Перечисление метрик ключевого показателя эффективности третьего результата для запроса |
|
|
Текущие этапы
|
currentPhases | array |
Список идентификаторов текущего этапа для запроса по |
|
|
Включение ассоциаций
|
includeAssociations | boolean |
Индикатор, позволяющий включить данные ассоциации |
|
|
Включение архива
|
includeDeactivatedPrograms | boolean |
Индикатор для включения архивных программ (игнорируется при передаче) |
|
|
Включение страниц
|
includePages | boolean |
Индикатор, позволяющий включить данные страниц |
Возвращаемое значение
- Тело
- ProgramQueryResponse
Получение программы
Получение одной программы по идентификатору. При желании верните задачи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор программы
|
programId | True | string |
Идентификатор программы |
|
Глубина связанных узлов
|
associatedNodesDepth | integer |
Число, указывающее глубину возвращаемых данных узла |
|
|
Включение работ
|
includeWorks | boolean |
Индикатор включения связанных данных задач |
Возвращаемое значение
- Тело
- Program
Получение схем состояния
Получение списка схем состояния задачи или запроса. Эти схемы содержат данные для задания состояний для конкретной работы.
Пример: (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 |
Значения приоритета |
|
|
Идентификатор программы
|
programId | string |
Идентификатор программы, с которым связана задача |
|
|
Название
|
title | True | string |
Название задачи |
Возвращаемое значение
- Тело
- ProgramTask
Создание примечания
Создайте комментарий к заданной программе, задаче или запросу. Требуется идентификатор узла (программа, задача или запрос).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Полезные данные заметки
|
annotationPayload | string | ||
|
Тип заметки
|
annotationType | string |
Тип заметки |
|
|
Содержимое примечания
|
commentContent | True | 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 | True | string |
Название программы |
Возвращаемое значение
- Тело
- Program
Создать запрос
Создайте запрос.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
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 | True |
Объект ссылки на форму |
|
|
Запланированная длительность
|
plannedDuration | integer |
Запланированная длительность в днях |
|
|
Дата запланированного окончания
|
plannedEndDate | date-time |
Строка даты окончания |
|
|
Запланированная дата начала
|
plannedStartDate | date-time |
Строка даты начала |
|
|
Priority
|
priority | string |
Значение приоритета |
|
|
Идентификатор программы
|
programId | string |
Идентификатор программы, к которой принадлежит запрос |
|
|
Идентификатор схемы состояния
|
statusSchemaId | string | ||
|
Название
|
title | True | string |
Заголовок запроса |
Возвращаемое значение
- Тело
- ProgramRequest
Удаление задачи
Удаление задачи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор задачи
|
taskId | True | string |
Идентификатор задачи |
Возвращаемое значение
Удаление комментария
Удалите комментарий. Требуется узел (программа, задача или запрос) и идентификатор комментария.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор узла
|
nodeId | True | string |
Идентификатор узла |
|
Идентификатор комментария
|
commentId | True | string |
Идентификатор комментария |
Удаление программ
Удалите одну или несколько программ.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификаторы программ
|
ids | True | array |
Список идентификаторов программ |
|
Удаление задач
|
deleteTasks | boolean |
Кроме того, удалите связанные задачи |
Возвращаемое значение
Удаление программы
Удаление программы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор программы
|
programId | True | string |
Идентификатор программы |
|
Удаление задач
|
deleteTasks | boolean |
Кроме того, удалите связанные задачи |
Возвращаемое значение
Удалить запрос
Удаление запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
spaceId | True | string |
Идентификатор пространства |
|
Идентификатор запроса
|
requestId | True | string |
Идентификатор запроса |
Триггеры
| При обновлении задачи |
Триггер для реагирования на обновление задачи |
| При обновлении запроса |
Триггер для реагирования на обновление запроса |
| При обновлении программы |
Триггер для реагирования на обновление программы |
| При создании задачи |
Триггер для реагирования на момент создания задачи |
| При создании запроса |
Триггер для реагирования на момент создания запроса |
| При создании программы |
Триггер для реагирования на момент создания программы |
| При удалении задачи |
Триггер для реагирования на удаление задачи |
| При удалении запроса |
Триггер для реагирования на удаление запроса |
| При удалении программы |
Триггер для реагирования на удаление программы |
При обновлении задачи
Триггер для реагирования на обновление задачи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | TaskWebhookResponse |
При обновлении запроса
Триггер для реагирования на обновление запроса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | RequestWebhookResponse |
При обновлении программы
Триггер для реагирования на обновление программы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | ProgramWebhookResponse |
данные |
При создании задачи
Триггер для реагирования на момент создания задачи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | TaskWebhookResponse |
При создании запроса
Триггер для реагирования на момент создания запроса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | RequestWebhookResponse |
При создании программы
Триггер для реагирования на момент создания программы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | ProgramWebhookResponse |
данные |
При удалении задачи
Триггер для реагирования на удаление задачи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | TaskWebhookResponse |
При удалении запроса
Триггер для реагирования на удаление запроса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | RequestWebhookResponse |
При удалении программы
Триггер для реагирования на удаление программы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
фильтр
|
filter | string |
Пример: $.data.. [? (@.id == 'foo')] , выражение фильтра на основе JsonPath, см https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events . дополнительные сведения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
Уникальный идентификатор события. |
|
version
|
version | string |
Версия события, например ProgramCreateV1. |
|
произошло
|
occurredAt | date-time |
Метка времени ISO 8601 при возникновении события в формате UTC. |
|
tenantId
|
tenantId | uuid |
Уникальный идентификатор клиента. |
|
tenantName
|
tenantName | string |
Имя клиента. |
|
приложение
|
application | string |
Приложение, в котором возникло событие. |
|
productArea
|
productArea | string |
Область продукта, связанная с событием. |
|
данные
|
data | ProgramWebhookResponse |
данные |
Определения
Ассоциация
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
description | string |
Описание ассоциации |
|
Имя
|
name | string |
Имя ассоциации |
|
GUID узла
|
nodeGuid | string |
Более длинный формат GUID |
|
Идентификатор узла
|
nodeId | string |
Идентификатор узла |
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
GUID пространства
|
spaceGuid | string |
Более длинный формат GUID |
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
AsyncOperationResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификаторы асинхронных операций
|
asyncOperationIds | array of string |
Список идентификаторов асинхронных действий |
Аудитория
Объект Аудитории
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип
|
type | string |
Тип объекта аудитории |
|
Идентификатор
|
id | 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 |
Сортировка запроса |
MetricObjective
Объект целевой метрики
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип метрик
|
metricType | string |
Тип метрик |
|
Целевое значение
|
targetValue | string |
Целевое значение указанного пользователем числа для цели |
|
Измеряется в
|
measuredIn | string |
Параметр для задания измерения метрики |
|
ТЕНДЕНЦИЯ
|
trend | string |
Параметр для задания отслеживания целевой тенденции |
|
Диапазон дат
|
dateRange | string |
Диапазон дат, заданный для тренда |
|
Скрытие из обзора
|
isHideFromOverView | boolean |
Параметр для скрытия цели метрик на странице обзора |
Phase
Этап программы
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор типа этапа
|
phaseTypeId | string |
Идентификатор типа этапа |
|
Идентификатор пространства
|
spaceId | string |
Идентификатор пространства |
|
Дата и время
|
datetime | date-time |
Время даты для этапа |
|
Имя
|
name | string |
Имя этапа |
|
associatedToField
|
associatedToField | string |
Поле, с которым связан этап, из PhaseType |
|
Description
|
description | string |
Описание этапа, который происходит из PhaseType |
|
Цвет
|
color | string |
Цвет фазы, поступающий из PhaseType |
|
Порядковый номер
|
ordinality | integer |
Порядок этапов, поступающих из PhaseType |
Программа
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Фактическая длительность
|
actualDuration | integer |
Вычисляемая фактическая длительность в днях |
|
Фактическая дата окончания
|
actualEndDate | date-time |
Вычисляемая дата окончания с момента окончания программы |
|
Фактическая дата начала
|
actualStartDate | date-time |
Вычисляемая дата начала с момента начала программы |
|
Параметр аналитики
|
analyticSetting | ProgramAnalyticSetting | |
|
Связанные узлы
|
associatedNodes | array of ProgramAssociatedNodes |
Список данных связи |
|
Associations
|
associations | array of Association |
Список связей (содержимое библиотеки) |
|
Копирование из
|
copyFrom | string |
Идентификатор программы копируется из |
|
Создано в
|
createdAt | date-time |
Строка даты создания |
|
Идентификатор создателя
|
creatorId | string |
Идентификатор пользователя создателя |
|
Настраиваемые свойства
|
customProperties | array of CustomPropertyValues |
Список настраиваемых свойств |
|
Краткое описание
|
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 ProgramTask |
Список задач и запросов |
ProgramAnalyticSetting
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Phase
|
currentPhase | Phase |
Этап программы |
|
Этапы
|
phases | array of Phase |
Список возможных этапов программы |
|
Archived
|
archived | boolean |
Индикатор, если программа архивирована или нет |
|
Включен
|
enabled | boolean |
Устаревший индикатор для архива |
|
Скрыть советы
|
hideTips | boolean |
Индикатор, если у пользователя есть скрытые советы или нет |
|
Дата запуска
|
launchDate | date-time |
Дата запуска |
|
Аудитория
|
audience | array of Audience |
Список групп пользователей для аудитории программы |
|
Трекеров
|
trackers | array of string |
Список отслеживания ключевых слов |
|
Темы
|
topics | array of string |
Список разделов ключевых слов |
|
Тип программы
|
programType | string |
Тип программы |
|
Метрика первого результата ключевого показателя эффективности
|
outcomeKpiFirst | string |
Метрика первого результата ключевого показателя эффективности |
|
Вторая метрика ключевого показателя эффективности
|
outcomeKpiSecond | string |
Вторая метрика ключевого показателя эффективности |
|
Третья метрика ключевого показателя эффективности
|
outcomeKpiThird | string |
Третья метрика ключевого показателя эффективности |
|
Цели метрик
|
metricObjectives | array of MetricObjective |
Список целей метрик |
ProgramQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Объекты программы
|
items | array of Program |
Список элементов программы в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
ProgramWebhookResponse
данные
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
tenantId
|
tenantId | string |
data/tenantId |
|
tenantName
|
tenantName | string |
data/tenantName |
|
actorId
|
actorId | string |
data/actorId |
|
временная метка события
|
eventTimestamp | integer |
data/eventTimestamp |
|
programId
|
programId | string |
data/programId |
|
title
|
title | string |
data/title |
|
описание
|
description | string |
data/description |
|
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
|
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
|
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
|
creatorId
|
creatorId | string |
data/creatorId |
|
createdAt
|
createdAt | date-time |
data/createdAt |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
присоединенныеrequests
|
attachedRequests | array of object |
присоединенныеrequests |
|
spaceId
|
attachedRequests.spaceId | string |
data/attachedRequests/spaceId |
|
requestId
|
attachedRequests.requestId | string |
data/attachedRequests/requestId |
|
присоединенныеtasks
|
attachedTasks | array of object |
присоединенныеtasks |
|
spaceId
|
attachedTasks.spaceId | string |
data/attachedTasks/spaceId |
|
taskId
|
attachedTasks.taskId | string |
data/attachedTasks/taskId |
|
managerId
|
managerId | string |
data/managerId |
|
isTemplate
|
isTemplate | boolean |
data/isTemplate |
|
обновлено
|
updatedAt | date-time |
data/updatedAt |
|
actualDuration
|
actualDuration | integer |
data/actualDuration |
|
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
|
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
|
copyFrom
|
copyFrom | string |
data/copyFrom |
|
Последователей
|
followers | array of object |
Последователей |
|
userId
|
followers.userId | string |
userId |
|
spaceId
|
spaceId | string |
data/spaceId |
|
идентификатор шаблона
|
templateId | string |
data/templateId |
|
updateDiffs
|
updateDiffs | array of object | |
|
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/before |
|
after
|
updateDiffs.after | string |
data/updateDiffs/after |
|
Параметр аналитики
|
analyticSetting | ProgramAnalyticSetting | |
|
customProperties
|
customProperties | array of object | |
|
id
|
customProperties.id | string |
data/customProperties/id |
|
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
|
имя
|
customProperties.name | string |
data/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object | |
|
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
|
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
type
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ProgramRequest
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор назначаемого получателя
|
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 |
Значение приоритета |
|
Идентификатор программы
|
programId | string |
Идентификатор программы, с которым связан запрос |
|
Ранг
|
rank | string |
Ранжирование запроса в списке запросов |
|
requestFormCustomPropertyOption
|
requestFormCustomPropertyOption | RequestFormCustomProperties |
Настраиваемые свойства формы запроса |
|
Идентификатор пространства
|
spaceId | string | |
|
Идентификатор схемы состояния
|
statusSchemaId | string | |
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага, указывающий значение состояния |
|
Название
|
title | string |
Заголовок запроса |
|
Обновлено в
|
updatedAt | date-time |
Дата последнего обновления запроса |
ProgramRequestQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Запрос объектов
|
items | array of ProgramRequest |
Список объектов запроса в ответе |
|
Лимит
|
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 |
Значение приоритета |
|
Идентификатор программы
|
programId | string |
Идентификатор программы, к которой принадлежит задача |
|
Ранг
|
rank | string |
Ранжирование задачи в списке задач |
|
Идентификатор пространства
|
spaceId | string | |
|
Идентификатор схемы состояния
|
statusSchemaId | string | |
|
Идентификатор шага
|
stepId | integer |
Идентификатор шага схемы состояния |
|
ИД шаблона
|
templateId | string |
Идентификатор шаблона шаблона, к которому принадлежит задача |
|
Название
|
title | string |
Название задачи |
|
Тип
|
type | string |
Тип задачи |
|
Обновление по адресу
|
updatedAt | date-time |
Дата последнего обновления задачи |
ProgramTask
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Фактическая длительность
|
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 |
Значение приоритета |
|
Идентификатор программы
|
programId | 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 |
Дата последнего обновления задачи |
ProgramTaskQueryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
count | integer |
Количество возвращенных записей |
|
Cursor
|
cursor | string |
Курсор, используемый для разбиения на страницы |
|
Объекты задач
|
items | array of ProgramTask |
Список объектов задач в ответе |
|
Лимит
|
limit | integer |
Число для ограничения записей |
|
Объект метаданных
|
meta | Meta |
Объект метаданных |
Возможное значениеValuesItem
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор значения
|
id | string | |
|
Заказ
|
order | integer |
Число, указывающее порядок |
|
Ценность
|
value |
Фактические данные значений |
ProgramAssociatedNodes
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор узла
|
nodeId | string | |
|
Тип узла
|
nodeType | string |
Тип узла связи |
|
Идентификатор пространства
|
spaceId | string |
RequestFormCustomProperties
Настраиваемые свойства формы запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
createdAt | date-time |
Строка даты создания |
|
Настраиваемые свойства
|
customProperties | array of CustomProperty |
Список настраиваемых свойств |
RequestWebhookResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
data/id |
|
tenantId
|
tenantId | string |
data/tenantId |
|
tenantName
|
tenantName | string |
data/tenantName |
|
requestId
|
requestId | string |
data/requestId |
|
временная метка события
|
eventTimestamp | integer |
data/eventTimestamp |
|
actorId
|
actorId | string |
data/actorId |
|
spaceId
|
spaceId | string |
data/spaceId |
|
title
|
title | string |
data/title |
|
assigneeId
|
assigneeId | string |
data/assigneeId |
|
assignerId
|
assignerId | string |
data/assignerId |
|
creatorId
|
creatorId | string |
data/creatorId |
|
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
|
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
|
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
|
createdAt
|
createdAt | date-time |
data/createdAt |
|
обновлено
|
updatedAt | date-time |
data/updatedAt |
|
статус
|
status | string |
data/status |
|
priority
|
priority | string |
data/priority |
|
programId
|
programId | string |
data/programId |
|
заметка
|
note | string |
данные и заметки |
|
formId
|
formRef.formId | string |
data/formRef/formId |
|
minorVersion
|
formRef.minorVersion | integer |
data/formRef/minorVersion |
|
мажорная версия
|
formRef.majorVersion | integer |
data/formRef/majorVersion |
|
Последователей
|
followers | array of object |
Последователей |
|
userId
|
followers.userId | string |
userId |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
updateDiffs
|
updateDiffs | array of object |
data/updateDiffs |
|
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/before |
|
after
|
updateDiffs.after | string |
data/updateDiffs/after |
|
customProperties
|
customProperties | array of object |
данные |
|
id
|
customProperties.id | string |
data/customProperties/id |
|
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
|
имя
|
customProperties.name | string |
data/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object |
customProperties |
|
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
|
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
type
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
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 |
Объект метаданных |
TaskWebhookResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
data/id |
|
tenantId
|
tenantId | string |
data/tenantId |
|
tenantName
|
tenantName | string |
data/tenantName |
|
taskId
|
taskId | string |
data/taskId |
|
временная метка события
|
eventTimestamp | integer |
data/eventTimestamp |
|
actorId
|
actorId | string |
data/actorId |
|
spaceId
|
spaceId | string |
data/spaceId |
|
title
|
title | string |
data/title |
|
описание
|
description | string |
data/description |
|
assigneeId
|
assigneeId | string |
data/assigneeId |
|
assignerId
|
assignerId | string |
data/assignerId |
|
creatorId
|
creatorId | string |
data/creatorId |
|
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
|
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
|
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
|
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
|
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
|
actualDuration
|
actualDuration | integer |
data/actualDuration |
|
createdAt
|
createdAt | date-time |
data/createdAt |
|
обновлено
|
updatedAt | date-time |
data/updatedAt |
|
статус
|
status | string |
data/status |
|
priority
|
priority | string |
data/priority |
|
parentId
|
parentId | string |
data/parentId |
|
programId
|
programId | string |
data/programId |
|
copyFrom
|
copyFrom | string |
data/copyFrom |
|
Последователей
|
followers | array of object |
Последователей |
|
userId
|
followers.userId | string |
userId |
|
идентификатор шаблона
|
templateId | string |
data/templateId |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
attachedSubTasks
|
attachedSubTasks | array of object |
attachedSubTasks |
|
spaceId
|
attachedSubTasks.spaceId | string |
data/attachedSubTasks/spaceId |
|
taskId
|
attachedSubTasks.taskId | string |
data/attachedSubTasks/taskId |
|
updateDiffs
|
updateDiffs | array of object | |
|
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/before |
|
after
|
updateDiffs.after | string |
data/updateDiffs/after |
|
customProperties
|
customProperties | array of object |
данные |
|
id
|
customProperties.id | string |
data/customProperties/id |
|
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
|
имя
|
customProperties.name | string |
data/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object |
customProperties |
|
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
|
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
type
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ValueSchemaPropertyDefinition
Определение схемы значений
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Максимальное число
|
max | string | |
|
Минимальное число
|
min | string |