次の方法で共有

Meisterplan

Meisterplan は、ポートフォリオ レベルのリソース管理ツールであり、ポートフォリオとリソース マネージャーが、従来の作業、アジャイル、ハイブリッドのいずれであっても、チームやイニシアチブ全体のユーザーを管理するのに役立ちます。 これを使用して、自信を持ってポートフォリオを決定し、対話形式でリソースの競合を解決します。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate（パワーオートメート） Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Meisterplan のサポート
URL https://help.meisterplan.com/
Email support@meisterplan.com
コネクタ メタデータ
Publisher itdesign GmbH
Website https://meisterplan.com
プライバシー ポリシー https://meisterplan.com/privacy-and-data-protection/
カテゴリ ビジネス管理;ビジネス インテリジェンス

Meisterplan は、ポートフォリオ レベルのリソース管理ツールであり、ポートフォリオとリソース マネージャーが、従来の作業、アジャイル、ハイブリッドのいずれであっても、チームやイニシアチブ全体のユーザーを管理するのに役立ちます。 これを使用して、自信を持ってポートフォリオを決定し、対話形式でリソースの競合を解決します。 Meisterplan を使用して、リソースの可用性と容量を確認し、プロジェクトの可視性を獲得し、プロジェクト ポートフォリオの優先順位を付け、戦略に合わせて調整し、リアルタイムのシナリオ シミュレーションを生成します。 Meisterplan コネクタを使用すると、チームが使用するすべてのツールと Meisterplan を統合できるため、プロジェクト データに対して二重メンテナンスを行う必要はありません。 プロジェクトを更新する必要がある場合でも、承認された休暇要求を入力する必要がある場合でも、Meisterplan と Meisterplan Connector を使用すると、プロセスをシームレスに行うことができます。

[前提条件]

Meisterplan コネクタを使用するには、 Meisterplan アカウントが必要です。 Meisterplan の使用を開始するには、 デモをリクエスト するか 試用します。

資格情報を取得する方法

Meisterplan コネクタを使用すると、ログイン ダイアログが表示され、Meisterplan システムが配置されているリージョン (米国または EU) を選択する必要があります。 次に、Meisterplan の資格情報 (ユーザー名とパスワード) を入力し、[ ログイン] をクリックします。 次に、[ 承認 ] をクリックして、コネクタが Meisterplan システムにアクセスできるようにします。

コネクタの概要

一般的なユース ケースは次のとおりです。

  • プロジェクト情報の更新: 状態の更新など、プロジェクト管理ツール (Trello など) でプロジェクトに変更を加えた場合、Meisterplan の対応するプロジェクトが自動的に更新されます。
  • 割り当ての同期: MS Excel などのオンライン スプレッドシートで割り当てを編集すると、Meisterplan の対応する割り当てが自動的に更新されます。
  • リソース休暇を最新の状態に保つ: Excel などのオンライン スプレッドシートで従業員の 1 人からの休暇要求を承認すると、Meisterplan の対応するリソース エントリが自動的に更新されます。
  • Meisterplan への新しいプロジェクトの追加: いずれかのツールで新しいプロジェクトを追加すると、新しいプロジェクトが Meisterplan に自動的に作成されます。
  • マイスタープランへの新しいリソースの追加: オンライン スプレッドシートを新しい従業員で更新すると、自動的にマイスタープランのリソース プールに追加されます。
  • 従業員データの定期的な更新: オンライン スプレッドシートでリソースのアドレスを変更すると、Meisterplan の対応するリソース エントリが自動的に更新されます。
  • Microsoft Teamsに接続する: Meisterplan でプロジェクトが更新されると、構成済みの Teams チャネルで通知を受け取ります。 この通知は、プロジェクトへのリンクを Meisterplan に含むように構成できるため、プロジェクトをすばやく開いて詳細を確認できます。
  • MS Office に接続する: Meisterplan に新しいプロジェクトが追加されると、指定した同僚に電子メールで通知が送信されます。 MS Office の外部バックアップ ソースに新しいプロジェクトを追加するように Flow を構成することもできます。

既知の問題と制限事項

一般的なエラーと解決方法

Meisterplan コネクタは、Meisterplan REST API を使用します。 状態コードを含む説明については、REST API のドキュメントを参照してください。 詳細については、 ヘルプ センターを参照してください。

FAQ

  • コネクタを使用するには、どの Meisterplan ユーザー権限が必要ですか?

    • Meisterplan ユーザーは、 Access Meisterplan API と Connect External Applications 権限を持っている 必要があります。
    • Meisterplan ユーザーは、コネクタを使用して読み取りまたは更新するフィールドの読み取りと編集の権限を持っている必要があります。

  • Meisterplan Basic エディションでコネクタを使用できますか?

    • はい。コネクタはすべての Meisterplan エディションでサポートされています。 一部のアクションは、Meisterplan Pro-Edition または Premium-Edition でのみ使用できます。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
リージョン 文字列 ホストされているマイスタープラン システムのリージョン 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

ID で OBS ユニットを削除する

指定された ID で指定された OBS ユニットを削除します。 指定された ID を持つ OBS ユニットが存在しない場合、要求は失敗します。
ID で OBS 型を削除する

指定された ID で指定された OBS 型を削除します。 指定された ID の OBS 型が存在しない場合、要求は失敗します。
ID で OBS 型を取得する

このエンドポイントは OBS 型専用です。 OBS ユニットを取得するには、/obsTypes/<obs-type-id>/obsUnits を使用します。
ID でシナリオを取得する

指定された ID で指定された個々のシナリオを返します。 ヒント: "planOfRecord" をレコード計画シナリオの ID として使用できます。
ID でスプリントを取得する

指定された ID で指定された個々のスプリントを返します。
ID でタスクを取得する

指定された ID で指定された個々のタスクを返します。
ID でチームを取得する

指定された ID で指定された個々のチームを返します。
ID でプログラムを取得する

指定された ID で指定された個々のプログラムを返します。
ID でプロジェクト コメントを取得する

プロジェクト コメントを返します。
ID でプロジェクトを取得する

指定された ID で指定された個々のプロジェクトを返します。
ID でマイルストーンを取得する

指定された ID で指定された個々のマイルストーンを返します。
ID でユーザーを取得する

ユーザーを返します。
ID でリソースを取得する

指定された ID で指定された個々のリソースを返します。
ID でロールを取得する

指定された ID で指定された個々のロールを返します。
ID で予定表を取得する

マイスタープラン システムで予定表を 1 つ取得します。 特別な ID defaultCalendar を使用して、既定の予定表を取得します。
ID で休暇を取得する

指定された ID で指定された個々の不在を返します。
ID で作業時間を削除する

シナリオの特定のプロジェクトで実際に作業した時間を削除します。
ID で割り当てを取得する

指定された ID で指定された個々の割り当てを返します。
ID で割り当てコメントを取得する

割り当てコメントを返します。
ID で実績作業時間を取得する

指定された ID で指定された個々の実績作業時間を返します。
ID で実際の財務イベントを取得する

指定された ID で指定された個々の実際の財務イベントを返します。
ID で財務情報を取得する

指定された ID で指定された個々の財務イベントを返します。
OBS ユニットの作成

指定されたデータを含む OBS ユニットを作成します。 新しく作成された OBS ユニットを返します。
OBS ユニットを取得する

このエンドポイントは、1 つの OBS ユニットを返します。
OBS ユニットを更新する

1 つの OBS ユニットの名前を更新するか、別の親に移動します。
OBS 型の作成

指定されたデータを使用して OBS 型を作成します。 新しく作成された OBS 型を返します。
OBS 型の更新

指定された ID で指定された OBS 型に対して更新を実行します。
Teams の一覧を取得する

このエンドポイントはページ分割されています。 指定した PAGESIZE までのチームの一覧を返します
Teams の更新

指定された ID で指定されたチームに対して更新を実行します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
Teams を作成する

指定されたフィールドによってチームを作成し、新しく作成されたフィールドを返します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
Teams を削除する

指定された ID で指定されたチームを削除します。 指定された ID を持つチームが存在しない場合、要求は失敗します。
すべての OBS ユニットを取得する

このエンドポイントは、指定された OBS 型のすべての OBS ユニットの一覧を返します。
すべての OBS 型を取得する

このエンドポイントは OBS 型専用です。 OBS ユニットを取得するには、/obsTypes/<obs-type-id>/obsUnits を使用します。
すべてのロールの容量セグメントを取得する

