Мейстерплан

Meisterplan — это инструмент управления ресурсами на уровне портфеля, который помогает портфельным и диспетчерам ресурсов управлять людьми в командах и инициативах, будь то традиционные, гибкие или гибридные. Используйте его для принятия уверенных решений портфеля и интерактивного решения и решения конфликтов ресурсов.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга 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)
Контакт
Имя Поддержка Meisterplan
URL https://help.meisterplan.com/
Адрес электронной почты support@meisterplan.com
Метаданные соединителя
Publisher itdesign GmbH
Веб-сайт https://meisterplan.com
Политика конфиденциальности https://meisterplan.com/privacy-and-data-protection/
Категории Управление бизнесом; Бизнес-аналитика

Meisterplan — это инструмент управления ресурсами на уровне портфеля, который помогает портфельным и диспетчерам ресурсов управлять людьми в командах и инициативах, будь то традиционные, гибкие или гибридные. Используйте его для принятия уверенных решений портфеля и интерактивного решения и решения конфликтов ресурсов. Ознакомьтесь с доступностью ресурсов и емкостью, получением видимости проектов, приоритетами и выравниванием портфелями проектов с учетом стратегий и создания моделирования сценариев в режиме реального времени с помощью Meisterplan. Используя соединитель Meisterplan, вы можете интегрировать Meisterplan со всеми инструментами, которые используют команды, чтобы никто не должен выполнять двойное обслуживание данных проекта. Требуется ли обновить проект или поместить в утвержденный запрос времени ожидания, Meisterplan и Соединитель Meisterplan могут сделать процесс простым.

Предпосылки

Чтобы использовать соединитель Meisterplan, требуется учетная запись Meisterplan . Чтобы приступить к работе с Meisterplan, запросите демонстрацию или пробную версию.

Получение учетных данных

При использовании соединителя Meisterplan откроется диалоговое окно входа, в котором требуется выбрать регион, в котором находится система Meisterplan (США или ЕС). Затем введите учетные данные для Meisterplan, например имя пользователя и пароль, и нажмите кнопку "Войти". Затем нажмите кнопку "Авторизовать" , чтобы разрешить соединителю доступ к системе Meisterplan.

Начало работы с соединителем

Распространенные варианты использования:

  • Обновление сведений о проекте: если изменить проект в средстве управления проектами (например, Trello), например об обновлении состояния, соответствующий проект в Meisterplan автоматически обновляется.
  • Синхронизация выделения. При изменении выделения в электронной таблице в Интернете, например MS Excel, соответствующее выделение в Meisterplan автоматически обновляется.
  • Сохранение актуальности отсутствия ресурсов. Если вы утверждаете запрос времени ожидания от одного из сотрудников в электронной таблице, например Excel, соответствующая запись ресурса в Meisterplan автоматически обновляется.
  • Добавление новых проектов в Meisterplan: если добавить новый проект в одном из средств, новый проект автоматически создается в Meisterplan.
  • Добавление новых ресурсов в Meisterplan: если вы обновляете электронную таблицу в Интернете с новым сотрудником, они автоматически добавляются в пул ресурсов в Meisterplan.
  • Регулярно обновляйте данные сотрудников: если вы изменяете адрес ресурса в электронной таблице в Интернете, соответствующая запись ресурса в Meisterplan автоматически обновляется.
  • Подключение к Microsoft Teams. Если проект обновлен в Meisterplan, вы получите уведомление в настроенном канале Teams. Это уведомление можно настроить, чтобы включить ссылку на проект в Meisterplan, чтобы быстро открыть проект для получения дополнительных сведений.
  • Подключитесь к Ms Office: если новый проект добавлен в Meisterplan, указанные коллеги получат уведомления по электронной почте. Поток также можно настроить для добавления нового проекта во внешний источник резервного копирования в MS Office.

Известные проблемы и ограничения

  • В настоящее время нет известных ограничений или ограничений. Общие сведения об ограничении скорости, разбиении на страницы и т. д. см. в документации по REST API.

Распространенные ошибки и средства устранения неполадок

Соединитель Meisterplan использует REST API Meisterplan. Описание, включая коды состояния, можно найти в документации по REST API. Дополнительные сведения можно найти в Центре справки.

Часто задаваемые вопросы

  • Какие права пользователя Meisterplan должны иметь возможность использовать соединитель?

    • Пользователь Meisterplan должен иметь API-интерфейсы Access Meisterplan и подключить внешние приложения .
    • Пользователь Meisterplan должен иметь права на чтение и изменение полей, которые необходимо прочитать или обновить с помощью соединителя.

  • Можно ли использовать соединитель с выпуском Meisterplan Basic?

    • Да, соединитель поддерживается всеми выпусками Meisterplan. Некоторые действия доступны только с помощью meisterplan Pro-Edition или Premium-Edition.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Регион струна Регион размещенной системы Meisterplan True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Бизнес-цели

Возвращает все бизнес-цели
Замена вех

Заменяет вехи заданного проекта в сценарии.
Замена выделений

Эта конечная точка позволяет заменить все выделения проекта. Результат будет таким же, как если все существующие выделения удаляются, а переданные выделения создаются снова.
Замена задач

Эта конечная точка используется для замены всех существующих задач определенного проекта новым списком задач, предоставленных в запросе. Как это работает: вы отправляете список задач для определенного проекта. Система синхронизирует задачи проекта с этим списком с помощью ключа задачи в качестве идентификатора. Это означает:

  • Задачи в настоящее время в системе, но не в списке будут удалены. — Задачи в списке, которые не существуют в системе, будут созданы. — Задачи, которые существуют как в системе, так и в списке, будут обновлены, если есть изменения.
Замена отсутствия

Эта конечная точка позволяет заменить все отсутствие ресурса. Результат будет таким же, как если все существующие отсутствия удаляются, а переданные отсутствия создаются снова. Параметры запроса start и end можно использовать для указания диапазона времени для замены существующих отсутствия. Если эти параметры не используются, все отсутствия будут заменены только что отправленными отсутствием.
Замена фактических финансовых событий

Заменяет фактические финансовые события данного проекта в рамках сценария. Запрос ограничен 5000 фактическими финансовыми событиями на каждый проект.
Замена финансовых средств

Заменяет финансовые события данного проекта в рамках сценария.
Обновление Teams

Выполните обновление команды, указанной указанным идентификатором.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Обновление вех

Выполните обновление вехи, указанной указанным идентификатором.
Обновление выделения

Эта конечная точка позволяет обновить существующие выделения проекта. Изменения будут вноситься только для указанных диапазонов дат, а также указанных ресурсов и ролей.
Обновление единицы OBS

Обновляет имя единицы OBS или перемещает ее на другой родительский объект.
Обновление исключений календаря

Используйте этот запрос для замены всех исключений календаря за определенный период времени. Этот период времени можно определить с помощью корневого запуска и завершения атрибутов запроса. Укажите новый список исключений календаря со свойством исключений. Обратите внимание, что все исключения за указанный период будут перезаписаны исключениями, перечисленными в свойстве исключений.

  • Если значение NULL используется для начального и конечного периода, все исключения календаря перезаписываются. Если определена только дата начала периода, все исключения, начиная с этого времени, будут перезаписаны . Если определена только дата окончания периода, все исключения до этой точки будут перезаписаны. Если исключение удалено, а родительский календарь имеет исключение на эту дату, этот календарь наследует исключение из родительского календаря.
Обновление календарей

Выполните обновление календаря, указанного указанным идентификатором.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Обновление отклонений от календаря

Используйте этот запрос для замены всех отклонений календаря ресурса на определенный период времени. Этот период времени можно определить с помощью корневого запуска и завершения атрибутов запроса. Укажите новый список отклонений календаря со свойством отклонений. Обратите внимание, что все отклонения в указанном периоде будут перезаписаны отклонениями, перечисленными в свойстве отклонений.

  • Если значение NULL используется для начального и конечного периода, все отклонения календаря ресурса перезаписываются. Если определена только дата начала периода, все отклонения, начиная с этого времени, будут перезаписаны . Если определена только дата окончания периода, все отклонения до этой точки будут перезаписаны . Если значение NULL используется для начальной и/или конечной даты отклонения календаря, Предполагается, что отклонение будет длиться от корневого или до указанной выше даты начала или окончания.

