Meisterplan

Meisterplan はポートフォリオ レベルのリソース管理ツールで、ポートフォリオ マネージャーとリソース マネージャーが、従来型、アジャイル、ハイブリッドのいずれであっても、チームやイニシアチブ全体で人々を管理するのに役立ちます。 これを使用して、自信を持ってポートフォリオの決定を下し、インタラクティブにリソースの競合を明らかにして解決します。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Meisterplan サポート
[URL] https://help.meisterplan.com/
メール support@meisterplan.com
Connector Metadata
発行者 Meisterplan
Web サイト https://meisterplan.com
プライバシー ポリシー https://meisterplan.com/privacy-and-data-protection/
カテゴリー ビジネス管理、ビジネス インテリジェンス

Meisterplan はポートフォリオ レベルのリソース管理ツールで、ポートフォリオ マネージャーとリソース マネージャーが、従来型、アジャイル、ハイブリッドのいずれであっても、チームやイニシアチブ全体で人々を管理するのに役立ちます。 これを使用して、自信を持ってポートフォリオの決定を下し、インタラクティブにリソースの競合を明らかにして解決します。 リソースの利用可能性とキャパシティを確認し、プロジェクトを可視化し、プロジェクト ポートフォリオに優先順位を付けて戦略に合わせ、Meisterplan を使用してリアルタイムのシナリオ シミュレーションを生成します。 Meisterplan Connector を使用することで、Meisterplan をチームが使用するすべてのツールと統合できるため、プロジェクト データを二重に保守する必要がなくなります。 プロジェクトを更新する必要がある場合でも、承認された休暇申請を提出する必要がある場合でも、Meisterplan と Meisterplan Connector はプロセスをシームレスにします。

前提条件

Meisterplan コネクタを使用するには、Meisterplan アカウントが必要です。 Meisterplan を始めるには、デモをリクエスト あるいは 試用版をトライ します。

資格情報の入手方法

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

コネクタの使用を開始する

一般的なユース ケース:

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

既知の問題と制限事項

  • 現在、既知の制限はありません。 レート制限、ページ分割などに関する一般的な情報は、REST API ドキュメントにあります。

一般的なエラーと解決策

Meisterplan Connector は Meisterplan REST API を使用します。 ステータス コードを含む説明は、REST API 説明書 にあります。 追加情報は、ヘルプ センター にあります。

よくあるご質問

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

    • Meisterplan ユーザーは、Meisterplan API へのアクセスと外部アプリケーションへの接続 権限を持つ必要があります。
    • Meisterplan ユーザーは、コネクタを使用して読み取りまたは更新するフィールドの読み取りおよび編集権限を持っている必要があります。
  • Meisterplan のベーシック版でも使用できますか ?

    • はい、コネクタは Meisterplan のすべてのエディションでサポートされています。

接続を作成する

このコネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

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

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

件名 タイプ 説明設定 Required
Region string ホストされている Meisterplan システムの地域 True

調整制限

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

アクション

ID で Get Milestones を取得する

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

ID でカレンダーを取得する

Meisterplan システムのカレンダーをひとつ取得する。 デフォルトのカレンダーを取得するには、特別な ID defaultCalendar を使用します。

ID でシナリオを取得する

指定された ID で個別のシナリオを返します。 ヒント: PlanOfRecord シナリオの ID として "planOfRecord" を使用できます。

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

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

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

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

ID でユーザーを取得

ユーザーを返します。

ID でリソースを取得する

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

ID でロールを取得する

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

ID で不在を取得する

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

ID で財務を取得する

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

ID で配賦を取得する

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

ID によって OBS タイプを取得します

このエンドポイントは OBS タイプ専用です。 OBS ユニットを取得するには、/obsTypes//obsUnits を使用します

ID による OBS タイプの削除

指定された ID で指定された OBS タイプを削除します。 指定された ID を持つ OBS タイプが存在しない場合、リクエストは失敗します。

ID による OBS ユニットの削除

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

ID による実際の金融イベントの取得

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

ID による配賦コメントの取得

配賦コメントを返します。

Milestone の依存関係の削除

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

Milestone の依存関係を作成する

新しく作成されたスタッフオンライン プレゼンスの ID