すべてのロールの容量セグメントを返します。 特定のロールの容量セグメントが存在しない場合、そのロールの容量は空になります。
カレンダーからの逸脱を更新する

この要求を使用して、リソースのすべてのカレンダー偏差を一定期間置き換えます。 この期間は、要求のルート開始属性と終了属性を使用して定義できます。 偏差プロパティを使用して、カレンダーの偏差の新しいリストを指定します。 指定した期間内のすべての偏差は、偏差プロパティに記載されている偏差によって上書きされることに注意してください。

  • 開始期間と終了期間に null を使用すると、リソースのすべてのカレンダーの偏差が上書きされます。期間の開始日のみが定義されている場合、この時刻から始まるすべての偏差が上書きされます。期間の終了日のみが定義されている場合、その時点までのすべての偏差が上書きされます。カレンダーの偏差の開始日または終了日に null を使用する場合は、 偏差は、上記で指定したルートの開始日または終了日から、または終了するまで続くものと見なされます。

すべての偏差はシーケンシャル構造にフラット化されます。 重複する偏差のケースは、配列の後半で発生する偏差に優先順位を付けることで解決されます。
カレンダーから偏差を取得する

リソースのカレンダーの稼働時間への偏差を読み取ります。 開始値と終了値が渡されない場合は、要求されたリソースのすべての偏差が返されます。 start のみが渡された場合、この時刻から始まるすべての偏差が返されます。 完了のみが渡された場合は、その時点までのすべての偏差が返されます。
シナリオの一覧を取得する

シナリオの一覧を返します
タスクの一覧を取得する

このエンドポイントはページ分割されています。 指定した PAGESIZE までのタスクの一覧を返します。
タスクの作成または更新

指定されたフィールドを使用してタスクを作成または更新します。
タスクの削除

特定のプロジェクト内のタスクを削除します。
タスクの置換

このエンドポイントは、特定のプロジェクトのすべての既存のタスクを、要求で提供される新しいタスクの一覧に置き換えるために使用されます。 しくみ: 特定のプロジェクトのタスクの一覧を送信します。 システムは、タスク キーを識別子として使用して、プロジェクトのタスクをこのリストと同期します。 これは、以下のようなことを意味します。

  • 現在システム内にあるタスクは削除されますが、一覧に含まれていないタスクは削除されます。 - システムに存在しないリスト内のタスクが作成されます。 - システムと一覧の両方に存在するタスクは、変更がある場合に更新されます。
タスク管理リンクの作成または更新

このエンドポイントを使用すると、タスク管理リンクをプロジェクトに追加したり、externalViewUrl を更新したりできます。
タスク管理リンクの削除

プロジェクトのタスク管理リンクを削除します
タスク管理リンクを取得する

プロジェクトのタスク管理リンクを返します。
ビジネス目標

すべてのビジネス目標を返します
プログラムの一覧を取得する

特定のシナリオのプログラムの一覧を返します。
プログラムの作成

指定されたフィールドを使用してプログラムを作成し、新しく作成されたプログラムを返します。
プログラムの削除

指定された ID で指定されたプログラムを削除します。
プログラムの更新

指定された ID で指定されたプログラムに対して更新を実行します。
プロジェクト ID によって処理されたすべての実績時間を削除する

特定のプロジェクトの実績作業時間をすべて削除します。
プロジェクト コメントの一覧を取得する

プロジェクト コメントの一覧を返します。
プロジェクトの一覧を取得する

このエンドポイントはページ分割されています。 指定した PAGESIZE までのプロジェクトの一覧を返します
プロジェクトの作成

指定されたフィールドを含むプロジェクトを作成し、新しく作成されたプロジェクトを返します。
プロジェクトの削除

特定のシナリオのプロジェクトを削除します。
プロジェクトの更新

指定された ID で指定されたプロジェクトに対して更新を実行します。
ポートフォリオの一覧を取得する

使用可能なすべてのポートフォリオの一覧を返します。 ポートフォリオを表示する権限がない場合は、API トークンを使用してアクセスする権限を持つ利用可能なすべてのポートフォリオの一覧を返します。 ポートフォリオを表示する権限がない場合は、空のリストが返されます。
マイルストーンの一覧を取得する

プロジェクトのマイルストーンの一覧を返します。
マイルストーンの作成

新しく作成されたマイルストーンを返します。
マイルストーンの依存関係の一覧を取得する

シナリオのマイルストーンの依存関係の一覧を返します
マイルストーンの依存関係を作成する

新しく作成されたマイルストーン依存関係の ID を返します。
マイルストーンの依存関係を削除する

特定のシナリオでマイルストーンの依存関係を削除します。
マイルストーンの削除

シナリオの特定のプロジェクトのマイルストーンを削除します。
マイルストーンの更新

指定された ID で指定されたマイルストーンに対して更新を実行します。
マイルストーンを置き換える

シナリオ内の特定のプロジェクトのマイルストーンを置き換えます。
ユーザーの一覧を取得する

ユーザーの一覧を返します。 userName または externalId によるフィルター処理を許可します。
リソースの一覧を取得する

このエンドポイントはページ分割されています。 指定した PAGESIZE までのリソースの一覧を返します
リソースの作成

指定されたフィールドによってリソースを作成し、新しく作成されたフィールドを返します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
リソースの削除

指定した ID で指定されたリソースを削除します。 指定した ID のリソースが存在しない場合、要求は失敗します。
リソースの更新

指定された ID で指定されたリソースに対して更新を実行します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
ロールの一覧を取得する

使用可能なすべてのロールの一覧を返します。 使用可能なロールがない場合は、空のリストが返されます。
ロールの作成

成功した場合に作成されたロールを返します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
ロールの削除

指定した ID で指定されたロールを削除します。 指定された ID のロールが存在しない場合、要求は失敗します。
ロールの容量セグメントを取得する

指定された ID で指定されたロールの容量セグメントを返します。 容量セグメントが存在しない場合は、空のリストを返します。
ロールの容量セグメントを更新する

指定された ID で指定されたロールの容量セグメントを更新します。 すべての容量セグメントを消去するには、開始または終了なしでセグメントを送信し、容量を 0 に設定します
ロールの更新

指定された ID で指定されたロールに対して更新を実行します。 部分的な更新を行うには、更新されたフィールドのみを送信する必要があります。 フィールド値を削除するには、明示的な null 値を使用してフィールドを送信する必要があります。 既定値を持つフィールドは、null に設定すると既定値にリセットされます。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
予定表の一覧を取得する

マイスタープラン システム内のすべての予定表の一覧を取得します。
予定表の例外の一覧を取得する

マイスタープラン システムで、このカレンダーに対するすべての例外の一覧を取得します。
予定表の例外を更新する

この要求を使用して、一定期間のすべての予定表の例外を置き換えます。 この期間は、要求のルート開始属性と終了属性を使用して定義できます。 exceptions プロパティを使用して、予定表の例外の新しい一覧を指定します。 指定した期間内のすべての例外は、exceptions プロパティに記載されている例外によって上書きされることに注意してください。

  • 開始期間と終了期間に null を使用すると、カレンダーのすべての例外が上書きされます。期間の開始日のみが定義されている場合は、この時刻から始まるすべての例外が上書きされます。期間の終了日のみが定義されている場合、その時点までのすべての例外が上書きされます。例外が削除され、親カレンダーにその日付に例外がある場合、 このカレンダーは、親カレンダーから例外を継承します。
予定表を作成する

指定されたデータを含む予定表を作成します。 新しく作成された予定表を返します。
予定表を削除する

マイスタープラン システムの予定表を削除します。 既定の予定表または既定の予定表の親は削除できないことに注意してください。
予定表を更新する

指定された ID で指定された予定表に対して更新を実行します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。
休暇の一覧を取得する

リソースの不在の一覧を返します。
休暇の作成

この要求を使用して、特定の期間の休暇を追加します。 この期間は、要求の開始属性と終了属性を使用して定義できます。
休暇の削除

休暇を削除します。
休暇の更新

休暇を更新するには、この要求を使用します。
休暇の置換

このエンドポイントを使用すると、リソースが存在しないすべての状態を置き換えることができます。 結果は、既存のすべての休暇が削除され、合格した休暇が再度作成される場合と同じになります。 'start' クエリ パラメーターと 'end' クエリ パラメーターを使用して、既存の休暇を置き換える時間範囲を指定できます。 これらのパラメーターを使用しない場合、すべての休暇は新しく送信された休暇に置き換えられます。
割り当ての一覧を取得する