Все отклонения объединяются в последовательную структуру. Случаи перекрывающихся отклонений будут разрешаться путем присвоения приоритета отклонениям, возникающим позже в массиве.
Обновление программ

Выполните обновление программы, указанной указанным идентификатором.
Обновление проектов

Выполните обновление проекта, указанного указанным идентификатором.
Обновление ресурсов

Выполните обновление ресурса, указанного указанным идентификатором.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Обновление ролей

Выполните обновление роли, указанной указанным идентификатором. Чтобы выполнить частичное обновление, необходимо отправить только обновленные поля. Чтобы удалить значение поля, поле должно быть отправлено явным значением NULL. Поля со значением по умолчанию будут сбрасываться до значения по умолчанию, если задано значение NULL.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Обновление сегментов емкости роли

Обновляет сегменты емкости для роли, указанной указанным идентификатором. Чтобы удалить все сегменты емкости, отправьте сегмент без запуска или завершения и 0 емкости
Обновление типов OBS

Выполняет обновление типа OBS, указанного указанным идентификатором.
Обновление фактического финансового события

Возвращает обновленное фактическое финансовое событие.
Обновление финансовых средств

Обновляет финансовое событие по идентификатору в определенном проекте сценария.
Отсутствие обновлений

Используйте этот запрос для обновления отсутствия.
Получение вех по идентификатору

Возвращает отдельную веху, указанную заданным идентификатором.
Получение всех единиц OBS

Эта конечная точка возвращает список всех единиц OBS для заданного типа OBS.
Получение всех типов OBS

Эта конечная точка предназначена только для типов OBS. Чтобы получить единицы OBS, используйте /obsTypes/<obs-type-id>/obsUnits
Получение выделения по идентификатору

Возвращает отдельное выделение, указанное заданным идентификатором.
Получение единицы OBS

Эта конечная точка возвращает одну единицу OBS.
Получение задачи по идентификатору

Возвращает отдельную задачу, указанную заданным идентификатором.
Получение календарей по идентификатору

Получите один календарь в системе Meisterplan. Используйте специальный идентификатор defaultCalendar для получения календаря по умолчанию.
Получение команды по идентификатору

Возвращает отдельную команду, указанную указанным идентификатором.
Получение комментария по выделению по идентификатору

Возвращает комментарий выделения.
Получение комментария проекта по идентификатору

Возвращает комментарий проекта.
Получение отклонений от календаря

Считывает отклонения в рабочие часы календаря ресурса. Если значения запуска и завершения не передаются, возвращаются все отклонения запрошенного ресурса. Если передается только начало, возвращаются все отклонения, начиная с этого времени. Если передается только окончание, возвращаются все отклонения до этой точки.
Получение отсутствия по идентификатору

Возвращает отдельное отсутствие, указанное указанным идентификатором.
Получение пользователя по идентификатору

Возвращает пользователя.
Получение программы по идентификатору

Возвращает отдельную программу, указанную заданным идентификатором.
Получение проектов по идентификатору

Возвращает отдельный проект, указанный заданным идентификатором.
Получение ресурсов по идентификатору

Возвращает отдельный ресурс, указанный заданным идентификатором.
Получение ролей по идентификатору

Возвращает отдельную роль, указанную заданным идентификатором.
Получение сегментов емкости всех ролей

Возвращает сегменты емкости для всех ролей. Если для данной роли нет сегментов емкости, ее емкости будут пустыми.
Получение сегментов емкости роли

Возвращает сегменты емкости для роли, указанной указанным идентификатором. Возвращает пустой список, если сегменты емкости отсутствуют.
Получение списка Teams

Эта конечная точка разбиается на страницы. Он возвращает список команд до указанного PAGESIZE
Получение списка вех

Возвращает список вех проекта
Получение списка выделений

Возвращает список выделений проекта
Получение списка зависимостей вехи

Возвращает список зависимостей вех сценария
Получение списка задач

Эта конечная точка разбиается на страницы. Он возвращает список задач до указанного PAGESIZE
Получение списка исключений календаря

Получите список всех исключений в этом календаре в системе Meisterplan.
Получение списка календарей

Получите список всех календарей в системе Meisterplan.
Получение списка комментариев выделения

Возвращает список комментариев выделения.
Получение списка комментариев проекта

Возвращает список комментариев проекта.
Получение списка отсутствия

Возвращает список отсутствия ресурса.
Получение списка пользователей

Возвращает список пользователей. Разрешает фильтрацию по имени пользователя или externalId.
Получение списка портфеля

Возвращает список всех доступных портфелей. Если у вас нет права просматривать любой портфель, возвращает список всех доступных портфелей, к которым вы имеете право доступа через маркер API. Если у вас нет права просматривать любой портфель, возвращается пустой список.
Получение списка программ

Возвращает список программ в данном сценарии
Получение списка проектов

Эта конечная точка разбиается на страницы. Он возвращает список проектов до указанного PAGESIZE
Получение списка ресурсов

Эта конечная точка разбиается на страницы. Он возвращает список ресурсов до указанного PAGESIZE
Получение списка ролей

Возвращает список всех доступных ролей. Если роли недоступны, возвращается пустой список.
Получение списка сценариев

Он возвращает список сценариев
Получение списка фактических рабочих времени

Возвращает список фактических рабочих времени для всех проектов определенного сценария. Обратите внимание, что фактические данные о рабочих работах не зависят от сценария.
Получение списка фактических финансовых событий

Возвращает список фактических финансовых событий проекта.
Получение списка финансовых средств

Возвращает список финансовых средств проекта
Получение Спринта по идентификатору

Возвращает отдельный спринт, указанный заданным идентификатором.
Получение ссылки на управление задачами

Возвращает ссылку на управление задачами проекта
Получение сценариев по идентификатору

Возвращает отдельный сценарий, указанный заданным идентификатором. HINT: Вы можете использовать planOfRecord в качестве идентификатора для плана записи.
Получение типа OBS по идентификатору

Эта конечная точка предназначена только для типов OBS. Чтобы получить единицы OBS, используйте /obsTypes/<obs-type-id>/obsUnits
Получение фактического рабочего времени по идентификатору

Возвращает отдельное фактическое время, указанное указанным идентификатором.
Получение фактического финансового события по идентификатору

Возвращает отдельное фактическое финансовое событие, указанное указанным идентификатором.
Получение финансовых средств по идентификатору

Возвращает отдельное финансовое событие, указанное указанным идентификатором.
Приоритеты обновления

Эта конечная точка обновляет приоритеты проектов и программ.
Создание Teams

Создает команду по заданным полям и возвращает только что созданное.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Создание вех

Возвращает только что созданную веху
Создание единицы OBS

Создает единицу OBS с заданными данными. Возвращает только что созданную единицу OBS.
Создание зависимости вехи

Возвращает идентификатор только что созданной зависимости вехи
Создание или обновление выделения

Эта конечная точка позволяет создавать новые выделения и обновлять существующие выделения проекта. Изменения будут вноситься только для указанных диапазонов дат, а также указанных ресурсов и ролей.
Создание или обновление задачи

Создает или обновляет задачу с заданными полями.
Создание или обновление фактического времени работы

Эта конечная точка позволяет создать новое фактическое время работы и обновить существующее фактическое время работы проекта сущностью (ресурсом или ролью). Мы не обновим фактическое время для дат бронирования, которые не указаны в запросе для данного проекта и сущности. С помощью свойства режима можно контролировать, заменяется ли существующее фактическое значение рабочего времени новым значением или если его значение добавляется в резервирование в запросе. Обратите внимание, что фактические данные о рабочих работах не зависят от сценария. Он будет одинаковым для всех сценариев для любого конкретного проекта. Запрос ограничен 5000 фактическими значениями времени для каждого проекта и ресурса или роли.
Создание календарей

Создайте календарь с заданными данными. Возвращает только что созданный календарь.
Создание отсутствия

Используйте этот запрос, чтобы добавить отсутствие в течение определенного периода времени. Этот период времени можно определить с помощью атрибутов начала и окончания запроса.
Создание программ

Создает программу с заданными полями и возвращает только что созданную программу.
Создание проектов

Создает проект с заданными полями и возвращает только что созданный проект.
Создание ресурсов

Создает ресурс по заданным полям и возвращает только что созданный.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Создание ролей

Возвращает созданную роль при успешном выполнении.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.
Создание типа OBS

Создает тип OBS с заданными данными. Возвращает только что созданный тип OBS.
Создание фактического финансового события