Milestone 依存関係のリストを取得する

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

Milestones のリストの取得

プロジェクトのマイルストーンのリストを返す

Milestones の削除

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

Milestones の置換

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

Milestones を更新する

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

OBS タイプの作成

指定されたデータで OBS タイプを作成します。 新しく作成された OBS タイプを返します。

OBS タイプの更新

指定された ID で指定された OBS タイプで更新を実行します。

OBS ユニットの作成

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

OBS ユニットの更新

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

OBS ユニットを取得する

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

すべての OBS タイプを取得する

このエンドポイントは OBS タイプ専用です。 OBS ユニットを取得するには、/obsTypes//obsUnits を使用します

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

この エンドポイント は、指定された OBS タイプのすべての OBS ユニットのリストを返します。

すべてのロールのキャパシティ セグメントの取得

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

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

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

カレンダーから偏差を更新する

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

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

すべての偏差は、順次構造にフラット化されます。 重複する偏差のケースは、アレイ内で後で発生する偏差を優先することで解決されます。

カレンダーのリストを取得する

Meisterplan システムですべてのカレンダーのリストを取得します。

カレンダーの作成

指定されたデータでカレンダーを作成します。 新しく作成されたカレンダーを返します。

カレンダーの例外のリストを取得する

Meisterplan システムでこのカレンダーのすべての例外のリストを取得します。

カレンダーの削除

Meisterplan システムのカレンダーを削除します。 デフォルトのカレンダーまたはデフォルトのカレンダーの親は削除できないことに注意してください。

カレンダーの更新

指定された ID で指定されたカレンダーで更新を実行します。

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

カレンダー更新の例外

このリクエストを使用して、特定の期間のすべてのカレンダーの例外を置き換えます。 この期間は、リクエストのルートの開始および終了属性を使用して定義できます。 exceptions プロパティを使用して、カレンダーの例外の新しいリストを指定します。 指定された期間のすべての例外は、例外プロパティにリストされた例外によって上書きされることに注意してください。

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

シナリオのリストを返します

デフォルトのカレンダーを設定する

既存のカレンダーを Meisterplan システムのデフォルト カレンダーとして設定します。

ビジネス目標

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

プログラムのリストを取得する

指定したシナリオのプログラムのリストを返します

プログラムの作成

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

プログラムの削除

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

プログラムの更新

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

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

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

プロジェクトのリストを取得する

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

プロジェクトの作成

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

プロジェクトの削除

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

プロジェクトの更新

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

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

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

マイルストーンの作成

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

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

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

リソースのリストの取得

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

リソースの作成

指定されたフィールドでリソースを作成し、新しく作成されたものを返します。

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

リソースの削除

指定された ID で指定されたリソースを削除します。 指定された ID を持つリソースが存在しない場合、リクエストは失敗します。

リソースの更新

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

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

ロールのリストを取得する

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

ロールの作成

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

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

ロールの削除

指定された ID で指定されたロールを削除します。 指定された ID を持つロールが存在しない場合、リクエストは失敗します。

ロールの更新

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

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

不在の一覧の取得

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

不在の作成

このリクエストを使用して、特定の期間の不在を追加します。 この期間は、リクエストの開始および終了属性を使用して定義できます。

不在の削除

不在を削除します。

不在の更新

この要求を使用して不在を更新します。

不在の置換

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

優先度の更新

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

実労働時間のリストを取得する

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

実労働時間の作成または更新

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

実労働時間の削除

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

実際の財務イベントの作成

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

実際の財務イベントの削除

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

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

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

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

シナリオ内で、指定されたプロジェクトの実際の財務イベントを置き換えます。 リクエストは、プロジェクトごとに実際の金融イベントが 5000 件に制限されています。

実際の金融イベントのリストを入手する

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

役割のキャパシティ セグメントの取得

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

役割のキャパシティ セグメントの更新

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

財務のリストを取得する

プロジェクトの財務のリストを返します

財務の作成

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

財務の削除

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

財務の更新

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

財務の置換

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

配賦のリストを取得する

プロジェクトの配賦のリストを返す

配賦の削除

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

配賦の更新

このエンドポイントを使用すると、プロジェクトの既存の配賦を更新することができます。 変更は、指定された日付範囲と、指定されたリソースおよび役割に対してのみ行われます。