プロジェクトの割り当ての一覧を返します。
割り当ての作成または更新

このエンドポイントを使用すると、新しい割り当てを作成し、プロジェクトの既存の割り当てを更新できます。 変更は、指定した日付範囲だけでなく、指定されたリソースとロールに対してのみ行われます。
割り当ての削除

シナリオの特定のプロジェクトの割り当てを削除します。
割り当ての更新

このエンドポイントを使用すると、プロジェクトの既存の割り当てを更新できます。 変更は、指定した日付範囲だけでなく、指定されたリソースとロールに対してのみ行われます。
割り当ての置換

このエンドポイントを使用すると、プロジェクトのすべての割り当てを置き換えることができます。 結果は、既存のすべての割り当てが削除され、渡された割り当てが再度作成される場合と同じになります。
割り当てコメントの一覧を取得する

割り当てコメントの一覧を返します。
実績作業時間の一覧を取得する

特定のシナリオのすべてのプロジェクトで実績作業時間の一覧を返します。 実際の作業時間データ自体は、そのシナリオとは無関係であることに注意してください。
実績作業時間の作成または更新

このエンドポイントを使用すると、新しい実績作業時間を作成し、エンティティ (リソースまたはロール) によってプロジェクトの既存の実績作業時間を更新できます。 特定のプロジェクトとエンティティの要求で指定されていない予約日の実績作業時間は更新されません。 mode プロパティを使用すると、既存の実績作業時間の値が新しい値に置き換えられるか、その値が要求の予約に追加されるかを制御できます。 実際の作業時間データ自体は、そのシナリオとは無関係であることに注意してください。 これは、特定のプロジェクトのすべてのシナリオで同じになります。 要求は、プロジェクトとリソース/ロールごとに 5,000 の実績作業時間の値に制限されます。
実績財務イベントの作成

新しく作成された実際の財務イベントを返します。
実際の財務イベントの一覧を取得する

プロジェクトの実際の財務イベントの一覧を返します。
実際の財務イベントの更新

更新された実際の財務イベントを返します。
実際の財務イベントを削除する

シナリオの特定のプロジェクトの実際の財務イベントを削除します。
実際の財務イベントを置き換える

シナリオ内の特定のプロジェクトの実際の財務イベントを置き換えます。 要求は、プロジェクトごとに 5,000 件の実際の財務イベントに制限されます。
既定の予定表を設定する

既存の予定表をマイスタープラン システムの既定の予定表として設定します。
更新の優先順位

このエンドポイントは、プロジェクトとプログラムの優先順位を更新します。
財務の一覧を取得する

プロジェクトの財務の一覧を返します
財務を作成する

新しく作成された財務イベントを返します。
財務を削除する

シナリオの特定のプロジェクトの財務イベントを削除します。
財務を置き換える

シナリオ内の特定のプロジェクトの財務イベントを置き換えます。
財務情報の更新

シナリオの特定のプロジェクトの ID によって財務イベントを更新します。

ID で OBS ユニットを削除する

操作 ID:
DeleteObsUnit

指定された ID で指定された OBS ユニットを削除します。 指定された ID を持つ OBS ユニットが存在しない場合、要求は失敗します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子
Obs ユニット ID
 obsUnitId True string

内部マイスタープラン識別子

ID で OBS 型を削除する

操作 ID:
DeleteObsType

指定された ID で指定された OBS 型を削除します。 指定された ID の OBS 型が存在しない場合、要求は失敗します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子

ID で OBS 型を取得する

操作 ID:
GetObsTypeById

このエンドポイントは OBS 型専用です。 OBS ユニットを取得するには、/obsTypes/<obs-type-id>/obsUnits を使用します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子

戻り値

Obs 型
ObsTypeResponse

ID でシナリオを取得する

操作 ID:
GetScenarioById

指定された ID で指定された個々のシナリオを返します。 ヒント: "planOfRecord" をレコード計画シナリオの ID として使用できます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子

戻り値

Scenario
ScenarioResponse

ID でスプリントを取得する

操作 ID:
GetSprintById

指定された ID で指定された個々のスプリントを返します。

パラメーター

名前 キー 必須 型 説明
スプリント ID
 sprintId True string

内部マイスタープラン識別子

戻り値

Body
SprintResponse

ID でタスクを取得する

操作 ID:
GetTaskById

指定された ID で指定された個々のタスクを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タスク ID
 taskId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ID でチームを取得する

操作 ID:
GetTeamById

指定された ID で指定された個々のチームを返します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ID でプログラムを取得する

操作 ID:
GetProgramById

指定された ID で指定された個々のプログラムを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プログラム ID
 programId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ID でプロジェクト コメントを取得する

操作 ID:
GetProjectComment

プロジェクト コメントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
コメント ID
 commentId True string

内部マイスタープラン識別子

戻り値

プロジェクト コメント
ProjectCommentResponse

ID でプロジェクトを取得する

操作 ID:
GetProjectById

指定された ID で指定された個々のプロジェクトを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ID でマイルストーンを取得する

操作 ID:
GetMilestoneById

指定された ID で指定された個々のマイルストーンを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
マイルストーン ID
 milestoneId True string

内部マイスタープラン識別子

戻り値

マイルストーン
MilestoneResponse

ID でユーザーを取得する

操作 ID:
GetUser_1

ユーザーを返します。

パラメーター

名前 キー 必須 型 説明
ユーザー ID
 userId True string

内部マイスタープラン識別子

戻り値

User
UserResponse

ID でリソースを取得する

操作 ID:
GetResourceById

指定された ID で指定された個々のリソースを返します。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ID でロールを取得する

操作 ID:
GetRoleById

指定された ID で指定された個々のロールを返します。

パラメーター

名前 キー 必須 型 説明
ロール ID
 roleId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ID で予定表を取得する

操作 ID:
GetCalendarById

マイスタープラン システムで予定表を 1 つ取得します。 特別な ID defaultCalendar を使用して、既定の予定表を取得します。

パラメーター

名前 キー 必須 型 説明
予定表 ID
 calendarId True string

内部マイスタープラン識別子

戻り値

カレンダー
CalendarResponse

ID で休暇を取得する

操作 ID:
GetAbsenceById

指定された ID で指定された個々の不在を返します。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
休暇 ID
 absenceId True string

内部マイスタープラン識別子

戻り値

不在
AbsenceResponse

ID で作業時間を削除する

操作 ID:
DeleteActualTimeWorkedById

シナリオの特定のプロジェクトで実際に作業した時間を削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
Actuals Id
 actualsId True string

内部マイスタープラン識別子

ID で割り当てを取得する

操作 ID:
GetAllocationId

指定された ID で指定された個々の割り当てを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
割り当て ID
 allocationId True string

内部マイスタープラン識別子

戻り値

割り当て
AllocationResponse

ID で割り当てコメントを取得する

操作 ID:
GetAllocationComment

割り当てコメントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
割り当てコメント ID
 allocationCommentId True string

内部マイスタープラン識別子

戻り値

割り当てコメント
AllocationCommentResponse

ID で実績作業時間を取得する

操作 ID:
GetActualTimeWorkedById

指定された ID で指定された個々の実績作業時間を返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
Actuals Id
 actualsId True string

内部マイスタープラン識別子

戻り値

ID による実際の作業時間
ActualTimeWorkedByIdResponse

ID で実際の財務イベントを取得する

操作 ID:
GetActualFinancialEventById

指定された ID で指定された個々の実際の財務イベントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
財務実績 ID
 actualFinancialEventId True string

内部マイスタープラン識別子

戻り値

財務実績
FinancialActualsResponse

ID で財務情報を取得する

操作 ID:
GetFinancialsById

指定された ID で指定された個々の財務イベントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
財務 ID
 financialsId True string

内部マイスタープラン識別子

戻り値

財務
FinancialsResponse

OBS ユニットの作成

操作 ID:
CreateObsUnit

指定されたデータを含む OBS ユニットを作成します。 新しく作成された OBS ユニットを返します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子
名前
 name True string
親 ID
 parentId string

戻り値

Obs ユニット
ObsUnitResponse

OBS ユニットを取得する

操作 ID:
GetObsUnit

このエンドポイントは、1 つの OBS ユニットを返します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子
Obs ユニット ID
 obsUnitId True string