Возвращает только что созданное фактическое финансовое событие.
Создание финансовых средств

Возвращает только что созданное финансовое событие.
Ссылка на создание или обновление ссылки на управление задачами

Эта конечная точка позволяет добавить ссылку на управление задачами в проект или обновить externalViewUrl
Удаление Teams

Удалите команду, указанную указанным идентификатором. Если команда с заданным идентификатором не существует, запрос завершается ошибкой.
Удаление вех

Удаляет веху в заданном проекте сценария.
Удаление всех фактических рабочих времени с идентификатором проекта

Удаляет все фактическое время работы данного проекта.
Удаление выделений

Удаляет выделение в определенном проекте сценария.
Удаление единицы OBS по идентификатору

Удаляет единицу OBS, указанную указанным идентификатором. Если единица OBS с указанным идентификатором не существует, запрос завершится ошибкой.
Удаление зависимостей вехи

Удаляет зависимость вехи в заданном сценарии.
Удаление задачи

Удаляет задачу в заданном проекте.
Удаление календарей

Удаляет календарь в системе Meisterplan. Обратите внимание, что календарь по умолчанию или родительский элемент календаря по умолчанию нельзя удалить.
Удаление отсутствия

Удаляет отсутствие.
Удаление программ

Удаляет программу, указанную указанным идентификатором.
Удаление проектов

Удаляет проект в определенном сценарии.
Удаление ресурсов

Удалите ресурс, указанный указанным идентификатором. Если ресурс с заданным идентификатором не существует, запрос завершается ошибкой.
Удаление ролей

Удалите роль, указанную указанным идентификатором. Если роль с указанным идентификатором не существует, запрос завершится ошибкой.
Удаление типа OBS по идентификатору

Удалите тип OBS, указанный указанным идентификатором. Если тип OBS с заданным идентификатором не существует, запрос завершится ошибкой.
Удаление фактического времени, работаемого по идентификатору

Удаляет фактическое время работы в определенном проекте сценария.
Удаление фактического финансового события

Удаляет фактическое финансовое событие в определенном проекте сценария.
Удаление финансовых средств

Удаляет финансовое событие в определенном проекте сценария.
Удалить ссылку для управления задачами

Удаляет ссылку на управление задачами проекта
Установка календаря по умолчанию

Задает существующий календарь в качестве календаря по умолчанию в системе Meisterplan.

Бизнес-цели

Идентификатор операции:
GetAllBusinessGoals

Возвращает все бизнес-цели

Возвращаемое значение

List
ListResponseBusinessGoalDefinitionResponse

Замена вех

Идентификатор операции:
ReplaceMilestones

Заменяет вехи заданного проекта в сценарии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Имя
 name True string
Date
 date True string

формат: ГГГГ-MM-DD
Имя
 name string

Этап проекта должен существовать до создания. Он не будет неявно создан.
Ценность
 value string

Замена выделений

Идентификатор операции:
ReplaceAllocation

Эта конечная точка позволяет заменить все выделения проекта. Результат будет таким же, как если все существующие выделения удаляются, а переданные выделения создаются снова.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор
 id True string

Идентификатор сущности, к которой связано это выделение. Задайте для RESOLVE_BY_KEY_OR_NAME тип, чтобы автоматически разрешать ключи ресурсов или имена ролей.
Тип
 type string

Управление интерпретацией значения в идентификаторе поля. RESOURCE разрешает ресурсы по UUID. ROLE разрешает роли по UUID. RESOLVE_BY_KEY_OR_NAME разрешает ресурсы по ключу ресурса или ролям по имени роли.
Роль проекта
 projectRole string

Идентификатор роли, к которому связано это выделение. Это поле допустимо только в сочетании с типами RESOURCE или RESOLVE_BY_KEY_OR_NAME. Если для типа задано значение RESOLVE_BY_KEY_OR_NAME, projectRole разрешается по имени.
Start
 start True date
Готово
 finish True date
Fte
 fte double

Запрос принимает FTE, часы или дни.
Дни
 days double

Запрос принимает FTE, часы или дни.
Часы
 hours double

Запрос принимает FTE, часы или дни.

Замена задач

Идентификатор операции:
ReplaceTask

Эта конечная точка используется для замены всех существующих задач определенного проекта новым списком задач, предоставленных в запросе. Как это работает: вы отправляете список задач для определенного проекта. Система синхронизирует задачи проекта с этим списком с помощью ключа задачи в качестве идентификатора. Это означает:

  • Задачи в настоящее время в системе, но не в списке будут удалены. — Задачи в списке, которые не существуют в системе, будут созданы. — Задачи, которые существуют как в системе, так и в списке, будут обновлены, если есть изменения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Запрос на замена задачи
 tasksReplaceRequest True dynamic

Задача, представленная документом JSON.

Замена отсутствия

Идентификатор операции:
ReplaceAbsences

Эта конечная точка позволяет заменить все отсутствие ресурса. Результат будет таким же, как если все существующие отсутствия удаляются, а переданные отсутствия создаются снова. Параметры запроса start и end можно использовать для указания диапазона времени для замены существующих отсутствия. Если эти параметры не используются, все отсутствия будут заменены только что отправленными отсутствием.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Start
 start date

Дата начала периода замены
Конец
 end date

Включаемая дата окончания периода замены.
Start
 start True string

формат: ГГГГ-MM-DD
Готово
 finish True string

формат: ГГГГ-MM-DD
Тип дня начала
 startDayType string

Значение по умолчанию — FULL_DAY
Тип дня окончания
 finishDayType string

Значение по умолчанию — FULL_DAY

Замена фактических финансовых событий

Идентификатор операции:
ReplaceFinancialActuals

Заменяет фактические финансовые события данного проекта в рамках сценария. Запрос ограничен 5000 фактическими финансовыми событиями на каждый проект.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Тип
 type True string
Сумма
 amount True double
Дата резервирования
 bookingDate True date
Description
 description string
Имя
 name string

Перед созданием должна существовать категория финансовых средств. Он не будет неявно создан.

Замена финансовых средств

Идентификатор операции:
ReplaceFinancials

Заменяет финансовые события данного проекта в рамках сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Тип
 type True string
Сумма
 amount True double
Включено
 on True string

Веха действительна только в сочетании со значением в поле milestoneId. Дата действительна только в сочетании со значением в поле dueDate.
Идентификатор вехи
 milestoneId string

Допустимо только в сочетании с: Веха. Веха должна существовать в проекте. Он не будет неявно создан.
Срок
 dueDate string

Допустимо только в сочетании с: Дата (формат: ГГГГ-MM-DD).
Description
 description string
Имя
 name string

Перед созданием должна существовать категория финансовых средств. Он не будет неявно создан.

Обновление Teams

Идентификатор операции:
UpdateTeam

Выполните обновление команды, указанной указанным идентификатором.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор команды
 teamId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Команда, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление вех

Идентификатор операции:
UpdateMilestone

Выполните обновление вехи, указанной указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор вехи
 milestoneId True string

Внутренний идентификатор Meisterplan
Имя
 name string
Date
 date string

формат: ГГГГ-MM-DD
Имя
 name string

Этап проекта должен существовать до создания. Он не будет неявно создан.
Ценность
 value string

Возвращаемое значение

Веха
MilestoneResponse

Обновление выделения

Идентификатор операции:
UpdateAllocation

Эта конечная точка позволяет обновить существующие выделения проекта. Изменения будут вноситься только для указанных диапазонов дат, а также указанных ресурсов и ролей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор выделения
 allocationId True string

Внутренний идентификатор Meisterplan
Start
 start True date
Готово
 finish True date
Fte
 fte double

Запрос принимает FTE, часы или дни.
Дни
 days double

Запрос принимает FTE, часы или дни.
Часы
 hours double

Запрос принимает FTE, часы или дни.

Возвращаемое значение

Распределение
AllocationResponse

Обновление единицы OBS

Идентификатор операции:
UpdateObsUnit

Обновляет имя единицы OBS или перемещает ее на другой родительский объект.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan
Идентификатор единицы obs
 obsUnitId True string

Внутренний идентификатор Meisterplan
Имя
 name string
Родительский идентификатор
 parentId string

Возвращаемое значение

Единица obs
ObsUnitResponse

Обновление исключений календаря

Идентификатор операции:
CreateCalendarExceptions