配賦の置換

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

配賦を作成または更新する

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

配賦コメント一覧の取得

配賦コメントのリストを返します。

ID で Get Milestones を取得する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

マイルストーン ID
milestoneId True string

内部で使用する Milestone 識別子

戻り値

マイルストーン
MilestoneResponse

ID でカレンダーを取得する

Meisterplan システムのカレンダーをひとつ取得する。 デフォルトのカレンダーを取得するには、特別な ID defaultCalendar を使用します。

パラメーター

名前 キー 必須 説明
カレンダー ID
calendarId True string

内部で使用する Milestone 識別子

戻り値

Calendar
CalendarResponse

ID でシナリオを取得する

指定された ID で個別のシナリオを返します。 ヒント: PlanOfRecord シナリオの ID として "planOfRecord" を使用できます。

パラメーター

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

内部で使用する Milestone 識別子

戻り値

シナリオ
ScenarioResponse

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

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

Comment Id
commentId True string

内部で使用する Milestone 識別子

戻り値

プロジェクト コメント
ProjectCommentResponse

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

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

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

ID でユーザーを取得

ユーザーを返します。

パラメーター

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

内部で使用する Milestone 識別子

戻り値

ID でリソースを取得する

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

パラメーター

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

内部で使用する Milestone 識別子

戻り値

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

ID でロールを取得する

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

パラメーター

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

内部で使用する Milestone 識別子

戻り値

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

ID で不在を取得する

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

パラメーター

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

内部で使用する Milestone 識別子

不在 Id
absenceId True string

内部で使用する Milestone 識別子

戻り値

ID で財務を取得する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

財務 Id
financialsId True string

内部で使用する Milestone 識別子

戻り値

ID で配賦を取得する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

配賦 ID
allocationId True string

内部で使用する Milestone 識別子

戻り値

ID によって OBS タイプを取得します

このエンドポイントは OBS タイプ専用です。 OBS ユニットを取得するには、/obsTypes//obsUnits を使用します

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

戻り値

観測タイプ
ObsTypeResponse

ID による OBS タイプの削除

指定された ID で指定された OBS タイプを削除します。 指定された ID を持つ OBS タイプが存在しない場合、リクエストは失敗します。

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

ID による OBS ユニットの削除

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

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

観測ユニット Id
obsUnitId True string

内部で使用する Milestone 識別子

ID による実際の金融イベントの取得

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

財務実績 Id
actualFinancialEventId True string

内部で使用する Milestone 識別子

戻り値

ID による配賦コメントの取得

配賦コメントを返します。

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

配賦コメント ID
allocationCommentId True string

内部で使用する Milestone 識別子

戻り値

配賦コメント
AllocationCommentResponse

Milestone の依存関係の削除

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

パラメーター

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

内部で使用する Milestone 識別子

マイルストーン依存性 Id
milestoneDependencyId True string

内部で使用する Milestone 識別子

Milestone の依存関係を作成する

新しく作成されたスタッフオンライン プレゼンスの ID

パラメーター

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

内部で使用する Milestone 識別子

マイルストーン ID から
fromMilestoneId True string
マイルストーン ID へ
toMilestoneId True string

戻り値

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

Milestone 依存関係のリストを取得する

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

パラメーター

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

内部で使用する Milestone 識別子

ページ サイズ
pageSize integer

ページ サイズ

後のページ
pageAfter string

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

戻り値

Milestones のリストの取得

プロジェクトのマイルストーンのリストを返す

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

Milestones の削除

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

マイルストーン ID
milestoneId True string

内部で使用する Milestone 識別子

Milestones の置換

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

件名
name True string
date True string

形式 YYYY-MM-DD

件名
name string

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

Milestones を更新する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

マイルストーン ID
milestoneId True string

内部で使用する Milestone 識別子

件名
name string
date string

形式 YYYY-MM-DD

件名
name string

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

戻り値

マイルストーン
MilestoneResponse

OBS タイプの作成

指定されたデータで OBS タイプを作成します。 新しく作成された OBS タイプを返します。

パラメーター

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

戻り値

観測タイプ
ObsTypeResponse