内部マイスタープラン識別子

戻り値

Obs ユニット
ObsUnitResponse

OBS ユニットを更新する

操作 ID:
UpdateObsUnit

1 つの OBS ユニットの名前を更新するか、別の親に移動します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子
Obs ユニット ID
 obsUnitId True string

内部マイスタープラン識別子
名前
 name string
親 ID
 parentId string

戻り値

Obs ユニット
ObsUnitResponse

OBS 型の作成

操作 ID:
CreateObsType

指定されたデータを使用して OBS 型を作成します。 新しく作成された OBS 型を返します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

戻り値

Obs 型
ObsTypeResponse

OBS 型の更新

操作 ID:
UpdateObsType

指定された ID で指定された OBS 型に対して更新を実行します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子
名前
 name True string

戻り値

Obs 型
ObsTypeResponse

Teams の一覧を取得する

操作 ID:
GetAllTeams

このエンドポイントはページ分割されています。 指定した PAGESIZE までのチームの一覧を返します

パラメーター

名前 キー 必須 型 説明
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。 指定したプロパティと完全に一致するすべてのオブジェクトを選択します。 注: パラメーターの URL エンコードには注意してください。 { "resourceKey": string, "name": string }

戻り値

この操作の出力は状況に応じて変わります。

Teams の更新

操作 ID:
UpdateTeam

指定された ID で指定されたチームに対して更新を実行します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるチーム。

戻り値

この操作の出力は状況に応じて変わります。

Teams を作成する

操作 ID:
CreateTeam

指定されたフィールドによってチームを作成し、新しく作成されたフィールドを返します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるチーム。

戻り値

この操作の出力は状況に応じて変わります。

Teams を削除する

操作 ID:
DeleteTeam

指定された ID で指定されたチームを削除します。 指定された ID を持つチームが存在しない場合、要求は失敗します。

パラメーター

名前 キー 必須 型 説明
チーム ID
 teamId True string

内部マイスタープラン識別子

すべての OBS ユニットを取得する

操作 ID:
GetAllObsUnits

このエンドポイントは、指定された OBS 型のすべての OBS ユニットの一覧を返します。

パラメーター

名前 キー 必須 型 説明
Obs 型 ID
 obsTypeId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseObsUnitResponse

すべての OBS 型を取得する

操作 ID:
GetAllObsTypes

このエンドポイントは OBS 型専用です。 OBS ユニットを取得するには、/obsTypes/<obs-type-id>/obsUnits を使用します。

戻り値

一覧
ListResponseObsTypeResponse

すべてのロールの容量セグメントを取得する

操作 ID:
GetAllRoleCapacities

すべてのロールの容量セグメントを返します。 特定のロールの容量セグメントが存在しない場合、そのロールの容量は空になります。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseRoleWithRoleCapacityResponse

カレンダーからの逸脱を更新する

操作 ID:
UpdateCalendarDeviations

この要求を使用して、リソースのすべてのカレンダー偏差を一定期間置き換えます。 この期間は、要求のルート開始属性と終了属性を使用して定義できます。 偏差プロパティを使用して、カレンダーの偏差の新しいリストを指定します。 指定した期間内のすべての偏差は、偏差プロパティに記載されている偏差によって上書きされることに注意してください。

  • 開始期間と終了期間に null を使用すると、リソースのすべてのカレンダーの偏差が上書きされます。期間の開始日のみが定義されている場合、この時刻から始まるすべての偏差が上書きされます。期間の終了日のみが定義されている場合、その時点までのすべての偏差が上書きされます。カレンダーの偏差の開始日または終了日に null を使用する場合は、 偏差は、上記で指定したルートの開始日または終了日から、または終了するまで続くものと見なされます。

すべての偏差はシーケンシャル構造にフラット化されます。 重複する偏差のケースは、配列の後半で発生する偏差に優先順位を付けることで解決されます。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
[開始]
 start date
終了
 finish date
[開始]
 start date
終了
 finish date
相対容量
 relativeCapacity True double

戻り値

一覧
ListResponseCalendarDeviationResponse

カレンダーから偏差を取得する

操作 ID:
GetCalendarDeviations

リソースのカレンダーの稼働時間への偏差を読み取ります。 開始値と終了値が渡されない場合は、要求されたリソースのすべての偏差が返されます。 start のみが渡された場合、この時刻から始まるすべての偏差が返されます。 完了のみが渡された場合は、その時点までのすべての偏差が返されます。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
[開始]
 start date

期間のフィルター処理の開始日
終了
 finish date

フィルター期間の終了日

戻り値

一覧
ListResponseCalendarDeviationResponse

シナリオの一覧を取得する

操作 ID:
GetAllScenarios

シナリオの一覧を返します

戻り値

一覧
ListResponseScenarioResponse

タスクの一覧を取得する

操作 ID:
GetAllTasks

このエンドポイントはページ分割されています。 指定した PAGESIZE までのタスクの一覧を返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
Key
 key string

キーと完全に一致するすべてのオブジェクトを選択します。

戻り値

この操作の出力は状況に応じて変わります。

タスクの作成または更新

操作 ID:
CreateOrUpdateTask

指定されたフィールドを使用してタスクを作成または更新します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるタスク。

タスクの削除

操作 ID:
DeleteTask

特定のプロジェクト内のタスクを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タスク ID
 taskId True string

内部マイスタープラン識別子

タスクの置換

操作 ID:
ReplaceTask

このエンドポイントは、特定のプロジェクトのすべての既存のタスクを、要求で提供される新しいタスクの一覧に置き換えるために使用されます。 しくみ: 特定のプロジェクトのタスクの一覧を送信します。 システムは、タスク キーを識別子として使用して、プロジェクトのタスクをこのリストと同期します。 これは、以下のようなことを意味します。

  • 現在システム内にあるタスクは削除されますが、一覧に含まれていないタスクは削除されます。 - システムに存在しないリスト内のタスクが作成されます。 - システムと一覧の両方に存在するタスクは、変更がある場合に更新されます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タスク置換要求
 tasksReplaceRequest True dynamic

JSON ドキュメントによって表されるタスク。

タスク管理リンクの作成または更新

操作 ID:
CreateOrUpdateTaskManagementLink

このエンドポイントを使用すると、タスク管理リンクをプロジェクトに追加したり、externalViewUrl を更新したりできます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントで表されるタスク管理リンク。

戻り値

この操作の出力は状況に応じて変わります。

タスク管理リンクの削除

操作 ID:
DeleteTaskManagementLink

プロジェクトのタスク管理リンクを削除します

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

タスク管理リンクを取得する

操作 ID:
GetTaskManagementLink

プロジェクトのタスク管理リンクを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

この操作の出力は状況に応じて変わります。

ビジネス目標

操作 ID:
GetAllBusinessGoals

すべてのビジネス目標を返します

戻り値

一覧
ListResponseBusinessGoalDefinitionResponse

プログラムの一覧を取得する

操作 ID:
GetAllPrograms

特定のシナリオのプログラムの一覧を返します。

パラメーター

名前 キー 必須 型 説明
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。 指定したプロパティと完全に一致するすべてのオブジェクトを選択します。 プログラムは programKey と名前で検索できます。 注: パラメーターの URL エンコードには注意してください。 { "programKey": string, "name": string }
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子

戻り値

ページネーション
PaginatedResponseProgramGetAllResponse

プログラムの作成

操作 ID:
CreateProgram

指定されたフィールドを使用してプログラムを作成し、新しく作成されたプログラムを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるプログラム。

戻り値

この操作の出力は状況に応じて変わります。

プログラムの削除

操作 ID:
DeleteProgram

指定された ID で指定されたプログラムを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プログラム ID
 programId True string

内部マイスタープラン識別子

プログラムの更新

操作 ID:
UpdateProgram

指定された ID で指定されたプログラムに対して更新を実行します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プログラム ID
 programId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるプログラム。

戻り値

この操作の出力は状況に応じて変わります。

プロジェクト ID によって処理されたすべての実績時間を削除する

操作 ID:
DeleteAllActualTimeWorked

特定のプロジェクトの実績作業時間をすべて削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

プロジェクト コメントの一覧を取得する

操作 ID:
GetAllProjectComments

プロジェクト コメントの一覧を返します。

パラメーター

名前 キー 必須 型 説明
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
ページ サイズ
 pageSize integer

ページ サイズ
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

ページネーション
PaginatedResponseProjectCommentResponse