Используйте этот запрос для замены всех исключений календаря за определенный период времени. Этот период времени можно определить с помощью корневого запуска и завершения атрибутов запроса. Укажите новый список исключений календаря со свойством исключений. Обратите внимание, что все исключения за указанный период будут перезаписаны исключениями, перечисленными в свойстве исключений.

  • Если значение NULL используется для начального и конечного периода, все исключения календаря перезаписываются. Если определена только дата начала периода, все исключения, начиная с этого времени, будут перезаписаны . Если определена только дата окончания периода, все исключения до этой точки будут перезаписаны. Если исключение удалено, а родительский календарь имеет исключение на эту дату, этот календарь наследует исключение из родительского календаря.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор календаря
 calendarId True string

Внутренний идентификатор Meisterplan
Start
 start date
Готово
 finish date
Date
 date True date
Часы работы
 workingHours True double
Description
 description string

Обновление календарей

Идентификатор операции:
UpdateCalendar

Выполните обновление календаря, указанного указанным идентификатором.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор календаря
 calendarId True string

Внутренний идентификатор Meisterplan
Имя
 name string
Monday
 monday True double
Вторник
 tuesday True double
Среда
 wednesday True double
Четверг
 thursday True double
Пятница
 friday True double
Суббота
 saturday True double
Воскресенье
 sunday True double

Возвращаемое значение

Calendar
CalendarResponse

Обновление отклонений от календаря

Идентификатор операции:
UpdateCalendarDeviations

Используйте этот запрос для замены всех отклонений календаря ресурса на определенный период времени. Этот период времени можно определить с помощью корневого запуска и завершения атрибутов запроса. Укажите новый список отклонений календаря со свойством отклонений. Обратите внимание, что все отклонения в указанном периоде будут перезаписаны отклонениями, перечисленными в свойстве отклонений.

  • Если значение NULL используется для начального и конечного периода, все отклонения календаря ресурса перезаписываются. Если определена только дата начала периода, все отклонения, начиная с этого времени, будут перезаписаны . Если определена только дата окончания периода, все отклонения до этой точки будут перезаписаны . Если значение NULL используется для начальной и/или конечной даты отклонения календаря, Предполагается, что отклонение будет длиться от корневого или до указанной выше даты начала или окончания.

Все отклонения объединяются в последовательную структуру. Случаи перекрывающихся отклонений будут разрешаться путем присвоения приоритета отклонениям, возникающим позже в массиве.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Start
 start date
Готово
 finish date
Start
 start date
Готово
 finish date
Относительная емкость
 relativeCapacity True double

Возвращаемое значение

List
ListResponseCalendarDeviationResponse

Обновление программ

Идентификатор операции:
UpdateProgram

Выполните обновление программы, указанной указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор программы
 programId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Программа, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление проектов

Идентификатор операции:
UpdateProject

Выполните обновление проекта, указанного указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Проект, представленный документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление ресурсов

Идентификатор операции:
UpdateResource

Выполните обновление ресурса, указанного указанным идентификатором.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Ресурс, представленный документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление ролей

Идентификатор операции:
UpdateRole

Выполните обновление роли, указанной указанным идентификатором. Чтобы выполнить частичное обновление, необходимо отправить только обновленные поля. Чтобы удалить значение поля, поле должно быть отправлено явным значением NULL. Поля со значением по умолчанию будут сбрасываться до значения по умолчанию, если задано значение NULL.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор роли
 roleId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Роль, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Обновление сегментов емкости роли

Идентификатор операции:
UpdateRoleCapacities

Обновляет сегменты емкости для роли, указанной указанным идентификатором. Чтобы удалить все сегменты емкости, отправьте сегмент без запуска или завершения и 0 емкости

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор роли
 roleId True string

Внутренний идентификатор Meisterplan
start
 start date
заканчивать
 finish date
fte
 fte double

Запрос принимает FTE, часы или дни.
Дни
 days double

Запрос принимает FTE, часы или дни.
Часов
 hours double

Запрос принимает FTE, часы или дни.

Возвращаемое значение

List
ListResponseRoleCapacityResponse

Обновление типов OBS

Идентификатор операции:
UpdateObsType

Выполняет обновление типа OBS, указанного указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan
Имя
 name True string

Возвращаемое значение

Тип Obs
ObsTypeResponse

Обновление фактического финансового события

Идентификатор операции:
UpdateFinancialActuals

Возвращает обновленное фактическое финансовое событие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор финансовых фактических данных
 actualFinancialEventId True string

Внутренний идентификатор Meisterplan
Тип
 type string
Сумма
 amount double
Дата резервирования
 bookingDate string

формат: ГГГГ-MM-DD
Description
 description string
Имя
 name string

Перед созданием должна существовать категория финансовых средств. Он не будет неявно создан.

Возвращаемое значение

Финансовые фактические данные
FinancialActualsResponse

Обновление финансовых средств

Идентификатор операции:
UpdateFinancials

Обновляет финансовое событие по идентификатору в определенном проекте сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор финансовых средств
 financialsId True string

Внутренний идентификатор Meisterplan
Тип
 type string
Сумма
 amount double
Включено
 on True string

Веха действительна только в сочетании со значением в поле milestoneId. Дата действительна только в сочетании со значением в поле dueDate.
Идентификатор вехи
 milestoneId string

Допустимо только в сочетании с: Веха. Веха должна существовать в проекте. Он не будет неявно создан.
Срок
 dueDate string

Допустимо только в сочетании с: Дата (формат: ГГГГ-MM-DD).
Description
 description string
Имя
 name string

Перед созданием должна существовать категория финансовых средств. Он не будет неявно создан.

Возвращаемое значение

Финансовые показатели
FinancialsResponse

Отсутствие обновлений

Идентификатор операции:
UpdateAbsences

Используйте этот запрос для обновления отсутствия.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Идентификатор отсутствия
 absenceId True string

Внутренний идентификатор Meisterplan
Start
 start string

формат: ГГГГ-MM-DD
Готово
 finish string

формат: ГГГГ-MM-DD
Тип дня начала
 startDayType string
Тип дня окончания
 finishDayType string

Возвращаемое значение

Отсутствие
AbsenceResponse

Получение вех по идентификатору

Идентификатор операции:
GetMilestoneById

Возвращает отдельную веху, указанную заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор вехи
 milestoneId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Веха
MilestoneResponse

Получение всех единиц OBS

Идентификатор операции:
GetAllObsUnits

Эта конечная точка возвращает список всех единиц OBS для заданного типа OBS.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseObsUnitResponse

Получение всех типов OBS

Идентификатор операции:
GetAllObsTypes

Эта конечная точка предназначена только для типов OBS. Чтобы получить единицы OBS, используйте /obsTypes/<obs-type-id>/obsUnits

Возвращаемое значение

List
ListResponseObsTypeResponse

Получение выделения по идентификатору

Идентификатор операции:
GetAllocationId

Возвращает отдельное выделение, указанное заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор выделения
 allocationId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Распределение
AllocationResponse

Получение единицы OBS

Идентификатор операции:
GetObsUnit

Эта конечная точка возвращает одну единицу OBS.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan
Идентификатор единицы obs
 obsUnitId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Единица obs
ObsUnitResponse

Получение задачи по идентификатору

Идентификатор операции:
GetTaskById

Возвращает отдельную задачу, указанную заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор задачи
 taskId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение календарей по идентификатору

Идентификатор операции:
GetCalendarById

Получите один календарь в системе Meisterplan. Используйте специальный идентификатор defaultCalendar для получения календаря по умолчанию.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор календаря
 calendarId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Calendar
CalendarResponse

Получение команды по идентификатору

Идентификатор операции:
GetTeamById

Возвращает отдельную команду, указанную указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор команды
 teamId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение комментария по выделению по идентификатору

Идентификатор операции:
GetAllocationComment

Возвращает комментарий выделения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор примечания выделения
 allocationCommentId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Комментарий к выделению
AllocationCommentResponse

Получение комментария проекта по идентификатору

Идентификатор операции:
GetProjectComment

Возвращает комментарий проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор комментария
 commentId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Комментарий проекта
ProjectCommentResponse

Получение отклонений от календаря

Идентификатор операции:
GetCalendarDeviations