OBS タイプの更新

指定された ID で指定された OBS タイプで更新を実行します。

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

件名
name True string

戻り値

観測タイプ
ObsTypeResponse

OBS ユニットの作成

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

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

件名
name True string
Parent ID
parentId string

戻り値

観測ユニット
ObsUnitResponse

OBS ユニットの更新

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

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

観測ユニット Id
obsUnitId True string

内部で使用する Milestone 識別子

件名
name string
Parent ID
parentId string

戻り値

観測ユニット
ObsUnitResponse

OBS ユニットを取得する

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

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

観測ユニット Id
obsUnitId True string

内部で使用する Milestone 識別子

戻り値

観測ユニット
ObsUnitResponse

すべての OBS タイプを取得する

このエンドポイントは OBS タイプ専用です。 OBS ユニットを取得するには、/obsTypes//obsUnits を使用します

戻り値

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

この エンドポイント は、指定された OBS タイプのすべての OBS ユニットのリストを返します。

パラメーター

名前 キー 必須 説明
観測タイプ Id
obsTypeId True string

内部で使用する Milestone 識別子

戻り値

すべてのロールのキャパシティ セグメントの取得

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

パラメーター

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

内部で使用する Milestone 識別子

戻り値

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

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

パラメーター

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

内部で使用する Milestone 識別子

先頭
start date

フィルタリング期間の開始日

終了
finish date

フィルタリング期間の終了日

戻り値

カレンダーから偏差を更新する

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

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

すべての偏差は、順次構造にフラット化されます。 重複する偏差のケースは、アレイ内で後で発生する偏差を優先することで解決されます。

パラメーター

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

内部で使用する Milestone 識別子

先頭
start date
終了
finish date
先頭
start date
終了
finish date
相対容量
relativeCapacity True double

戻り値

カレンダーのリストを取得する

Meisterplan システムですべてのカレンダーのリストを取得します。

戻り値

カレンダーの作成

指定されたデータでカレンダーを作成します。 新しく作成されたカレンダーを返します。

パラメーター

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

戻り値

Calendar
CalendarResponse

カレンダーの例外のリストを取得する

Meisterplan システムでこのカレンダーのすべての例外のリストを取得します。

パラメーター

名前 キー 必須 説明
カレンダー ID
calendarId True string

内部で使用する Milestone 識別子

Start Date
startDate date

Start Date

終了日付
endDate date

終了日付

戻り値

カレンダーの削除

Meisterplan システムのカレンダーを削除します。 デフォルトのカレンダーまたはデフォルトのカレンダーの親は削除できないことに注意してください。

パラメーター

名前 キー 必須 説明
カレンダー ID
calendarId True string

内部で使用する Milestone 識別子

カレンダーの更新

指定された ID で指定されたカレンダーで更新を実行します。

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 説明
カレンダー ID
calendarId True string

内部で使用する Milestone 識別子

件名
name string
月曜日
monday True double
火曜日
tuesday True double
水曜日
wednesday True double
木曜日
thursday True double
金曜日
friday True double
土曜日
saturday True double
日曜日
sunday True double

戻り値

Calendar
CalendarResponse

カレンダー更新の例外

このリクエストを使用して、特定の期間のすべてのカレンダーの例外を置き換えます。 この期間は、リクエストのルートの開始および終了属性を使用して定義できます。 exceptions プロパティを使用して、カレンダーの例外の新しいリストを指定します。 指定された期間のすべての例外は、例外プロパティにリストされた例外によって上書きされることに注意してください。

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

パラメーター

名前 キー 必須 説明
カレンダー ID
calendarId True string

内部で使用する Milestone 識別子

先頭
start date
終了
finish date
date True date
作業時間
workingHours True double
プロパティ
description string

シナリオのリストを取得する

シナリオのリストを返します

戻り値

デフォルトのカレンダーを設定する

既存のカレンダーを Meisterplan システムのデフォルト カレンダーとして設定します。

パラメーター

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

ビジネス目標

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

戻り値

プログラムのリストを取得する

指定したシナリオのプログラムのリストを返します

パラメーター

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

内部で使用する Milestone 識別子

戻り値

プログラムの作成

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

パラメーター

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

内部で使用する Milestone 識別子