プロジェクトの一覧を取得する

操作 ID:
GetAllProjects

このエンドポイントはページ分割されています。 指定した PAGESIZE までのプロジェクトの一覧を返します

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。

戻り値

この操作の出力は状況に応じて変わります。

プロジェクトの作成

操作 ID:
CreateProject

指定されたフィールドを含むプロジェクトを作成し、新しく作成されたプロジェクトを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるプロジェクト。

戻り値

この操作の出力は状況に応じて変わります。

プロジェクトの削除

操作 ID:
DeleteProject

特定のシナリオのプロジェクトを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

プロジェクトの更新

操作 ID:
UpdateProject

指定された ID で指定されたプロジェクトに対して更新を実行します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるプロジェクト。

戻り値

この操作の出力は状況に応じて変わります。

ポートフォリオの一覧を取得する

操作 ID:
GetAllPortfolios

使用可能なすべてのポートフォリオの一覧を返します。 ポートフォリオを表示する権限がない場合は、API トークンを使用してアクセスする権限を持つ利用可能なすべてのポートフォリオの一覧を返します。 ポートフォリオを表示する権限がない場合は、空のリストが返されます。

戻り値

一覧
ListResponsePortfolioResponse

マイルストーンの一覧を取得する

操作 ID:
GetAllMilestones

プロジェクトのマイルストーンの一覧を返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseMilestoneResponse

マイルストーンの作成

操作 ID:
CreateMilestone

新しく作成されたマイルストーンを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
名前
 name True string
日付
 date True string

format: YYYY-MM-DD
名前
 name string

プロジェクト フェーズは、作成前に存在する必要があります。 暗黙的に作成されることはありません。
価値
 value string

戻り値

マイルストーン
MilestoneResponse

マイルストーンの依存関係の一覧を取得する

操作 ID:
GetAllMilestoneDependencies

シナリオのマイルストーンの依存関係の一覧を返します

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。

戻り値

ページネーション
PaginatedResponseMilestoneDependencyResponse

マイルストーンの依存関係を作成する

操作 ID:
CreateMilestoneDependency

新しく作成されたマイルストーン依存関係の ID を返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
マイルストーン ID から
 fromMilestoneId True string
マイルストーン ID へ
 toMilestoneId True string

戻り値

マイルストーン依存関係の作成
MilestoneDependencyCreateResponse

マイルストーンの依存関係を削除する

操作 ID:
DeleteMilestoneDependency

特定のシナリオでマイルストーンの依存関係を削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
マイルストーンの依存関係 ID
 milestoneDependencyId True string

内部マイスタープラン識別子

マイルストーンの削除

操作 ID:
DeleteMilestone

シナリオの特定のプロジェクトのマイルストーンを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
マイルストーン ID
 milestoneId True string

内部マイスタープラン識別子

マイルストーンの更新

操作 ID:
UpdateMilestone

指定された ID で指定されたマイルストーンに対して更新を実行します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
マイルストーン ID
 milestoneId True string

内部マイスタープラン識別子
名前
 name string
日付
 date string

format: YYYY-MM-DD
名前
 name string

プロジェクト フェーズは、作成前に存在する必要があります。 暗黙的に作成されることはありません。
価値
 value string

戻り値

マイルストーン
MilestoneResponse

マイルストーンを置き換える

操作 ID:
ReplaceMilestones

シナリオ内の特定のプロジェクトのマイルストーンを置き換えます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
名前
 name True string
日付
 date True string

format: YYYY-MM-DD
名前
 name string

プロジェクト フェーズは、作成前に存在する必要があります。 暗黙的に作成されることはありません。
価値
 value string

ユーザーの一覧を取得する

操作 ID:
GetAllUsers_1

ユーザーの一覧を返します。 userName または externalId によるフィルター処理を許可します。

パラメーター

名前 キー 必須 型 説明
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
ページ サイズ
 pageSize integer

ページ サイズ
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。

戻り値

ページネーション
PaginatedResponseUserResponse

リソースの一覧を取得する

操作 ID:
GetAllResources

このエンドポイントはページ分割されています。 指定した PAGESIZE までのリソースの一覧を返します

パラメーター

名前 キー 必須 型 説明
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。

戻り値

この操作の出力は状況に応じて変わります。

リソースの作成

操作 ID:
CreateResource

指定されたフィールドによってリソースを作成し、新しく作成されたフィールドを返します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるリソース。

戻り値

この操作の出力は状況に応じて変わります。

リソースの削除

操作 ID:
DeleteResource

指定した ID で指定されたリソースを削除します。 指定した ID のリソースが存在しない場合、要求は失敗します。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子

リソースの更新

操作 ID:
UpdateResource

指定された ID で指定されたリソースに対して更新を実行します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるリソース。

戻り値

この操作の出力は状況に応じて変わります。

ロールの一覧を取得する

操作 ID:
GetAllRoles

使用可能なすべてのロールの一覧を返します。 使用可能なロールがない場合は、空のリストが返されます。

パラメーター

名前 キー 必須 型 説明
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。

戻り値

この操作の出力は状況に応じて変わります。

ロールの作成

操作 ID:
CreateRole

成功した場合に作成されたロールを返します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるロール。

戻り値

この操作の出力は状況に応じて変わります。

ロールの削除

操作 ID:
DeleteRole

指定した ID で指定されたロールを削除します。 指定された ID のロールが存在しない場合、要求は失敗します。

パラメーター

名前 キー 必須 型 説明
ロール ID
 roleId True string

内部マイスタープラン識別子

ロールの容量セグメントを取得する

操作 ID:
GetRoleCapacities

指定された ID で指定されたロールの容量セグメントを返します。 容量セグメントが存在しない場合は、空のリストを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ロール ID
 roleId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseRoleCapacityResponse

ロールの容量セグメントを更新する

操作 ID:
UpdateRoleCapacities

指定された ID で指定されたロールの容量セグメントを更新します。 すべての容量セグメントを消去するには、開始または終了なしでセグメントを送信し、容量を 0 に設定します

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ロール ID
 roleId True string

内部マイスタープラン識別子
start
 start date
終える
 finish date
fte
 fte double

要求は、FTE、時間、または日のいずれかを受け入れます。
日
 days double

要求は、FTE、時間、または日のいずれかを受け入れます。
時間
 hours double

要求は、FTE、時間、または日のいずれかを受け入れます。

戻り値

一覧
ListResponseRoleCapacityResponse

ロールの更新

操作 ID:
UpdateRole

指定された ID で指定されたロールに対して更新を実行します。 部分的な更新を行うには、更新されたフィールドのみを送信する必要があります。 フィールド値を削除するには、明示的な null 値を使用してフィールドを送信する必要があります。 既定値を持つフィールドは、null に設定すると既定値にリセットされます。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
ロール ID
 roleId True string

内部マイスタープラン識別子
ペイロード
 payload True dynamic

JSON ドキュメントによって表されるロール。

戻り値

この操作の出力は状況に応じて変わります。

予定表の一覧を取得する

操作 ID:
GetAllCalendars

マイスタープラン システム内のすべての予定表の一覧を取得します。

戻り値

一覧
ListResponseCalendarResponse

予定表の例外の一覧を取得する

操作 ID:
GetAllCalendarExceptions

マイスタープラン システムで、このカレンダーに対するすべての例外の一覧を取得します。

パラメーター

名前 キー 必須 型 説明
予定表 ID
 calendarId True string

内部マイスタープラン識別子
開始日
 startDate date

開始日
終了日
 endDate date

終了日

戻り値

一覧
ListResponseCalendarExceptionResponse

予定表の例外を更新する

操作 ID:
CreateCalendarExceptions

この要求を使用して、一定期間のすべての予定表の例外を置き換えます。 この期間は、要求のルート開始属性と終了属性を使用して定義できます。 exceptions プロパティを使用して、予定表の例外の新しい一覧を指定します。 指定した期間内のすべての例外は、exceptions プロパティに記載されている例外によって上書きされることに注意してください。

  • 開始期間と終了期間に null を使用すると、カレンダーのすべての例外が上書きされます。期間の開始日のみが定義されている場合は、この時刻から始まるすべての例外が上書きされます。期間の終了日のみが定義されている場合、その時点までのすべての例外が上書きされます。例外が削除され、親カレンダーにその日付に例外がある場合、 このカレンダーは、親カレンダーから例外を継承します。

パラメーター