Считывает отклонения в рабочие часы календаря ресурса. Если значения запуска и завершения не передаются, возвращаются все отклонения запрошенного ресурса. Если передается только начало, возвращаются все отклонения, начиная с этого времени. Если передается только окончание, возвращаются все отклонения до этой точки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Start
 start date

Дата начала для периода времени фильтрации
Готово
 finish date

Дата окончания периода времени фильтрации

Возвращаемое значение

List
ListResponseCalendarDeviationResponse

Получение отсутствия по идентификатору

Идентификатор операции:
GetAbsenceById

Возвращает отдельное отсутствие, указанное указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Идентификатор отсутствия
 absenceId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Отсутствие
AbsenceResponse

Получение пользователя по идентификатору

Идентификатор операции:
GetUser_1

Возвращает пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
 userId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

User
UserResponse

Получение программы по идентификатору

Идентификатор операции:
GetProgramById

Возвращает отдельную программу, указанную заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор программы
 programId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение проектов по идентификатору

Идентификатор операции:
GetProjectById

Возвращает отдельный проект, указанный заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ресурсов по идентификатору

Идентификатор операции:
GetResourceById

Возвращает отдельный ресурс, указанный заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ролей по идентификатору

Идентификатор операции:
GetRoleById

Возвращает отдельную роль, указанную заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор роли
 roleId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение сегментов емкости всех ролей

Идентификатор операции:
GetAllRoleCapacities

Возвращает сегменты емкости для всех ролей. Если для данной роли нет сегментов емкости, ее емкости будут пустыми.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseRoleWithRoleCapacityResponse

Получение сегментов емкости роли

Идентификатор операции:
GetRoleCapacities

Возвращает сегменты емкости для роли, указанной указанным идентификатором. Возвращает пустой список, если сегменты емкости отсутствуют.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор роли
 roleId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseRoleCapacityResponse

Получение списка Teams

Идентификатор операции:
GetAllTeams

Эта конечная точка разбиается на страницы. Он возвращает список команд до указанного PAGESIZE

Параметры

Имя Ключ Обязательно Тип Описание
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта. Выбирает все объекты, которые точно соответствуют указанным свойствам. Примечание. Обратите внимание на кодирование параметра URL-адресом. { resourceKey: string, "name": string}

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение списка вех

Идентификатор операции:
GetAllMilestones

Возвращает список вех проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseMilestoneResponse

Получение списка выделений

Идентификатор операции:
GetAllAllocations

Возвращает список выделений проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseAllocationResponse

Получение списка зависимостей вехи

Идентификатор операции:
GetAllMilestoneDependencies

Возвращает список зависимостей вех сценария

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.

Возвращаемое значение

Разбиение на страницы
PaginatedResponseMilestoneDependencyResponse

Получение списка задач

Идентификатор операции:
GetAllTasks

Эта конечная точка разбиается на страницы. Он возвращает список задач до указанного PAGESIZE

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Key
 key string

Выбирает все объекты, соответствующие ключу точно.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение списка исключений календаря

Идентификатор операции:
GetAllCalendarExceptions

Получите список всех исключений в этом календаре в системе Meisterplan.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор календаря
 calendarId True string

Внутренний идентификатор Meisterplan
Дата начала
 startDate date

Дата начала
Дата окончания
 endDate date

Дата окончания

Возвращаемое значение

List
ListResponseCalendarExceptionResponse

Получение списка календарей

Идентификатор операции:
GetAllCalendars

Получите список всех календарей в системе Meisterplan.

Возвращаемое значение

List
ListResponseCalendarResponse

Получение списка комментариев выделения

Идентификатор операции:
GetAllAllocationComments

Возвращает список комментариев выделения.

Параметры

Имя Ключ Обязательно Тип Описание
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Размер страницы
 pageSize integer

Размер страницы
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Разбиение на страницы
PaginatedResponseAllocationCommentResponse

Получение списка комментариев проекта

Идентификатор операции:
GetAllProjectComments

Возвращает список комментариев проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Размер страницы
 pageSize integer

Размер страницы
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Разбиение на страницы
PaginatedResponseProjectCommentResponse

Получение списка отсутствия

Идентификатор операции:
GetAllAbsences

Возвращает список отсутствия ресурса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Дата начала
 startDate date

Дата начала для периода времени фильтрации
Дата окончания
 finishDate date

Инклюзивная дата окончания для периода времени фильтрации.

Возвращаемое значение

List
ListResponseAbsenceResponse

Получение списка пользователей

Идентификатор операции:
GetAllUsers_1

Возвращает список пользователей. Разрешает фильтрацию по имени пользователя или externalId.

Параметры

Имя Ключ Обязательно Тип Описание
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Размер страницы
 pageSize integer

Размер страницы
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта.

Возвращаемое значение

Разбиение на страницы
PaginatedResponseUserResponse

Получение списка портфеля

Идентификатор операции:
GetAllPortfolios

Возвращает список всех доступных портфелей. Если у вас нет права просматривать любой портфель, возвращает список всех доступных портфелей, к которым вы имеете право доступа через маркер API. Если у вас нет права просматривать любой портфель, возвращается пустой список.

Возвращаемое значение

List
ListResponsePortfolioResponse

Получение списка программ

Идентификатор операции:
GetAllPrograms

Возвращает список программ в данном сценарии

Параметры

Имя Ключ Обязательно Тип Описание
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта. Выбирает все объекты, которые точно соответствуют указанным свойствам. Программы доступны для поиска по программеKey и имени. Примечание. Обратите внимание на кодирование параметра URL-адресом. { "programKey": string, "name": string}
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Разбиение на страницы
PaginatedResponseProgramGetAllResponse

Получение списка проектов

Идентификатор операции:
GetAllProjects

Эта конечная точка разбиается на страницы. Он возвращает список проектов до указанного PAGESIZE

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение списка ресурсов

Идентификатор операции:
GetAllResources

Эта конечная точка разбиается на страницы. Он возвращает список ресурсов до указанного PAGESIZE

Параметры

Имя Ключ Обязательно Тип Описание
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение списка ролей

Идентификатор операции:
GetAllRoles

Возвращает список всех доступных ролей. Если роли недоступны, возвращается пустой список.

Параметры

Имя Ключ Обязательно Тип Описание
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение списка сценариев

Идентификатор операции:
GetAllScenarios

Он возвращает список сценариев

Возвращаемое значение

List
ListResponseScenarioResponse

Получение списка фактических рабочих времени

Идентификатор операции:
GetAllActualTimeWorked

Возвращает список фактических рабочих времени для всех проектов определенного сценария. Обратите внимание, что фактические данные о рабочих работах не зависят от сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Размер страницы
 pageSize integer

Размер страницы
Страница после
 pageAfter string

Курсор, после которого извлекаются результаты. Курсор можно взять из предыдущего запроса.
Filter
 filter string

Строковый объект JSON с подмножеством свойств ожидаемого объекта.

Возвращаемое значение

Разбиение на страницы
PaginatedResponseActualTimeWorkedResponse

Получение списка фактических финансовых событий

Идентификатор операции:
GetAllActualFinancialEvents

Возвращает список фактических финансовых событий проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseFinancialActualsResponse

Получение списка финансовых средств

Идентификатор операции:
GetAllFinancials

Возвращает список финансовых средств проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

List
ListResponseFinancialsResponse

Получение Спринта по идентификатору

Идентификатор операции:
GetSprintById

Возвращает отдельный спринт, указанный заданным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор спринта
 sprintId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Тело
SprintResponse

Получение ссылки на управление задачами

Идентификатор операции:
GetTaskManagementLink

Возвращает ссылку на управление задачами проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение сценариев по идентификатору

Идентификатор операции:
GetScenarioById

Возвращает отдельный сценарий, указанный заданным идентификатором. HINT: Вы можете использовать planOfRecord в качестве идентификатора для плана записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Scenario
ScenarioResponse

Получение типа OBS по идентификатору

Идентификатор операции:
GetObsTypeById

Эта конечная точка предназначена только для типов OBS. Чтобы получить единицы OBS, используйте /obsTypes/<obs-type-id>/obsUnits

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Тип Obs
ObsTypeResponse

Получение фактического рабочего времени по идентификатору

Идентификатор операции:
GetActualTimeWorkedById

Возвращает отдельное фактическое время, указанное указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор фактических данных
 actualsId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Фактическое время работало по идентификатору