件名
name True string

戻り値

プログラム
ProgramResponse

プログラムの削除

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

パラメーター

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

内部で使用する Milestone 識別子

プログラム ID
programId True string

内部で使用する Milestone 識別子

プログラムの更新

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

パラメーター

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

内部で使用する Milestone 識別子

プログラム ID
programId True string

内部で使用する Milestone 識別子

件名
name string

戻り値

プログラム
ProgramResponse

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

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

パラメーター

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

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

ページ サイズ
pageSize integer

ページ サイズ

シナリオ ID
scenarioId True string

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

プロジェクトのリストを取得する

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

パラメーター

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

内部で使用する Milestone 識別子

ページ サイズ
pageSize integer

ページ サイズ

後のページ
pageAfter string

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

フィルター
filter string

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

戻り値

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

プロジェクトの作成

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

パラメーター

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

内部で使用する Milestone 識別子

Payload
payload True dynamic

JSON ドキュメントで表されているプロジェクト。

戻り値

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

プロジェクトの削除

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

プロジェクトの更新

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

Payload
payload True dynamic

JSON ドキュメントで表されているプロジェクト。

戻り値

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

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

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

戻り値

マイルストーンの作成

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

件名
name True string
date True string

形式 YYYY-MM-DD

件名
name string

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

戻り値

マイルストーン
MilestoneResponse

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

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

パラメーター

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

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

ページ サイズ
pageSize integer

ページ サイズ

フィルター
filter string

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

戻り値

リソースのリストの取得

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

パラメーター

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

ページ サイズ

後のページ
pageAfter string

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

フィルター
filter string

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

戻り値

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

リソースの作成

指定されたフィールドでリソースを作成し、新しく作成されたものを返します。

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 説明
Payload
payload True dynamic

JSON ドキュメントで表されているリソース。

戻り値

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

リソースの削除

指定された ID で指定されたリソースを削除します。 指定された ID を持つリソースが存在しない場合、リクエストは失敗します。

パラメーター

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

内部で使用する Milestone 識別子

リソースの更新

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

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

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

内部で使用する Milestone 識別子

Payload
payload True dynamic

JSON ドキュメントで表されているリソース。

戻り値

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

ロールのリストを取得する

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

パラメーター

名前 キー 必須 説明
フィルター
filter string

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

戻り値

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

ロールの作成

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

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

名前 キー 必須 説明
Payload
payload True dynamic

JSON ドキュメントで表されているロール。

戻り値

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

ロールの削除

指定された ID で指定されたロールを削除します。 指定された ID を持つロールが存在しない場合、リクエストは失敗します。

パラメーター

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

内部で使用する Milestone 識別子

ロールの更新

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

パス

/ で区切られたパス (カレンダーや OBS ユニット パスなど) は、// でエスケープすることにより、/ を含むパス セグメントを定義できます。 E.g. パス Europe/Berlin//Amsterdam は ['Europe', 'Berlin/Amsterdam'] と解釈されます。 不均等な量のスラッシュは、1 つ以上のスラッシュで始まる次のセグメントとして解釈されます。

パラメーター

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

内部で使用する Milestone 識別子

Payload
payload True dynamic

JSON ドキュメントで表されているロール。

戻り値

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

不在の一覧の取得

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

パラメーター

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

内部で使用する Milestone 識別子

Start Date
startDate date

フィルタリング期間の開始日

終了日
finishDate date

当日を含むフィルタリング期間の終了日。

戻り値

不在の作成

このリクエストを使用して、特定の期間の不在を追加します。 この期間は、リクエストの開始および終了属性を使用して定義できます。

パラメーター

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

内部で使用する Milestone 識別子

先頭
start True string

形式 YYYY-MM-DD

終了
finish True string

形式 YYYY-MM-DD

開始日の種類
startDayType string

既定値は FULL_DAY です

終了日の種類
finishDayType string

既定値は FULL_DAY です

戻り値

不在の削除

不在を削除します。

パラメーター

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

内部で使用する Milestone 識別子

不在 Id
absenceId True string

内部で使用する Milestone 識別子

不在の更新

この要求を使用して不在を更新します。

パラメーター

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

内部で使用する Milestone 識別子