名前 キー 必須 型 説明
予定表 ID
 calendarId True string

内部マイスタープラン識別子
[開始]
 start date
終了
 finish date
日付
 date True date
労働時間
 workingHours True double
Description
 description string

予定表を作成する

操作 ID:
CreateCalendar

指定されたデータを含む予定表を作成します。 新しく作成された予定表を返します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string
親 ID
 parentId string
月曜日
 monday True double
火曜日
 tuesday True double
水曜日
 wednesday True double
木曜日
 thursday True double
金曜日
 friday True double
土曜日
 saturday True double
日曜日
 sunday True double

戻り値

カレンダー
CalendarResponse

予定表を削除する

操作 ID:
DeleteCalendarById

マイスタープラン システムの予定表を削除します。 既定の予定表または既定の予定表の親は削除できないことに注意してください。

パラメーター

名前 キー 必須 型 説明
予定表 ID
 calendarId True string

内部マイスタープラン識別子

予定表を更新する

操作 ID:
UpdateCalendar

指定された ID で指定された予定表に対して更新を実行します。

経路

/ で区切られたパス (カレンダーや OBS 単位パスなど) は、//でエスケープすることによって/を含むパス セグメントを定義できます。 たとえば、パスヨーロッパ/ベルリン/アムステルダムは[ヨーロッパ]、"ベルリン/アムステルダム"と解釈されます。 スラッシュの不均一な量は、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 型 説明
予定表 ID
 calendarId True string

内部マイスタープラン識別子
名前
 name string
月曜日
 monday True double
火曜日
 tuesday True double
水曜日
 wednesday True double
木曜日
 thursday True double
金曜日
 friday True double
土曜日
 saturday True double
日曜日
 sunday True double

戻り値

カレンダー
CalendarResponse

休暇の一覧を取得する

操作 ID:
GetAllAbsences

リソースの不在の一覧を返します。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
開始日
 startDate date

期間のフィルター処理の開始日
終了日
 finishDate date

期間をフィルター処理するための包括的な終了日。

戻り値

一覧
ListResponseAbsenceResponse

休暇の作成

操作 ID:
CreateAbsences

この要求を使用して、特定の期間の休暇を追加します。 この期間は、要求の開始属性と終了属性を使用して定義できます。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
[開始]
 start True string

format: YYYY-MM-DD
終了
 finish True string

format: YYYY-MM-DD
開始日の種類
 startDayType string

既定値は FULL_DAY
終了日の種類
 finishDayType string

既定値は FULL_DAY

戻り値

不在
AbsenceResponse

休暇の削除

操作 ID:
DeleteAbsence

休暇を削除します。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
休暇 ID
 absenceId True string

内部マイスタープラン識別子

休暇の更新

操作 ID:
UpdateAbsences

休暇を更新するには、この要求を使用します。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
休暇 ID
 absenceId True string

内部マイスタープラン識別子
[開始]
 start string

format: YYYY-MM-DD
終了
 finish string

format: YYYY-MM-DD
開始日の種類
 startDayType string
終了日の種類
 finishDayType string

戻り値

不在
AbsenceResponse

休暇の置換

操作 ID:
ReplaceAbsences

このエンドポイントを使用すると、リソースが存在しないすべての状態を置き換えることができます。 結果は、既存のすべての休暇が削除され、合格した休暇が再度作成される場合と同じになります。 'start' クエリ パラメーターと 'end' クエリ パラメーターを使用して、既存の休暇を置き換える時間範囲を指定できます。 これらのパラメーターを使用しない場合、すべての休暇は新しく送信された休暇に置き換えられます。

パラメーター

名前 キー 必須 型 説明
リソース ID
 resourceId True string

内部マイスタープラン識別子
[開始]
 start date

置換期間の開始日
End
 end date

置換期間の包括終了日。
[開始]
 start True string

format: YYYY-MM-DD
終了
 finish True string

format: YYYY-MM-DD
開始日の種類
 startDayType string

既定値は FULL_DAY
終了日の種類
 finishDayType string

既定値は FULL_DAY

割り当ての一覧を取得する

操作 ID:
GetAllAllocations

プロジェクトの割り当ての一覧を返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseAllocationResponse

割り当ての作成または更新

操作 ID:
CreateOrUpdateAllocation

このエンドポイントを使用すると、新しい割り当てを作成し、プロジェクトの既存の割り当てを更新できます。 変更は、指定した日付範囲だけでなく、指定されたリソースとロールに対してのみ行われます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ID
 id True string

この割り当てがリンクされているエンティティの ID。 代わりに、リソース キーまたはロール名を自動的に解決するには、型を RESOLVE_BY_KEY_OR_NAME に設定します。
タイプ
 type string

フィールド ID の値の解釈方法を制御します。 RESOURCE は、UUID によってリソースを解決します。 ROLE は、UUID によってロールを解決します。 RESOLVE_BY_KEY_OR_NAMEは、リソース キーまたはロール名によってリソースを解決します。
プロジェクト ロール
 projectRole string

この割り当てがリンクされているロール ID。 このフィールドは、RESOURCE 型または RESOLVE_BY_KEY_OR_NAME 型と組み合わせてのみ有効です。 型が RESOLVE_BY_KEY_OR_NAME に設定されている場合、projectRole は名前で解決されます。
[開始]
 start True date
終了
 finish True date
Fte
 fte double

要求は、FTE、時間、または日のいずれかを受け入れます。
日数
 days double

要求は、FTE、時間、または日のいずれかを受け入れます。
時間
 hours double

要求は、FTE、時間、または日のいずれかを受け入れます。

戻り値

割り当て
AllocationResponse

割り当ての削除

操作 ID:
DeleteAllocation

シナリオの特定のプロジェクトの割り当てを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
割り当て ID
 allocationId True string

内部マイスタープラン識別子

割り当ての更新

操作 ID:
UpdateAllocation

このエンドポイントを使用すると、プロジェクトの既存の割り当てを更新できます。 変更は、指定した日付範囲だけでなく、指定されたリソースとロールに対してのみ行われます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
割り当て ID
 allocationId True string

内部マイスタープラン識別子
[開始]
 start True date
終了
 finish True date
Fte
 fte double

要求は、FTE、時間、または日のいずれかを受け入れます。
日数
 days double

要求は、FTE、時間、または日のいずれかを受け入れます。
時間
 hours double

要求は、FTE、時間、または日のいずれかを受け入れます。

戻り値

割り当て
AllocationResponse

割り当ての置換

操作 ID:
ReplaceAllocation

このエンドポイントを使用すると、プロジェクトのすべての割り当てを置き換えることができます。 結果は、既存のすべての割り当てが削除され、渡された割り当てが再度作成される場合と同じになります。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ID
 id True string

この割り当てがリンクされているエンティティの ID。 代わりに、リソース キーまたはロール名を自動的に解決するには、型を RESOLVE_BY_KEY_OR_NAME に設定します。
タイプ
 type string

フィールド ID の値の解釈方法を制御します。 RESOURCE は、UUID によってリソースを解決します。 ROLE は、UUID によってロールを解決します。 RESOLVE_BY_KEY_OR_NAMEは、リソース キーまたはロール名によってリソースを解決します。
プロジェクト ロール
 projectRole string

この割り当てがリンクされているロール ID。 このフィールドは、RESOURCE 型または RESOLVE_BY_KEY_OR_NAME 型と組み合わせてのみ有効です。 型が RESOLVE_BY_KEY_OR_NAME に設定されている場合、projectRole は名前で解決されます。
[開始]
 start True date
終了
 finish True date
Fte
 fte double

要求は、FTE、時間、または日のいずれかを受け入れます。
日数
 days double

要求は、FTE、時間、または日のいずれかを受け入れます。
時間
 hours double

要求は、FTE、時間、または日のいずれかを受け入れます。

割り当てコメントの一覧を取得する

操作 ID:
GetAllAllocationComments

割り当てコメントの一覧を返します。

パラメーター

名前 キー 必須 型 説明
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
ページ サイズ
 pageSize integer

ページ サイズ
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

ページネーション
PaginatedResponseAllocationCommentResponse

実績作業時間の一覧を取得する

操作 ID:
GetAllActualTimeWorked

特定のシナリオのすべてのプロジェクトで実績作業時間の一覧を返します。 実際の作業時間データ自体は、そのシナリオとは無関係であることに注意してください。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ページ サイズ
 pageSize integer

ページ サイズ
ページの後
 pageAfter string