ActualTimeWorkedByIdResponse

Получение фактического финансового события по идентификатору

Идентификатор операции:
GetActualFinancialEventById

Возвращает отдельное фактическое финансовое событие, указанное указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор финансовых фактических данных
 actualFinancialEventId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Финансовые фактические данные
FinancialActualsResponse

Получение финансовых средств по идентификатору

Идентификатор операции:
GetFinancialsById

Возвращает отдельное финансовое событие, указанное указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор финансовых средств
 financialsId True string

Внутренний идентификатор Meisterplan

Возвращаемое значение

Финансовые показатели
FinancialsResponse

Приоритеты обновления

Идентификатор операции:
UpdatePriorities

Эта конечная точка обновляет приоритеты проектов и программ.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор
 id True string

Значение идентификатора может быть проектом или программой.
Position
 position string

Позиция может быть FIRST или LAST. FIRST — это значение по умолчанию
Идентификатор
 id True string

Значение идентификатора может быть проектом или программой.
Position
 position string

Позиция может быть FIRST или LAST. FIRST — это значение по умолчанию
Идентификатор
 id True string

Значение идентификатора может быть проектом или программой.
Position
 position string

Позиция может быть FIRST или LAST. FIRST — это значение по умолчанию

Создание Teams

Идентификатор операции:
CreateTeam

Создает команду по заданным полям и возвращает только что созданное.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Полезная нагрузка
 payload True dynamic

Команда, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание вех

Идентификатор операции:
CreateMilestone

Возвращает только что созданную веху

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Имя
 name True string
Date
 date True string

формат: ГГГГ-MM-DD
Имя
 name string

Этап проекта должен существовать до создания. Он не будет неявно создан.
Ценность
 value string

Возвращаемое значение

Веха
MilestoneResponse

Создание единицы OBS

Идентификатор операции:
CreateObsUnit

Создает единицу OBS с заданными данными. Возвращает только что созданную единицу OBS.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan
Имя
 name True string
Родительский идентификатор
 parentId string

Возвращаемое значение

Единица obs
ObsUnitResponse

Создание зависимости вехи

Идентификатор операции:
CreateMilestoneDependency

Возвращает идентификатор только что созданной зависимости вехи

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор вехи
 fromMilestoneId True string
Идентификатор вехи
 toMilestoneId True string

Возвращаемое значение

Создание зависимости вехи
MilestoneDependencyCreateResponse

Создание или обновление выделения

Идентификатор операции:
CreateOrUpdateAllocation

Эта конечная точка позволяет создавать новые выделения и обновлять существующие выделения проекта. Изменения будут вноситься только для указанных диапазонов дат, а также указанных ресурсов и ролей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор
 id True string

Идентификатор сущности, к которой связано это выделение. Задайте для RESOLVE_BY_KEY_OR_NAME тип, чтобы автоматически разрешать ключи ресурсов или имена ролей.
Тип
 type string

Управление интерпретацией значения в идентификаторе поля. RESOURCE разрешает ресурсы по UUID. ROLE разрешает роли по UUID. RESOLVE_BY_KEY_OR_NAME разрешает ресурсы по ключу ресурса или ролям по имени роли.
Роль проекта
 projectRole string

Идентификатор роли, к которому связано это выделение. Это поле допустимо только в сочетании с типами RESOURCE или RESOLVE_BY_KEY_OR_NAME. Если для типа задано значение RESOLVE_BY_KEY_OR_NAME, projectRole разрешается по имени.
Start
 start True date
Готово
 finish True date
Fte
 fte double

Запрос принимает FTE, часы или дни.
Дни
 days double

Запрос принимает FTE, часы или дни.
Часы
 hours double

Запрос принимает FTE, часы или дни.

Возвращаемое значение

Распределение
AllocationResponse

Создание или обновление задачи

Идентификатор операции:
CreateOrUpdateTask

Создает или обновляет задачу с заданными полями.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Задача, представленная документом JSON.

Создание или обновление фактического времени работы

Идентификатор операции:
CreateOrUpdateActualTimeWorked

Эта конечная точка позволяет создать новое фактическое время работы и обновить существующее фактическое время работы проекта сущностью (ресурсом или ролью). Мы не обновим фактическое время для дат бронирования, которые не указаны в запросе для данного проекта и сущности. С помощью свойства режима можно контролировать, заменяется ли существующее фактическое значение рабочего времени новым значением или если его значение добавляется в резервирование в запросе. Обратите внимание, что фактические данные о рабочих работах не зависят от сценария. Он будет одинаковым для всех сценариев для любого конкретного проекта. Запрос ограничен 5000 фактическими значениями времени для каждого проекта и ресурса или роли.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор
 id True string

Идентификатор сущности, к которой связана эта фактическая запись рабочего времени. Задайте тип RESOLVE_BY_KEY_OR_NAME для автоматического разрешения ключей ресурсов и команд или имен ролей.
Тип
 type string
Идентификатор команды
 teamId string

Идентификатор группы сущности, к которой связана эта фактическая запись рабочего времени.
Дата резервирования
 bookingDate True date

Дата этого резервирования
Часы
 hours True double

Фактическое время работало в часах
Тип затрат
 costType string

по умолчанию: см. документацию по Meisterplan.
Стоимость в час
 costPerHour double

Стоимость за час для этого резервирования
Mode
 mode string

Возвращаемое значение

Фактическое время работы
ActualTimeWorkedResponse

Создание календарей

Идентификатор операции:
CreateCalendar

Создайте календарь с заданными данными. Возвращает только что созданный календарь.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 name True string
Родительский идентификатор
 parentId string
Monday
 monday True double
Вторник
 tuesday True double
Среда
 wednesday True double
Четверг
 thursday True double
Пятница
 friday True double
Суббота
 saturday True double
Воскресенье
 sunday True double

Возвращаемое значение

Calendar
CalendarResponse

Создание отсутствия

Идентификатор операции:
CreateAbsences

Используйте этот запрос, чтобы добавить отсутствие в течение определенного периода времени. Этот период времени можно определить с помощью атрибутов начала и окончания запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Start
 start True string

формат: ГГГГ-MM-DD
Готово
 finish True string

формат: ГГГГ-MM-DD
Тип дня начала
 startDayType string

Значение по умолчанию — FULL_DAY
Тип дня окончания
 finishDayType string

Значение по умолчанию — FULL_DAY

Возвращаемое значение

Отсутствие
AbsenceResponse

Создание программ

Идентификатор операции:
CreateProgram

Создает программу с заданными полями и возвращает только что созданную программу.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Программа, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание проектов

Идентификатор операции:
CreateProject

Создает проект с заданными полями и возвращает только что созданный проект.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Проект, представленный документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание ресурсов

Идентификатор операции:
CreateResource

Создает ресурс по заданным полям и возвращает только что созданный.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Полезная нагрузка
 payload True dynamic

Ресурс, представленный документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание ролей

Идентификатор операции:
CreateRole

Возвращает созданную роль при успешном выполнении.

Paths

Пути, разделенные разделителями / (например, в календарях и путях единиц OBS) могут определять сегменты путей, которые содержат / путем экранирования с //. Например, путь к Европе/Берлину/Амстердаму будет интерпретирован как ['Европа', 'Берлин/Амстердам']. Неравномерное количество косых черт будет интерпретировано как следующий сегмент, начиная с одной или нескольких косых черт.

Параметры

Имя Ключ Обязательно Тип Описание
Полезная нагрузка
 payload True dynamic

Роль, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Создание типа OBS

Идентификатор операции:
CreateObsType

Создает тип OBS с заданными данными. Возвращает только что созданный тип OBS.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 name True string

Возвращаемое значение

Тип Obs
ObsTypeResponse

Создание фактического финансового события

Идентификатор операции:
CreateFinancialActuals

Возвращает только что созданное фактическое финансовое событие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Тип
 type True string
Сумма
 amount True double
Дата резервирования
 bookingDate True date
Description
 description string
Имя
 name string

Перед созданием должна существовать категория финансовых средств. Он не будет неявно создан.

Возвращаемое значение

Финансовые фактические данные
FinancialActualsResponse

Создание финансовых средств

Идентификатор операции:
CreateFinancials

Возвращает только что созданное финансовое событие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Тип
 type True string
Сумма
 amount True double
Включено
 on True string