不在 Id
absenceId True string

内部で使用する Milestone 識別子

先頭
start string

形式 YYYY-MM-DD

終了
finish string

形式 YYYY-MM-DD

開始日の種類
startDayType string
終了日の種類
finishDayType string

戻り値

不在の置換

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

パラメーター

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

内部で使用する Milestone 識別子

先頭
start date

交換期間の開始日

末尾
end date

交換期間の終了日を含みます。

先頭
start True string

形式 YYYY-MM-DD

終了
finish True string

形式 YYYY-MM-DD

開始日の種類
startDayType string

既定値は FULL_DAY です

終了日の種類
finishDayType string

既定値は FULL_DAY です

優先度の更新

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

パラメーター

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

内部で使用する Milestone 識別子

ID
id True string

id 値はプロジェクトまたはプログラムです。

Position
position string

位置は FIRST または LAST です。 FIRST はデフォルトです

ID
id True string

id 値はプロジェクトまたはプログラムです。

Position
position string

位置は FIRST または LAST です。 FIRST はデフォルトです

ID
id True string

id 値はプロジェクトまたはプログラムです。

Position
position string

位置は FIRST または LAST です。 FIRST はデフォルトです

実労働時間のリストを取得する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

ページ サイズ
pageSize integer

ページ サイズ

後のページ
pageAfter string

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

フィルター
filter string

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

戻り値

実労働時間の作成または更新

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

ID
id True string

この実労働時間がエントリーしたエンティティの ID がリンクされています。 代わりに、タイプを RESOLVE_BY_KEY_OR_NAME に設定して、リソース キーまたはロール名を自動的に解決します。

タイプ
type string
予約日
bookingDate True date

この予約の日付

時間
hours True double

実労働時間

原価タイプ
costType string

デフォルト: Meisterplan の説明書を参照してください。

1 時間あたりの平均コスト
costPerHour double

この予約の 1 時間あたりの料金

Mode
mode string

戻り値

実際の労働時間
ActualTimeWorkedResponse

実労働時間の削除

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

実際の財務イベントの作成

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

タイプ
type True string
Amount
amount True double
予約日
bookingDate True date
プロパティ
description string
件名
name string

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

戻り値

実際の財務イベントの削除

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

財務実績 Id
actualFinancialEventId True string

内部で使用する Milestone 識別子

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

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

財務実績 Id
actualFinancialEventId True string

内部で使用する Milestone 識別子

タイプ
type string
Amount
amount double
予約日
bookingDate string

形式 YYYY-MM-DD

プロパティ
description string
件名
name string

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

戻り値

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

シナリオ内で、指定されたプロジェクトの実際の財務イベントを置き換えます。 リクエストは、プロジェクトごとに実際の金融イベントが 5000 件に制限されています。

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

タイプ
type True string
Amount
amount True double
予約日
bookingDate True date
プロパティ
description string
件名
name string

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

実際の金融イベントのリストを入手する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

役割のキャパシティ セグメントの取得

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

パラメーター

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

内部で使用する Milestone 識別子

ロール ID
roleId True string

内部で使用する Milestone 識別子

戻り値

役割のキャパシティ セグメントの更新

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

パラメーター

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

内部で使用する Milestone 識別子

ロール ID
roleId True string

内部で使用する Milestone 識別子

start
start date
完了
finish date
fte
fte double

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

days double

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

時間
hours double

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

戻り値

財務のリストを取得する

プロジェクトの財務のリストを返します

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

財務の作成

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

タイプ
type True string
Amount
amount True double
次の日付と等しい
on True string

Milestone は、milestoneId フィールドの値と組み合わせた場合にのみ有効です。 日付は、フィールド dueDate の値と組み合わせた場合にのみ有効です。

マイルストーン ID
milestoneId string

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

期限
dueDate string

on: Date (形式: YYYY-MM-DD) との組み合わせでのみ有効です。

プロパティ
description string
件名
name string

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

戻り値

財務の削除

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

財務 Id
financialsId True string

内部で使用する Milestone 識別子

財務の更新

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

財務 Id
financialsId True string

内部で使用する Milestone 識別子

タイプ
type string
Amount
amount double
次の日付と等しい
on True string