結果を取得するカーソル。 カーソルは、前の要求から取得できます。
Filter
 filter string

予期されるオブジェクトのプロパティのサブセットを含む文字列化された JSON オブジェクト。

戻り値

ページネーション
PaginatedResponseActualTimeWorkedResponse

実績作業時間の作成または更新

操作 ID:
CreateOrUpdateActualTimeWorked

このエンドポイントを使用すると、新しい実績作業時間を作成し、エンティティ (リソースまたはロール) によってプロジェクトの既存の実績作業時間を更新できます。 特定のプロジェクトとエンティティの要求で指定されていない予約日の実績作業時間は更新されません。 mode プロパティを使用すると、既存の実績作業時間の値が新しい値に置き換えられるか、その値が要求の予約に追加されるかを制御できます。 実際の作業時間データ自体は、そのシナリオとは無関係であることに注意してください。 これは、特定のプロジェクトのすべてのシナリオで同じになります。 要求は、プロジェクトとリソース/ロールごとに 5,000 の実績作業時間の値に制限されます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
ID
 id True string

この実際の作業時間のエントリがリンクされているエンティティの ID。 代わりに、リソース キーとチーム キーまたはロール名を自動的に解決するには、型を RESOLVE_BY_KEY_OR_NAME に設定します。
タイプ
 type string
チームID
 teamId string

この実績作業時間エントリがリンクされているエンティティのチーム ID
予約日
 bookingDate True date

この予約日
時間
 hours True double

実際の作業時間 (時間単位)
原価タイプ
 costType string

default: Meisterplan のドキュメントを参照してください。
1 時間あたりのコスト
 costPerHour double

この予約の 1 時間あたりのコスト
Mode
 mode string

戻り値

実績作業時間
ActualTimeWorkedResponse

実績財務イベントの作成

操作 ID:
CreateFinancialActuals

新しく作成された実際の財務イベントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タイプ
 type True string
金額
 amount True double
予約日
 bookingDate True date
Description
 description string
名前
 name string

財務カテゴリは、作成前に存在する必要があります。 暗黙的に作成されることはありません。

戻り値

財務実績
FinancialActualsResponse

実際の財務イベントの一覧を取得する

操作 ID:
GetAllActualFinancialEvents

プロジェクトの実際の財務イベントの一覧を返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseFinancialActualsResponse

実際の財務イベントの更新

操作 ID:
UpdateFinancialActuals

更新された実際の財務イベントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
財務実績 ID
 actualFinancialEventId True string

内部マイスタープラン識別子
タイプ
 type string
金額
 amount double
予約日
 bookingDate string

format: YYYY-MM-DD
Description
 description string
名前
 name string

財務カテゴリは、作成前に存在する必要があります。 暗黙的に作成されることはありません。

戻り値

財務実績
FinancialActualsResponse

実際の財務イベントを削除する

操作 ID:
DeleteFinancialActuals

シナリオの特定のプロジェクトの実際の財務イベントを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
財務実績 ID
 actualFinancialEventId True string

内部マイスタープラン識別子

実際の財務イベントを置き換える

操作 ID:
ReplaceFinancialActuals

シナリオ内の特定のプロジェクトの実際の財務イベントを置き換えます。 要求は、プロジェクトごとに 5,000 件の実際の財務イベントに制限されます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タイプ
 type True string
金額
 amount True double
予約日
 bookingDate True date
Description
 description string
名前
 name string

財務カテゴリは、作成前に存在する必要があります。 暗黙的に作成されることはありません。

既定の予定表を設定する

操作 ID:
SetDefaultCalendar

既存の予定表をマイスタープラン システムの既定の予定表として設定します。

パラメーター

名前 キー 必須 型 説明
ID
 id True string

更新の優先順位

操作 ID:
UpdatePriorities

このエンドポイントは、プロジェクトとプログラムの優先順位を更新します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
ID
 id True string

ID 値には、プロジェクトまたはプログラムを指定できます。
位置
 position string

位置には FIRST または LAST を指定できます。 FIRST は既定です
ID
 id True string

ID 値には、プロジェクトまたはプログラムを指定できます。
位置
 position string

位置には FIRST または LAST を指定できます。 FIRST は既定です
ID
 id True string

ID 値には、プロジェクトまたはプログラムを指定できます。
位置
 position string

位置には FIRST または LAST を指定できます。 FIRST は既定です

財務の一覧を取得する

操作 ID:
GetAllFinancials

プロジェクトの財務の一覧を返します

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子

戻り値

一覧
ListResponseFinancialsResponse

財務を作成する

操作 ID:
CreateFinancials

新しく作成された財務イベントを返します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タイプ
 type True string
金額
 amount True double
On
 on True string

マイルストーンは、フィールド milestoneId の値と組み合わせてのみ有効です。 日付は、dueDate フィールドの値と組み合わせてのみ有効です。
マイルストーン ID
 milestoneId string

on: マイルストーンと組み合わせてのみ有効です。 マイルストーンはプロジェクトに存在する必要があります。 暗黙的に作成されることはありません。
期日
 dueDate string

on: Date (形式: YYYY-MM-DD) と組み合わせてのみ有効です。
Description
 description string
名前
 name string

財務カテゴリは、作成前に存在する必要があります。 暗黙的に作成されることはありません。

戻り値

財務
FinancialsResponse

財務を削除する

操作 ID:
DeleteFinancials

シナリオの特定のプロジェクトの財務イベントを削除します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
財務 ID
 financialsId True string

内部マイスタープラン識別子

財務を置き換える

操作 ID:
ReplaceFinancials

シナリオ内の特定のプロジェクトの財務イベントを置き換えます。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
タイプ
 type True string
金額
 amount True double
On
 on True string

マイルストーンは、フィールド milestoneId の値と組み合わせてのみ有効です。 日付は、dueDate フィールドの値と組み合わせてのみ有効です。
マイルストーン ID
 milestoneId string

on: マイルストーンと組み合わせてのみ有効です。 マイルストーンはプロジェクトに存在する必要があります。 暗黙的に作成されることはありません。
期日
 dueDate string

on: Date (形式: YYYY-MM-DD) と組み合わせてのみ有効です。
Description
 description string
名前
 name string

財務カテゴリは、作成前に存在する必要があります。 暗黙的に作成されることはありません。

財務情報の更新

操作 ID:
UpdateFinancials

シナリオの特定のプロジェクトの ID によって財務イベントを更新します。

パラメーター

名前 キー 必須 型 説明
シナリオ ID
 scenarioId True string

内部マイスタープラン識別子
プロジェクト ID
 projectId True string

内部マイスタープラン識別子
財務 ID
 financialsId True string

内部マイスタープラン識別子
タイプ
 type string
金額
 amount double
On
 on True string

マイルストーンは、フィールド milestoneId の値と組み合わせてのみ有効です。 日付は、dueDate フィールドの値と組み合わせてのみ有効です。
マイルストーン ID
 milestoneId string

on: マイルストーンと組み合わせてのみ有効です。 マイルストーンはプロジェクトに存在する必要があります。 暗黙的に作成されることはありません。
期日
 dueDate string

on: Date (形式: YYYY-MM-DD) と組み合わせてのみ有効です。
Description
 description string
名前
 name string

財務カテゴリは、作成前に存在する必要があります。 暗黙的に作成されることはありません。

戻り値

財務
FinancialsResponse

トリガー

Webhook の作成

指定されたフィールドによって webhook を作成し、新しく作成されたフィールドを返します。 現在、システムごとに 1,000 個の Webhook がサポートされています。

Webhook の作成

操作 ID:
CreateWebhook

指定されたフィールドによって webhook を作成し、新しく作成されたフィールドを返します。 現在、システムごとに 1,000 個の Webhook がサポートされています。

パラメーター

名前 キー 必須 型 説明
イベントの種類
 eventTypes True array of string

少なくとも 1 つのイベントの種類を指定する必要があります。
シナリオ ID
 scenarioId True string

サブスクライブするシナリオ。
プロジェクト ID
 projectId string

projectId は省略可能です。 これは、特定のプロジェクトをサブスクライブする場合にのみ必要です。

戻り値

この操作の出力は状況に応じて変わります。

定義

UserRefResponse

名前 パス 型 説明
ユーザーID
 id string
ユーザー表示名
 displayName string

ListResponseRoleCapacityResponse

名前 パス 型 説明
アイテム
 items array of RoleCapacityResponse