Веха действительна только в сочетании со значением в поле milestoneId. Дата действительна только в сочетании со значением в поле dueDate.
Идентификатор вехи
 milestoneId string

Допустимо только в сочетании с: Веха. Веха должна существовать в проекте. Он не будет неявно создан.
Срок
 dueDate string

Допустимо только в сочетании с: Дата (формат: ГГГГ-MM-DD).
Description
 description string
Имя
 name string

Перед созданием должна существовать категория финансовых средств. Он не будет неявно создан.

Возвращаемое значение

Финансовые показатели
FinancialsResponse

Ссылка на создание или обновление ссылки на управление задачами

Идентификатор операции:
CreateOrUpdateTaskManagementLink

Эта конечная точка позволяет добавить ссылку на управление задачами в проект или обновить externalViewUrl

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Полезная нагрузка
 payload True dynamic

Ссылка на управление задачами, представленная документом JSON.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Удаление Teams

Идентификатор операции:
DeleteTeam

Удалите команду, указанную указанным идентификатором. Если команда с заданным идентификатором не существует, запрос завершается ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор команды
 teamId True string

Внутренний идентификатор Meisterplan

Удаление вех

Идентификатор операции:
DeleteMilestone

Удаляет веху в заданном проекте сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор вехи
 milestoneId True string

Внутренний идентификатор Meisterplan

Удаление всех фактических рабочих времени с идентификатором проекта

Идентификатор операции:
DeleteAllActualTimeWorked

Удаляет все фактическое время работы данного проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Удаление выделений

Идентификатор операции:
DeleteAllocation

Удаляет выделение в определенном проекте сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор выделения
 allocationId True string

Внутренний идентификатор Meisterplan

Удаление единицы OBS по идентификатору

Идентификатор операции:
DeleteObsUnit

Удаляет единицу OBS, указанную указанным идентификатором. Если единица OBS с указанным идентификатором не существует, запрос завершится ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan
Идентификатор единицы obs
 obsUnitId True string

Внутренний идентификатор Meisterplan

Удаление зависимостей вехи

Идентификатор операции:
DeleteMilestoneDependency

Удаляет зависимость вехи в заданном сценарии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор зависимости вехи
 milestoneDependencyId True string

Внутренний идентификатор Meisterplan

Удаление задачи

Идентификатор операции:
DeleteTask

Удаляет задачу в заданном проекте.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор задачи
 taskId True string

Внутренний идентификатор Meisterplan

Удаление календарей

Идентификатор операции:
DeleteCalendarById

Удаляет календарь в системе Meisterplan. Обратите внимание, что календарь по умолчанию или родительский элемент календаря по умолчанию нельзя удалить.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор календаря
 calendarId True string

Внутренний идентификатор Meisterplan

Удаление отсутствия

Идентификатор операции:
DeleteAbsence

Удаляет отсутствие.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan
Идентификатор отсутствия
 absenceId True string

Внутренний идентификатор Meisterplan

Удаление программ

Идентификатор операции:
DeleteProgram

Удаляет программу, указанную указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор программы
 programId True string

Внутренний идентификатор Meisterplan

Удаление проектов

Идентификатор операции:
DeleteProject

Удаляет проект в определенном сценарии.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Удаление ресурсов

Идентификатор операции:
DeleteResource

Удалите ресурс, указанный указанным идентификатором. Если ресурс с заданным идентификатором не существует, запрос завершается ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
 resourceId True string

Внутренний идентификатор Meisterplan

Удаление ролей

Идентификатор операции:
DeleteRole

Удалите роль, указанную указанным идентификатором. Если роль с указанным идентификатором не существует, запрос завершится ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор роли
 roleId True string

Внутренний идентификатор Meisterplan

Удаление типа OBS по идентификатору

Идентификатор операции:
DeleteObsType

Удалите тип OBS, указанный указанным идентификатором. Если тип OBS с заданным идентификатором не существует, запрос завершится ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор типа obs
 obsTypeId True string

Внутренний идентификатор Meisterplan

Удаление фактического времени, работаемого по идентификатору

Идентификатор операции:
DeleteActualTimeWorkedById

Удаляет фактическое время работы в определенном проекте сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор фактических данных
 actualsId True string

Внутренний идентификатор Meisterplan

Удаление фактического финансового события

Идентификатор операции:
DeleteFinancialActuals

Удаляет фактическое финансовое событие в определенном проекте сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор финансовых фактических данных
 actualFinancialEventId True string

Внутренний идентификатор Meisterplan

Удаление финансовых средств

Идентификатор операции:
DeleteFinancials

Удаляет финансовое событие в определенном проекте сценария.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan
Идентификатор финансовых средств
 financialsId True string

Внутренний идентификатор Meisterplan

Удалить ссылку для управления задачами

Идентификатор операции:
DeleteTaskManagementLink

Удаляет ссылку на управление задачами проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор сценария
 scenarioId True string

Внутренний идентификатор Meisterplan
Идентификатор проекта
 projectId True string

Внутренний идентификатор Meisterplan

Установка календаря по умолчанию

Идентификатор операции:
SetDefaultCalendar

Задает существующий календарь в качестве календаря по умолчанию в системе Meisterplan.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
 id True string

Триггеры

Создание веб-перехватчика

Создает веб-перехватчик заданными полями и возвращает только что созданный. В настоящее время на систему поддерживается 1000 веб-перехватчиков.

Создание веб-перехватчика

Идентификатор операции:
CreateWebhook

Создает веб-перехватчик заданными полями и возвращает только что созданный. В настоящее время на систему поддерживается 1000 веб-перехватчиков.

Параметры

Имя Ключ Обязательно Тип Описание
Типы событий
 eventTypes True array of string

Необходимо указать по крайней мере один тип события.
Идентификатор сценария
 scenarioId True string

Сценарий, на который вы хотите подписаться.
Код проекта
 projectId string

Идентификатор projectId является необязательным. Это необходимо только в том случае, если вы хотите подписаться на определенный проект.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Определения

UserRefResponse

Имя Путь Тип Описание
Идентификатор пользователя
 id string
Отображаемое имя пользователя
 displayName string

ListResponseRoleCapacityResponse

Имя Путь Тип Описание
Товары
 items array of RoleCapacityResponse

RoleCapacityResponse

Имя Путь Тип Описание
start
 start date

Дата начала этого сегмента емкости роли. Необязательно.
заканчивать
 finish date

Дата окончания этого сегмента емкости роли. Необязательно.
fte
 fte double

Емкость роли в FTE

ВехаResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string
Date
 date string

формат: ГГГГ-MM-DD
Этап проекта
 projectPhase ProjectPhaseResponse
Состояние
 status StatusResponse

ProjectPhaseResponse

Имя Путь Тип Описание
Имя
 name string

StatusResponse

Имя Путь Тип Описание
Ценность
 value string
Отображаемое имя
 displayName string

FinanceCategoryResponse

Имя Путь Тип Описание
Имя
 name string

FinancialsResponse

Имя Путь Тип Описание
Идентификатор
 id string
Тип
 type string
Сумма
 amount double
Время финансовых средств
 timing FinancialsTimingResponse
Description
 description string
Категория финансов
 category FinanceCategoryResponse

FinancialsTimingResponse

Имя Путь Тип Описание
Включено
 on string
Идентификатор вехи
 milestoneId string

Только в том случае, если тип времени равен вехе
Срок
 dueDate date

FinancialActualsResponse

Имя Путь Тип Описание
Идентификатор
 id string
Тип
 type string
Сумма
 amount double
Дата резервирования
 bookingDate string

формат: ГГГГ-MM-DD
Description
 description string
Категория финансов
 category FinanceCategoryResponse

AllocatedEntityResponse

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор сущности, к которой связано это выделение
Тип
 type string

Тип сущности для этого выделения
Роль проекта
 projectRole string

Будет задано только в том случае, если тип равен RESOURCE

AllocationResponse

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор выделения
Выделенная сущность
 allocatedEntity AllocatedEntityResponse
Сегменты
 segments array of AllocationSegmentResponse

Сегменты времени выделения

AllocationSegmentResponse

Сегменты времени выделения

Имя Путь Тип Описание
Start
 start date

Дата начала выделения
Готово
 finish date

Дата окончания этого выделения
Часы
 hours double

Значение выделения в часах

ActualTimeWorkedResponse