Milestone は、milestoneId フィールドの値と組み合わせた場合にのみ有効です。 日付は、フィールド dueDate の値と組み合わせた場合にのみ有効です。

マイルストーン ID
milestoneId string

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

期限
dueDate string

on: Date (形式: YYYY-MM-DD) との組み合わせでのみ有効です。

プロパティ
description string
件名
name string

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

戻り値

財務の置換

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

タイプ
type True string
Amount
amount True double
次の日付と等しい
on True string

Milestone は、milestoneId フィールドの値と組み合わせた場合にのみ有効です。 日付は、フィールド dueDate の値と組み合わせた場合にのみ有効です。

マイルストーン ID
milestoneId string

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

期限
dueDate string

on: Date (形式: YYYY-MM-DD) との組み合わせでのみ有効です。

プロパティ
description string
件名
name string

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

配賦のリストを取得する

プロジェクトの配賦のリストを返す

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

配賦の削除

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

配賦 ID
allocationId True string

内部で使用する Milestone 識別子

配賦の更新

このエンドポイントを使用すると、プロジェクトの既存の配賦を更新することができます。 変更は、指定された日付範囲と、指定されたリソースおよび役割に対してのみ行われます。

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

配賦 ID
allocationId True string

内部で使用する Milestone 識別子

先頭
start True date
終了
finish True date
フルタイム当量
fte double

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

日数
days double

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

時間
hours double

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

戻り値

配賦の置換

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

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 double

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

日数
days double

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

時間
hours double

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

配賦を作成または更新する

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

パラメーター

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

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

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 double

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

日数
days double

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

時間
hours double

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

戻り値

配賦コメント一覧の取得

配賦コメントのリストを返します。

パラメーター

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

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

ページ サイズ
pageSize integer

ページ サイズ

シナリオ ID
scenarioId True string

内部で使用する Milestone 識別子

プロジェクト ID
projectId True string

内部で使用する Milestone 識別子

戻り値

トリガー

ウェブフックの作成

指定されたフィールドでウェブフックを作成し、新しく作成されたものを返します。 現在、システムごとに 1000 のウェブフックがサポートされています。

ウェブフックの作成

指定されたフィールドでウェブフックを作成し、新しく作成されたものを返します。 現在、システムごとに 1000 のウェブフックがサポートされています。

パラメーター

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

少なくとも 1 つのイベントの種類を指定する必要があります。

シナリオ ID
scenarioId True string

登録するシナリオ。

会社 ID
projectId string

projectId は任意です。 特定のプロジェクトに登録する場合にのみ必要です。

戻り値

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

定義

UserRefResponse

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

ListResponseRoleCapacityResponse

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

RoleCapacityResponse

名前 パス 説明
start
start date

このロールのキャパシティ セグメントの開始日。 オプション。

完了
finish date

このロールのキャパシティ セグメントの終了日。 オプション。

fte
fte double

FTE でのロールのキャパシティ

MilestoneResponse

名前 パス 説明
ID
id string
件名
name string
date string

形式 YYYY-MM-DD

プロジェクト フェーズ
projectPhase ProjectPhaseResponse

ProjectPhaseResponse

名前 パス 説明
件名
name string

FinanceCategoryResponse

名前 パス 説明
件名
name string

FinancialsResponse

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

FinancialsTimingResponse

名前 パス 説明
次の日付と等しい
on string
マイルストーン ID
milestoneId string

タイミング タイプがマイルストーンと等しい場合にのみ存在

期限
dueDate date

FinancialActualsResponse

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

形式 YYYY-MM-DD

プロパティ
description string
財務カテゴリ
category FinanceCategoryResponse

AllocatedEntityResponse

名前 パス 説明
ID
id string

この配賦がリンクされているエンティティの ID

タイプ
type string

この配賦のエンティティ タイプ

プロジェクトのロール
projectRole string

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

AllocationResponse

名前 パス 説明
ID
id string

この割り当ての ID

割り当てられたエンティティ
allocatedEntity AllocatedEntityResponse
Segments
segments array of AllocationSegmentResponse

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

AllocationSegmentResponse

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

名前 パス 説明
先頭
start date

この配賦の開始日

終了
finish date

この割り当ての終了日

時間
hours double