RoleCapacityResponse

名前 パス 型 説明
start
 start date

このロール容量セグメントの開始日。 Optional.
終える
 finish date

このロール容量セグメントの終了日。 Optional.
fte
 fte double

FTE におけるロールの容量

MilestoneResponse

名前 パス 型 説明
ID
 id string
名前
 name string
日付
 date string

format: YYYY-MM-DD
プロジェクト フェーズ
 projectPhase ProjectPhaseResponse
ステータス
 status StatusResponse

ProjectPhaseResponse

名前 パス 型 説明
名前
 name string

StatusResponse

名前 パス 型 説明
価値
 value string
表示される名前
 displayName string

FinanceCategoryResponse

名前 パス 型 説明
名前
 name string

FinancialsResponse

名前 パス 型 説明
ID
 id string
タイプ
 type string
金額
 amount double
財務のタイミング
 timing FinancialsTimingResponse
Description
 description string
財務カテゴリ
 category FinanceCategoryResponse

FinancialsTimingResponse

名前 パス 型 説明
On
 on string
マイルストーン ID
 milestoneId string

タイミングの種類がマイルストーンと等しい場合にのみ存在します
期日
 dueDate date

FinancialActualsResponse

名前 パス 型 説明
ID
 id string
タイプ
 type string
金額
 amount double
予約日
 bookingDate string

format: YYYY-MM-DD
Description
 description string
財務カテゴリ
 category FinanceCategoryResponse

AllocatedEntityResponse

名前 パス 型 説明
ID
 id string

この割り当てがリンクされているエンティティの ID
タイプ
 type string

この割り当てのエンティティ型
プロジェクト ロール
 projectRole string

型が RESOURCE と等しい場合にのみ設定されます

AllocationResponse

名前 パス 型 説明
ID
 id string

この割り当ての ID
割り当てられたエンティティ
 allocatedEntity AllocatedEntityResponse
セグメント
 segments array of AllocationSegmentResponse

割り当ての時間セグメント

AllocationSegmentResponse

割り当ての時間セグメント

名前 パス 型 説明
[開始]
 start date

この割り当ての開始日
終了
 finish date

この割り当ての終了日
時間
 hours double

割り当て値 (時間単位)

ActualTimeWorkedResponse

名前 パス 型 説明
Actuals Entity Link
 bookedEntity ActualsEntityLinkResponse
予約
 bookings array of ActualsBookingResponse

この実際の作業時間の入力の予約日と時間

ActualsBookingResponse

この実際の作業時間の入力の予約日と時間

名前 パス 型 説明
ID (アイディー)
 id string

この実際の作業時間のエントリの予約 ID
予約日
 bookingDate date

この実際の作業時間の入力の予約日
時間
 hours double

実際の作業時間 (時間単位)
原価タイプ
 costType string
1 時間あたりのコスト
 costPerHour double

ActualsEntityLinkResponse

名前 パス 型 説明
ID
 id string

この実際の作業時間のエントリがリンクされているエンティティの ID
タイプ
 type string

この実績作業時間エントリのエンティティ型
チームID
 teamId string

この実績作業時間エントリがリンクされているエンティティのチーム ID

MilestoneDependencyCreateResponse

名前 パス 型 説明
ID
 id string

CalendarDeviationResponse

名前 パス 型 説明
[開始]
 start date
終了
 finish date
相対容量
 relativeCapacity double

ListResponseCalendarDeviationResponse

名前 パス 型 説明
アイテム
 items array of CalendarDeviationResponse

AbsenceResponse

名前 パス 型 説明
ID
 id string

欠席の ID
開始日
 start date

この休暇の開始日
終了日
 finish date

この休暇の終了日
休暇の開始日の種類
 startDayType string
休暇日の種類の完了
 finishDayType string

ObsTypeResponse

名前 パス 型 説明
ID
 id string
名前
 name string

ObsUnitResponse

名前 パス 型 説明
ID
 id string
名前
 name string
経路
 path string
表示される名前
 displayName string

表示名は、Meisterplan アプリケーションのユーザー インターフェイスと同じ方法でレンダリングされます。
親 ID
 parentId string

CalendarResponse

名前 パス 型 説明
ID
 id string
名前
 name string
親 ID
 parentId string
経路
 path string
労働時間
 workingHours WorkingHoursResponse

WorkingHoursResponse

名前 パス 型 説明
月曜日
 monday double
火曜日
 tuesday double
水曜日
 wednesday double
木曜日
 thursday double
金曜日
 friday double
土曜日
 saturday double
日曜日
 sunday double

Cursor

名前 パス 型 説明
Cursor
 cursor string

改ページ

名前 パス 型 説明
Cursor
 after Cursor

BasicUserGroupResponse

名前 パス 型 説明
グループ識別子
 id string

ユーザー グループの ID。
グループ名
 name string

ユーザー グループの名前。

LinkedResourceResponse

名前 パス 型 説明
ID
 id string

リンクされたリソースの ID。
リソース キー
 resourceKey string

リンクされたリソースのリソース キー。

PaginatedResponseUserResponse

名前 パス 型 説明
アイテム
 items array of UserResponse
改ページ
 _pagination Pagination

UserResponse

名前 パス 型 説明
ID
 id string
ユーザー名
 userName string
外部 ID
 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
 id string
スプリント キー
 key string
名前
 name string
[開始]
 start date-time
End
 end date-time

ListResponseScenarioResponse

名前 パス 型 説明
アイテム
 items array of ScenarioResponse

ScenarioResponse

名前 パス 型 説明
ID
 id string
名前
 name string

ListResponseRoleWithRoleCapacityResponse

名前 パス 型 説明
アイテム
 items array of RoleWithRoleCapacityResponse

RoleWithRoleCapacityResponse

名前 パス 型 説明
役割ID
 roleId string

ロールの ID。
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
 id string
Content
 content string
ユーザー参照
 author UserRefResponse
作成日
 createdDate string
mentions
 mentions array of UserRefResponse

ListResponseAllocationResponse

名前 パス 型 説明
アイテム
 items array of AllocationResponse

AllocationCommentEntityResponse

名前 パス 型 説明
ID
 id string

この割り当てコメントがリンクされているエンティティの ID
タイプ
 type string

この割り当てコメントがリンクされているエンティティの型

AllocationCommentResponse

名前 パス 型 説明
ID
 id string
Content
 content string
ユーザー参照
 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

名前 パス 型 説明
Actuals Entity Link
 bookedEntity ActualsEntityLinkResponse
ID (アイディー)
 id string

この実際の作業時間のエントリの予約 ID
予約日
 bookingDate date

この実際の作業時間の入力の予約日
時間
 hours double

実際の作業時間 (時間単位)
原価タイプ
 costType string
1 時間あたりのコスト
 costPerHour double

PaginatedResponseProgramGetAllResponse

名前 パス 型 説明
アイテム
 items array of ProgramGetAllResponse
改ページ
 _pagination Pagination

ProgramGetAllResponse

名前 パス 型 説明
ID
 id string
名前
 name string
プログラム キー
 programKey string

ユニークである必要があります。 空の場合、値が生成されます。

MilestoneDependencyResponse

名前 パス 型 説明
ID
 id string
マイルストーン リファレンス
 from MilestoneReferenceResponse
マイルストーン リファレンス
 to MilestoneReferenceResponse

MilestoneReferenceResponse

名前 パス 型 説明
プロジェクト ID
 projectId string
マイルストーン ID
 milestoneId string

PaginatedResponseMilestoneDependencyResponse

名前 パス 型 説明
アイテム
 items array of MilestoneDependencyResponse
改ページ
 _pagination Pagination

ListResponseAbsenceResponse

名前 パス 型 説明
アイテム
 items array of AbsenceResponse

ListResponsePortfolioResponse

名前 パス 型 説明
アイテム
 items array of PortfolioResponse

PortfolioResponse

名前 パス 型 説明
ID
 id string
名前
 name string

ListResponseObsTypeResponse

名前 パス 型 説明
アイテム
 items array of ObsTypeResponse

ListResponseObsUnitResponse

名前 パス 型 説明
アイテム
 items array of ObsUnitResponse

ListResponseCalendarResponse

名前 パス 型 説明
アイテム
 items array of CalendarResponse

CalendarExceptionResponse

名前 パス 型 説明
日付
 date date
労働時間
 workingHours double
Description
 description string
ソースカレンダー ID
 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