Имя Путь Тип Описание
Ссылка на фактические сущности
 bookedEntity ActualsEntityLinkResponse
Резервирования
 bookings array of ActualsBookingResponse

Дата и часы резервирования этой фактической записи о времени работы

ActualsBookingResponse

Дата и часы резервирования этой фактической записи о времени работы

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор резервирования этой фактической записи о времени работы
Дата резервирования
 bookingDate date

Дата резервирования этой фактической записи о времени работы
Часы
 hours double

Фактическое время работало в часах
Тип затрат
 costType string
Стоимость в час
 costPerHour double

ActualsEntityLinkResponse

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор сущности, к которой связана эта фактическая запись рабочего времени
Тип
 type string

Тип сущности для этой фактической записи времени работы
Идентификатор команды
 teamId string

Идентификатор группы сущности, к которой связана эта фактическая запись рабочего времени.

MilestoneDependencyCreateResponse

Имя Путь Тип Описание
Идентификатор
 id string

CalendarDeviationResponse

Имя Путь Тип Описание
Start
 start date
Готово
 finish date
Относительная емкость
 relativeCapacity double

ListResponseCalendarDeviationResponse

Имя Путь Тип Описание
Товары
 items array of CalendarDeviationResponse

ОтсутствиеResponse

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор отсутствия
Дата начала
 start date

Дата начала этого отсутствия
Дата окончания
 finish date

Дата окончания этого отсутствия
Тип дня начала отсутствия
 startDayType string
Тип дня завершения отсутствия
 finishDayType string

ObsTypeResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string

ObsUnitResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string
Путь
 path string
Отображаемое имя
 displayName string

Отображаемое имя отображается так же, как в пользовательском интерфейсе приложения Meisterplan
Родительский идентификатор
 parentId string

CalendarResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string
Родительский идентификатор
 parentId string
Путь
 path string
Часы работы
 workingHours WorkingHoursResponse

WorkingHoursResponse

Имя Путь Тип Описание
Monday
 monday double
Вторник
 tuesday double
Среда
 wednesday double
Четверг
 thursday double
Пятница
 friday double
Суббота
 saturday double
Воскресенье
 sunday double

Cursor

Имя Путь Тип Описание
Cursor
 cursor string

Постраничная разбивка

Имя Путь Тип Описание
Cursor
 after Cursor

BasicUserGroupResponse

Имя Путь Тип Описание
Идентификатор группы
 id string

Идентификатор группы пользователей.
Имя группы
 name string

Имя группы пользователей.

LinkedResourceResponse

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор связанного ресурса.
Ключ ресурса
 resourceKey string

Ключ ресурса связанного ресурса.

PaginatedResponseUserResponse

Имя Путь Тип Описание
Товары
 items array of UserResponse
Постраничная разбивка
 _pagination Pagination

UserResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя пользователя
 userName string
Внешний идентификатор
 externalId string
Active
 active boolean
адрес электронной почты
 emailAddress string
Фамилия
 lastName string
Имя (Первое имя)
 firstName string
Отображаемое имя
 displayName string
Региональные настройки
 locale string
groups
 groups array of BasicUserGroupResponse
Последнее имя входа
 lastLogin date-time
Проверено по электронной почте
 emailVerified boolean
Связанный ресурс
 linkedResource LinkedResourceResponse
Срок действия пароля никогда не истекает
 passwordNeverExpires boolean

SprintResponse

Имя Путь Тип Описание
Идентификатор
 id string
Ключ Спринта
 key string
Имя
 name string
Start
 start date-time
Конец
 end date-time

ListResponseScenarioResponse

Имя Путь Тип Описание
Товары
 items array of ScenarioResponse

ScenarioResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string

ListResponseRoleWithRoleCapacityResponse

Имя Путь Тип Описание
Товары
 items array of RoleWithRoleCapacityResponse

RoleWithRoleCapacityResponse

Имя Путь Тип Описание
roleId
 roleId string

Идентификатор роли.
segments
 segments array of RoleCapacityResponse

Сегменты емкости роли.

ListResponseMilestoneResponse

Имя Путь Тип Описание
Товары
 items array of MilestoneResponse

ListResponseFinancialsResponse

Имя Путь Тип Описание
Товары
 items array of FinancialsResponse

ListResponseFinancialActualsResponse

Имя Путь Тип Описание
Товары
 items array of FinancialActualsResponse

PaginatedResponseProjectCommentResponse

Имя Путь Тип Описание
Товары
 items array of ProjectCommentResponse
Постраничная разбивка
 _pagination Pagination

ProjectCommentResponse

Имя Путь Тип Описание
Идентификатор
 id string
Content
 content string
Ref пользователя
 author UserRefResponse
Дата создания
 createdDate string
mentions
 mentions array of UserRefResponse

ListResponseAllocationResponse

Имя Путь Тип Описание
Товары
 items array of AllocationResponse

AllocationCommentEntityResponse

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор сущности, к которой связан этот комментарий выделения
Тип
 type string

Тип сущности, к которой связан этот комментарий выделения

AllocationCommentResponse

Имя Путь Тип Описание
Идентификатор
 id string
Content
 content string
Ref пользователя
 author UserRefResponse
Дата создания
 createdDate string
mentions
 mentions array of UserRefResponse
Выделенная сущность
 allocatedEntity AllocationCommentEntityResponse

PaginatedResponseAllocationCommentResponse

Имя Путь Тип Описание
Товары
 items array of AllocationCommentResponse
Постраничная разбивка
 _pagination Pagination

PaginatedResponseActualTimeWorkedResponse

Имя Путь Тип Описание
Товары
 items array of ActualTimeWorkedResponse
Постраничная разбивка
 _pagination Pagination

ActualTimeWorkedByIdResponse

Имя Путь Тип Описание
Ссылка на фактические сущности
 bookedEntity ActualsEntityLinkResponse
Идентификатор
 id string

Идентификатор резервирования этой фактической записи о времени работы
Дата резервирования
 bookingDate date

Дата резервирования этой фактической записи о времени работы
Часы
 hours double

Фактическое время работало в часах
Тип затрат
 costType string
Стоимость в час
 costPerHour double

PaginatedResponseProgramGetAllResponse

Имя Путь Тип Описание
Товары
 items array of ProgramGetAllResponse
Постраничная разбивка
 _pagination Pagination

ProgramGetAllResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string
Ключ программы
 programKey string

Должен быть уникальным. Если пусто, будет создано значение.

MilestoneDependencyResponse

Имя Путь Тип Описание
Идентификатор
 id string
Справочник по вехе
 from MilestoneReferenceResponse
Справочник по вехе
 to MilestoneReferenceResponse

MilestoneReferenceResponse

Имя Путь Тип Описание
Код проекта
 projectId string
Идентификатор вехи
 milestoneId string

PaginatedResponseMilestoneDependencyResponse

Имя Путь Тип Описание
Товары
 items array of MilestoneDependencyResponse
Постраничная разбивка
 _pagination Pagination

ListResponseAbsenceResponse

Имя Путь Тип Описание
Товары
 items array of AbsenceResponse

ListResponsePortfolioResponse

Имя Путь Тип Описание
Товары
 items array of PortfolioResponse

PortfolioResponse

Имя Путь Тип Описание
Идентификатор
 id string
Имя
 name string

ListResponseObsTypeResponse

Имя Путь Тип Описание
Товары
 items array of ObsTypeResponse

ListResponseObsUnitResponse

Имя Путь Тип Описание
Товары
 items array of ObsUnitResponse

ListResponseCalendarResponse

Имя Путь Тип Описание
Товары
 items array of CalendarResponse

CalendarExceptionResponse

Имя Путь Тип Описание
Date
 date date
Часы работы
 workingHours double
Description
 description string
Исходный идентификатор календаря
 sourceCalendarId string

ListResponseCalendarExceptionResponse

Имя Путь Тип Описание
Товары
 items array of CalendarExceptionResponse

BusinessGoalDefinitionResponse

Имя Путь Тип Описание
Имя
 name string
subGoals
 subGoals array of SubGoalDefinitionResponse

ListResponseBusinessGoalDefinitionResponse

Имя Путь Тип Описание
Товары
 items array of BusinessGoalDefinitionResponse

SubGoalDefinitionResponse

Имя Путь Тип Описание
Имя
 name string
Отображаемое имя
 displayName string