配賦時間 (時)

ActualTimeWorkedResponse

名前 パス 説明
実績エンティティ リンク
bookedEntity ActualsEntityLinkResponse
予約
bookings array of ActualsBookingResponse

この実労働時間エントリの記帳日と時間

ActualsBookingResponse

この実労働時間エントリの記帳日と時間

名前 パス 説明
予約日
bookingDate date

この実労働時間エントリの予約日

時間
hours double

実労働時間

原価タイプ
costType string
1 時間あたりの平均コスト
costPerHour double

ActualsEntityLinkResponse

名前 パス 説明
ID
id string

この実労働時間エントリーがリンクされたエンティティの ID

タイプ
type string

この実労働時間エントリのエンティティ タイプ

ProgramResponse

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

MilestoneDependencyCreateResponse

名前 パス 説明
ID
id string

CalendarDeviationResponse

名前 パス 説明
先頭
start date
終了
finish date
相対容量
relativeCapacity double

リスト応答カレンダー偏差応答

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

AbsenceResponse

名前 パス 説明
ID
id string

不在の ID

Start Date
start date

この不在の開始日

終了日
finish date

この不在の終了日

不在開始日の種類
startDayType string
不在終了日の種類
finishDayType string

ObsTypeResponse

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

ObsUnitResponse

名前 パス 説明
ID
id string
件名
name string
Path
path string
Display Name
displayName string

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

Parent ID
parentId string

CalendarResponse

名前 パス 説明
ID
id string
件名
name string
Parent ID
parentId string
Path
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

名前 パス 説明
Group ID
id string

ユーザー グループの ID です。

グループ名
name string

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

LinkedResourceResponse

名前 パス 説明
ID
id string

リンクされたリソースの一意の ID です。

リソース キー
resourceKey string

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

PaginatedResponseUserResponse

名前 パス 説明
アイテム
items array of UserResponse
ページ区切り
_pagination Pagination

UserResponse

名前 パス 説明
ID
id string
Username
userName string
External ID
externalId string
アクティブです
active boolean
emailAddress
emailAddress string
Last Name
lastName string
First Name
firstName string
Display Name
displayName string
Locale
locale string
groups
groups array of BasicUserGroupResponse
Last Login
lastLogin date-time
メールアドレス検証済み
emailVerified boolean
リンクされたリソース
linkedResource LinkedResourceResponse
パスワードの有効期限なし
passwordNeverExpires boolean

ListResponseScenarioResponse

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

ScenarioResponse

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

ListResponseRoleWithRoleCapacityResponse

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

RoleWithRoleCapacityResponse

名前 パス 説明
roleId
roleId string

ロールの ID。

セグメント
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 string
ユーザー参照
author UserRefResponse
作成日
createdDate string
メンション
mentions array of UserRefResponse

ListResponseAllocationResponse

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

AllocationCommentEntityResponse

名前 パス 説明
ID
id string

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

タイプ
type string

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

AllocationCommentResponse

名前 パス 説明
ID
id string
コンテンツ
content string
ユーザー参照
author UserRefResponse
作成日
createdDate string
メンション
mentions array of UserRefResponse
割り当てられたエンティティ
allocatedEntity AllocationCommentEntityResponse

PaginatedResponseAllocationCommentResponse

名前 パス 説明
アイテム
items array of AllocationCommentResponse
ページ区切り
_pagination Pagination

PaginatedResponseActualTimeWorkedResponse

名前 パス 説明
アイテム
items array of ActualTimeWorkedResponse
ページ区切り
_pagination Pagination

ListResponseProgramResponse

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

MilestoneDependencyResponse

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

MilestoneReferenceResponse

名前 パス 説明
会社 ID
projectId string
マイルストーン ID
milestoneId string

PaginatedResponseMilestoneDependencyResponse

名前 パス 説明
アイテム
items array of MilestoneDependencyResponse
ページ区切り
_pagination Pagination

リスト応答不在応答

名前 パス 説明
アイテム
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 string
ソースのカレンダー ID
sourceCalendarId string

ListResponseCalendarExceptionResponse

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

BusinessGoalDefinitionResponse

名前 パス 説明
件名
name string

ListResponseBusinessGoalDefinitionResponse

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