共用方式為


大師計劃

Meisterplan 是一種投資組合級資源管理工具,可幫助投資組合和資源經理跨團隊和計劃管理人員,無論您的工作是傳統、敏捷還是混合。 使用它來做出自信的投資組合決策,並以互動方式顯示和解決資源衝突。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 Meisterplan 支持
URL https://help.meisterplan.com/
Email support@meisterplan.com
連接器中繼資料
Publisher itdesign 有限公司
網站 https://meisterplan.com
隱私策略 https://meisterplan.com/privacy-and-data-protection/
類別 商業管理;商業智慧

Meisterplan 是一種投資組合級資源管理工具,可幫助投資組合和資源經理跨團隊和計劃管理人員,無論您的工作是傳統、敏捷還是混合。 使用它來做出自信的投資組合決策,並以互動方式顯示和解決資源衝突。 查看資源可用性和容量,了解專案,確定專案組合的優先順序並使其與策略保持一致,並使用 Meisterplan 產生即時場景模擬。 通過使用 Meisterplan 連接器,您可以將 Meisterplan 與您的團隊使用的所有工具集成,這樣就沒有人需要對項目數據進行雙重維護。 無論您需要更新專案還是提出批准的休假請求,Meisterplan 和 Meisterplan 連接器都可以使流程無縫銜接。

先決條件

要使用 Meisterplan 連接器,您需要一個 Meisterplan 帳戶。 要開始使用 Meisterplan,請 請求演示試用

如何取得認證

使用 Meisterplan 連接器時,會彈出一個登入對話框,要求您選擇 Meisterplan 系統所在的地區(美國或歐盟)。 接下來,輸入您的 Meisterplan 憑證,即使用者名稱和密碼,然後按一下 登入。 然後,點擊 授權以 允許連接器存取您的 Meisterplan 系統。

開始使用連接器

常見的使用案例包括:

  • 更新項目信息:如果您在項目管理工具(例如 Trello)中對項目進行更改,例如更新狀態,Meisterplan 中的相應項目將自動更新。
  • 同步分配:如果您在 MS Excel 等線上電子表格中編輯分配,Meisterplan 中的相應分配會自動更新。
  • 使您的資源缺勤保持最新:如果您在 Excel 等在線電子表格中批准了一名員工的休假請求,則 Meisterplan 中相應的資源條目會自動更新。
  • 新項目添加到 Meisterplan:如果您在其中一個工具中添加新項目,則會在 Meisterplan 中自動創建一個新項目。
  • 將新資源添加到 Meisterplan:如果您用新員工更新您的在線電子表格,他們會自動添加到 Meisterplan 的資源池中。
  • 定期更新員工數據:如果您在線上電子表格中更改資源地址,Meisterplan 中相應的資源條目會自動更新。
  • 連接到 Microsoft Teams:如果專案在 Meisterplan 中更新,您將在配置的 Teams 頻道中收到通知。 此通知可以配置為在 Meisterplan 中包含指向專案的鏈接,以便您可以快速開啟專案以獲取更多詳細資訊。
  • 連接到您的 MS Office: 如果在 Meisterplan 中添加新項目,指定的同事將收到電子郵件通知。 您也可以設定流程,將新專案新增至 MS Office 中的外部備份來源。

已知問題與限制

  • 目前沒有已知的限制或限制。 有關速率限制、分頁等的一般資訊可以在 REST API 文件中找到。

常見錯誤和補救措施

Meisterplan 連接器使用 Meisterplan REST API。 您可以在 REST API 文件中找到包含狀態碼的描述。 如需其他資訊,請參閱 說明中心

FAQ

  • 我需要哪些 Meisterplan 使用者權限才能使用連接器?

    • 您的 Meisterplan 用戶需要擁有 訪問 Meisterplan API 和連接外部應用程序的 權限。
    • 您的 Meisterplan 用戶需要擁有要使用連接器讀取或更新的字段的讀取和編輯權限。
  • 我可以將連接器與 Meisterplan 基本版一起使用嗎?

    • 是的,所有 Meisterplan 版本都支援該連接器。 某些操作僅適用於 Meisterplan Pro-Edition 或高級版。

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
區域 字串 託管的 Meisterplan 系統區域

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

依 ID 取得使用者

傳回使用者。

依 ID 取得分配

傳回指定識別碼所指定的個別配置。

依 ID 取得分配註解

傳回配置註解。

依 ID 取得專案

傳回指定 ID 所指定的個別專案。

依 ID 取得專案註解

傳回專案註解。

依 ID 取得案例

傳回指定識別碼所指定的個別案例。 提示:您可以使用 “planOfRecord” 作為記錄計劃案例的識別碼。

依 ID 取得資源

傳回指定識別碼所指定的個別資源。

依識別碼取得角色

傳回指定 ID 所指定的個別角色。

刪除 ID 的實際工作時間

刪除案例指定專案中的實際工作時間。

刪除任務

刪除指定專案中的任務。

刪除任務管理鏈接

刪除專案的任務管理連結

刪除分配

刪除案例指定專案中的配置。

刪除團隊

刪除指定 ID 指定的團隊。 如果具有指定 ID 的團隊不存在,則要求會失敗。

刪除實際財務事件

刪除案例指定專案中的實際財務事件。

刪除專案

刪除指定案例中的專案。

刪除所有按專案 ID 的實際工作時間

刪除給定專案的所有實際工作時間。

刪除程序

刪除指定 ID 所指定的程式。

刪除缺勤

刪除缺勤。

刪除行事曆

刪除 Meisterplan 系統中的日曆。 請注意,無法刪除預設行事曆或預設行事曆的父項。

刪除角色

刪除指定 ID 所指定的角色。 如果具有指定 ID 的角色不存在,則要求將會失敗。

刪除財務

刪除案例指定專案中的財務事件。

刪除資源

刪除指定 ID 所指定的資源。 如果具有指定 ID 的資源不存在,則要求會失敗。

刪除里程碑

刪除案例指定專案中的里程碑。

刪除里程碑相依性

刪除指定案例中的里程碑相依性。

創建OBS單元

使用給定資料建立 OBS 單元。 將傳回新建立的OBS單元。

取代分配

此端點可讓您取代專案的所有配置。 結果將與刪除所有現有分配並重新建立傳遞的分配相同。

取代實際財務事件

取代案例中指定專案的實際財務事件。 每個專案的請求限制為 5000 個實際財務事件。

取代工作

此端點可用來將特定專案的所有現有任務取代為請求中提供的新任務清單。 運作方式:您傳送特定專案的任務清單。 系統會利用任務金鑰作為識別碼,將專案的任務與此清單同步。 也就是說:

  • 目前在系統中但不在您的清單中的任務將被刪除。 - 將創建列表中系統中不存在的任務。 - 如果有變更,系統和清單中同時存在的任務將會更新。
取代缺勤

此端點可讓您取代資源的所有缺失。 結果將與刪除所有現有缺勤並重新建立已傳遞的缺勤相同。 您可以使用 'start' 和 'end' 查詢參數來指定取代現有缺勤的時間範圍。 如果您不使用這些參數,則所有缺勤都將由新發送的缺勤取代。

取代里程碑

取代案例中指定專案的里程碑。

取得任務清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的任務清單

取得任務管理連結

傳回專案的任務管理連結

取得使用者清單

傳回使用者清單。 允許依 userName 或 externalId 進行篩選。

取得分配清單

傳回專案的配置清單

取得團隊清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的小組清單

取得實際工作時間清單

傳回特定案例之所有專案的實際工作時間清單。 請注意,實際工作時間資料本身與其場景無關。

取得專案清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的專案清單

取得專案註解清單

傳回專案註解清單。

取得所有角色的產能區段

傳回所有角色的容量區段。 如果給定角色不存在容量區段,則其角色容量將是空的。

取得案例清單

它會傳回案例清單

取得缺勤清單

傳回資源缺失清單。

取得行事曆例外狀況清單

在您的 Meisterplan 系統中獲取此日曆的所有例外情況的列表。

取得行事曆清單

獲取 Meisterplan 系統中所有日曆的列表。

取得角色清單

傳回所有可用角色的清單。 如果沒有可用的角色,則會傳回空白清單。

取得角色的容量區段

傳回指定 ID 所指定角色的容量區段。 如果沒有容量區段存在,則傳回空白清單。

取得資源清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的資源清單

取得配置註解清單

傳回配置註解的清單。

取得里程碑清單

傳回專案里程碑清單

取得里程碑相依性清單

傳回案例的里程碑相依性清單

建立 OBS 類型

使用給定資料建立 OBS 類型。 將傳回新建立的OBS類型。

建立團隊

按給定欄位建立團隊並傳回新建立的團隊。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

建立實際財務事件

傳回新建立的實際財務事件。

建立專案

使用指定欄位建立專案,並傳回新建立的專案。

建立或更新任務

使用指定欄位建立或更新任務。

建立或更新任務管理連結

此端點可讓您將任務管理連結新增至專案或更新 externalViewUrl

建立或更新分配

此端點可讓您建立新的分配並更新專案的現有分配。 只會針對指定的日期範圍以及指定的資源和角色進行變更。

建立或更新實際工作時間

此端點可讓您建立新的實際工作時間,並更新實體 (資源或角色) 專案的現有實際工作時間。 我們不會更新指定專案和實體請求中未指定的預訂日期的實際工作時間。 使用 mode 屬性,您可以控制是否將現有的實際工作時間值替換為新值,或者是否將其值新增至請求中的預訂。 請注意,實際工作時間資料本身與其場景無關。 對於任何給定專案,在所有案例中都會相同。 每個專案和資源/角色的請求限制為 5000 個實際工作時間值。

建立程式

建立具有指定欄位的程式,並傳回新建立的程式。

建立缺勤

使用此請求來新增特定時段的缺勤。 可以使用請求的開始和完成屬性來定義此時段。

建立行事曆

使用給定數據創建日曆。 將傳回新建立的行事曆。

建立角色

成功時傳回建立的角色。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

建立財務資料

傳回新建立的財務事件。

建立資源

依指定欄位建立資源,並傳回新建立的資源。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

建立里程碑

傳回新建立的里程碑

建立里程碑相依性

傳回新建立里程碑相依性的 ID

從日曆中獲取偏差

讀取資源行事曆工作時間的偏差。 如果未傳遞開始和完成值,則會傳回所要求資源的所有偏差。 如果只通過start,則會傳回從此時間開始的所有偏差。 如果只通過 finish,則會傳回該點之前的所有偏差。

按 ID 刪除 OBS 單元

刪除指定 ID 指定的 OBS 單元。 如果具有指定 ID 的 OBS 單元不存在,則請求將失敗。

按 ID 刪除 OBS 類型

刪除指定 ID 指定的 OBS 類型。 如果具有指定 ID 的 OBS 類型不存在,則請求將失敗。

按 ID 獲取 OBS 類型

此端點僅適用於 OBS 類型。 若要取得 OBS 單位,請使用 /obsTypes/<obs-type-id>/obsUnits

按 ID 獲取任務

傳回指定識別碼所指定的個別工作。

按 ID 獲取實際工作時間

傳回指定 ID 所指定的個別實際工作時間。

更新 OBS 單元

更新單一 OBS 裝置的名稱或將其移至不同的父系。

更新 OBS 類型

對指定 ID 指定的 OBS 類型執行更新。

更新優先順序

此端點會更新專案和方案的優先順序。

更新分配

此端點可讓您更新專案的現有配置。 只會針對指定的日期範圍以及指定的資源和角色進行變更。

更新團隊

對指定ID指定的團隊執行更新。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

更新實際財務事件

傳回更新的實際財務事件。

更新專案

對指定 ID 指定的專案執行更新。

更新程序

對指定 ID 指定的程式執行更新。

更新缺勤

使用此請求來更新缺勤。

更新與行事曆的偏差

使用此要求來取代資源在特定時段內的所有行事曆偏差。 可以使用要求的根開始和完成屬性來定義此時段。 使用 deviations 屬性指定新的行事曆偏差清單。 請注意,指定期間內的所有偏差都會被偏差屬性中列出的偏差覆蓋。

  • 如果將 Null 用於開始期間和結束期間,則會改寫資源的所有行事曆偏差 - 如果只定義期間的開始日期,則會改寫從此時間開始的所有偏差 - 如果只定義期間的結束日期,則會改寫到該點之前的所有偏差 - 如果將 Null 用於行事曆偏差的開始和/或結束日期, 假設偏差會持續到上述根開始或完成日期為止。

所有偏差都會展平為循序結構。 重疊偏差的情況將通過優先於陣列中稍後發生的偏差來解決。

更新行事曆

對指定 ID 指定的行事曆執行更新。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

更新行事曆例外狀況

使用此要求來取代特定時段內的所有行事曆例外狀況。 可以使用要求的根開始和完成屬性來定義此時段。 使用 exceptions 屬性指定行事曆例外的新清單。 請注意,指定期間內的所有例外狀況都會被exceptions屬性中列出的例外狀況覆寫。

  • 如果將 null 用於開始期間和結束期間,則會改寫行事曆的所有例外狀況 - 如果只定義期間的開始日期,則會覆寫從此時間開始的所有例外狀況 - 如果只定義期間的結束日期,則會覆寫該點之前的所有例外狀況 - 如果移除例外狀況,且父行事曆在該日期有例外狀況, 此行事曆會繼承父行事曆的例外狀況。
更新角色

對指定ID所指定的角色執行更新。 若要執行部分更新,只需要傳送更新的欄位。 若要刪除欄位值,必須以明確的 Null 值傳送欄位。 當設定為 null 時,具有預設值的欄位將重設為預設值。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

更新角色的容量區段

更新指定 ID 所指定角色的容量區段。 若要清除所有容量區段,請傳送沒有開始或完成且容量為 0 的區段

更新財務狀況

依案例指定專案中的 ID 更新財務事件。

更新資源

對指定 ID 所指定的資源執行更新。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

更新里程碑

對指定ID指定的里程碑執行更新。

替換財務

取代案例中指定專案的財務事件。

業務目標

傳回所有業務目標

獲取 OBS 單元

此端點會傳回單一 OBS 裝置。

獲取實際財務事件列表

傳回專案實際財務事件的清單。

獲取所有 OBS 單元

此端點會傳回指定 OBS 類型的所有 OBS 裝置清單。

獲取所有 OBS 類型

此端點僅適用於 OBS 類型。 若要取得 OBS 單位,請使用 /obsTypes/<obs-type-id>/obsUnits

獲取投資組合列表

傳回所有可用投資組合的清單。 如果您無權檢視任何產品組合,則會傳回您有權透過API權杖存取的所有可用產品組合清單。 如果您無權查看任何投資組合,則將返回一個空列表。

獲取程序列表

傳回指定案例中的程式清單

獲取財務清單

傳回專案的財務清單

設定預設行事曆

將現有日曆設置為 Meisterplan 系統中的默認日曆。

透過身分證件取得缺勤

傳回指定 ID 所指定的個別缺勤。

通過 ID 獲取 Sprint

傳回指定識別碼所指定的個別短期衝刺。

通過 ID 獲取團隊

傳回指定 ID 所指定的個別小組。

通過 ID 獲取實際財務事件

傳回指定 ID 所指定的個別實際財務事件。

通過 ID 獲取日曆

在您的 Meisterplan 系統中獲取一個日曆。 使用特殊 ID defaultCalendar 來取得預設行事曆。

通過 ID 獲取程序

傳回指定識別碼所指定的個別程式。

通過 ID 獲取財務信息

傳回指定 ID 所指定的個別財務事件。

通過 ID 獲取里程碑

傳回指定ID所指定的個別里程碑。

依 ID 取得使用者

傳回使用者。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
userId True string

內部 Meisterplan 標識符

傳回

依 ID 取得分配

傳回指定識別碼所指定的個別配置。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

配置識別碼
allocationId True string

內部 Meisterplan 標識符

傳回

依 ID 取得分配註解

傳回配置註解。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

配置註解識別碼
allocationCommentId True string

內部 Meisterplan 標識符

傳回

依 ID 取得專案

傳回指定 ID 所指定的個別專案。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

依 ID 取得專案註解

傳回專案註解。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

註解 ID
commentId True string

內部 Meisterplan 標識符

傳回

項目評論
ProjectCommentResponse

依 ID 取得案例

傳回指定識別碼所指定的個別案例。 提示:您可以使用 “planOfRecord” 作為記錄計劃案例的識別碼。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

傳回

Scenario
ScenarioResponse

依 ID 取得資源

傳回指定識別碼所指定的個別資源。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

依識別碼取得角色

傳回指定 ID 所指定的個別角色。

參數

名稱 機碼 必要 類型 Description
角色識別碼
roleId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

刪除 ID 的實際工作時間

刪除案例指定專案中的實際工作時間。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

實際值 ID
actualsId True string

內部 Meisterplan 標識符

刪除任務

刪除指定專案中的任務。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

任務標識符
taskId True string

內部 Meisterplan 標識符

刪除任務管理鏈接

刪除專案的任務管理連結

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

刪除分配

刪除案例指定專案中的配置。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

配置識別碼
allocationId True string

內部 Meisterplan 標識符

刪除團隊

刪除指定 ID 指定的團隊。 如果具有指定 ID 的團隊不存在,則要求會失敗。

參數

名稱 機碼 必要 類型 Description
團隊 ID
teamId True string

內部 Meisterplan 標識符

刪除實際財務事件

刪除案例指定專案中的實際財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

財務實際值 ID
actualFinancialEventId True string

內部 Meisterplan 標識符

刪除專案

刪除指定案例中的專案。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

刪除所有按專案 ID 的實際工作時間

刪除給定專案的所有實際工作時間。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

刪除程序

刪除指定 ID 所指定的程式。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

程式識別碼
programId True string

內部 Meisterplan 標識符

刪除缺勤

刪除缺勤。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

缺勤標識碼
absenceId True string

內部 Meisterplan 標識符

刪除行事曆

刪除 Meisterplan 系統中的日曆。 請注意,無法刪除預設行事曆或預設行事曆的父項。

參數

名稱 機碼 必要 類型 Description
行事曆識別碼
calendarId True string

內部 Meisterplan 標識符

刪除角色

刪除指定 ID 所指定的角色。 如果具有指定 ID 的角色不存在,則要求將會失敗。

參數

名稱 機碼 必要 類型 Description
角色識別碼
roleId True string

內部 Meisterplan 標識符

刪除財務

刪除案例指定專案中的財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

財務 ID
financialsId True string

內部 Meisterplan 標識符

刪除資源

刪除指定 ID 所指定的資源。 如果具有指定 ID 的資源不存在,則要求會失敗。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

刪除里程碑

刪除案例指定專案中的里程碑。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

里程碑標識符
milestoneId True string

內部 Meisterplan 標識符

刪除里程碑相依性

刪除指定案例中的里程碑相依性。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

里程碑相依性識別碼
milestoneDependencyId True string

內部 Meisterplan 標識符

創建OBS單元

使用給定資料建立 OBS 單元。 將傳回新建立的OBS單元。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

名稱
name True string
父 ID
parentId string

傳回

觀察單位
ObsUnitResponse

取代分配

此端點可讓您取代專案的所有配置。 結果將與刪除所有現有分配並重新建立傳遞的分配相同。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

ID
id True string

此配置所連結之實體的識別碼。 將類型設定為RESOLVE_BY_KEY_OR_NAME,以自動解析資源索引鍵或角色名稱。

類型
type string

控制如何解譯欄位 ID 中的值。 RESOURCE 會依 UUID 解析資源。 ROLE 會依 UUID 解析角色。 RESOLVE_BY_KEY_OR_NAME會依資源索引鍵解析資源,或依角色名稱解析角色。

項目角色
projectRole string

此配置連結到的角色識別碼。 此欄位僅與 RESOURCE 或 RESOLVE_BY_KEY_OR_NAME 類型結合使用時有效。 如果 type 設定為 RESOLVE_BY_KEY_OR_NAME,則會依名稱解析 projectRole。

開始
start True date
結束
finish True date
弗特
fte double

請求接受 FTE、小時或天。

days double

請求接受 FTE、小時或天。

小時
hours double

請求接受 FTE、小時或天。

取代實際財務事件

取代案例中指定專案的實際財務事件。 每個專案的請求限制為 5000 個實際財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

類型
type True string
總數
amount True double
預訂日期
bookingDate True date
Description
description string
名稱
name string

財務類別必須在建立之前就已存在。 它不會被隱含地創建。

取代工作

此端點可用來將特定專案的所有現有任務取代為請求中提供的新任務清單。 運作方式:您傳送特定專案的任務清單。 系統會利用任務金鑰作為識別碼,將專案的任務與此清單同步。 也就是說:

  • 目前在系統中但不在您的清單中的任務將被刪除。 - 將創建列表中系統中不存在的任務。 - 如果有變更,系統和清單中同時存在的任務將會更新。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

工作取代要求
tasksReplaceRequest True dynamic

由 JSON 文件表示的任務。

取代缺勤

此端點可讓您取代資源的所有缺失。 結果將與刪除所有現有缺勤並重新建立已傳遞的缺勤相同。 您可以使用 'start' 和 'end' 查詢參數來指定取代現有缺勤的時間範圍。 如果您不使用這些參數,則所有缺勤都將由新發送的缺勤取代。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

開始
start date

更換期開始日期

結束
end date

包括更換期的結束日期。

開始
start True string

格式:YYYY-MM-DD

結束
finish True string

格式:YYYY-MM-DD

開始日期類型
startDayType string

預設值為FULL_DAY

完成日類型
finishDayType string

預設值為FULL_DAY

取代里程碑

取代案例中指定專案的里程碑。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

名稱
name True string
Date
date True string

格式:YYYY-MM-DD

名稱
name string

專案階段必須在建立之前存在。 它不會被隱含地創建。

價值觀
value string

取得任務清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的任務清單

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

Key
key string

選取與索引鍵完全相符的所有物件。

傳回

此作業會輸出隨機的結果。

取得任務管理連結

傳回專案的任務管理連結

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

取得使用者清單

傳回使用者清單。 允許依 userName 或 externalId 進行篩選。

參數

名稱 機碼 必要 類型 Description
之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

頁面大小
pageSize integer

頁面大小

Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。

傳回

取得分配清單

傳回專案的配置清單

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

取得團隊清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的小組清單

參數

名稱 機碼 必要 類型 Description
頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。 選取與指定性質完全相符的所有物件。 注意:請注意對參數進行 URL 編碼。 { “resourceKey”: 字串, “名稱”: 字串 }

傳回

此作業會輸出隨機的結果。

取得實際工作時間清單

傳回特定案例之所有專案的實際工作時間清單。 請注意,實際工作時間資料本身與其場景無關。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。

傳回

取得專案清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的專案清單

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。

傳回

此作業會輸出隨機的結果。

取得專案註解清單

傳回專案註解清單。

參數

名稱 機碼 必要 類型 Description
之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

頁面大小
pageSize integer

頁面大小

案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

取得所有角色的產能區段

傳回所有角色的容量區段。 如果給定角色不存在容量區段,則其角色容量將是空的。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

傳回

取得案例清單

它會傳回案例清單

傳回

取得缺勤清單

傳回資源缺失清單。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

開始日期
startDate date

篩選時段的開始日期

完成日期
finishDate date

篩選時段的包含完成日期。

傳回

取得行事曆例外狀況清單

在您的 Meisterplan 系統中獲取此日曆的所有例外情況的列表。

參數

名稱 機碼 必要 類型 Description
行事曆識別碼
calendarId True string

內部 Meisterplan 標識符

開始日期
startDate date

開始日期

結束日期
endDate date

結束日期

傳回

取得行事曆清單

獲取 Meisterplan 系統中所有日曆的列表。

傳回

取得角色清單

傳回所有可用角色的清單。 如果沒有可用的角色,則會傳回空白清單。

參數

名稱 機碼 必要 類型 Description
Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。

傳回

此作業會輸出隨機的結果。

取得角色的容量區段

傳回指定 ID 所指定角色的容量區段。 如果沒有容量區段存在,則傳回空白清單。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

角色識別碼
roleId True string

內部 Meisterplan 標識符

傳回

取得資源清單

此端點已分頁。 它會傳回最多指定 PAGESIZE 的資源清單

參數

名稱 機碼 必要 類型 Description
頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。

傳回

此作業會輸出隨機的結果。

取得配置註解清單

傳回配置註解的清單。

參數

名稱 機碼 必要 類型 Description
之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

頁面大小
pageSize integer

頁面大小

案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

取得里程碑清單

傳回專案里程碑清單

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

取得里程碑相依性清單

傳回案例的里程碑相依性清單

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

傳回

建立 OBS 類型

使用給定資料建立 OBS 類型。 將傳回新建立的OBS類型。

參數

名稱 機碼 必要 類型 Description
名稱
name True string

傳回

觀察類型
ObsTypeResponse

建立團隊

按給定欄位建立團隊並傳回新建立的團隊。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
承載
payload True dynamic

由 JSON 文件代表的團隊。

傳回

此作業會輸出隨機的結果。

建立實際財務事件

傳回新建立的實際財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

類型
type True string
總數
amount True double
預訂日期
bookingDate True date
Description
description string
名稱
name string

財務類別必須在建立之前就已存在。 它不會被隱含地創建。

傳回

財務實際值
FinancialActualsResponse

建立專案

使用指定欄位建立專案,並傳回新建立的專案。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

承載
payload True dynamic

專案由 JSON 文件表示。

傳回

此作業會輸出隨機的結果。

建立或更新任務

使用指定欄位建立或更新任務。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件表示的任務。

建立或更新任務管理連結

此端點可讓您將任務管理連結新增至專案或更新 externalViewUrl

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件表示的任務管理連結。

傳回

此作業會輸出隨機的結果。

建立或更新分配

此端點可讓您建立新的分配並更新專案的現有分配。 只會針對指定的日期範圍以及指定的資源和角色進行變更。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

ID
id True string

此配置所連結之實體的識別碼。 將類型設定為RESOLVE_BY_KEY_OR_NAME,以自動解析資源索引鍵或角色名稱。

類型
type string

控制如何解譯欄位 ID 中的值。 RESOURCE 會依 UUID 解析資源。 ROLE 會依 UUID 解析角色。 RESOLVE_BY_KEY_OR_NAME會依資源索引鍵解析資源,或依角色名稱解析角色。

項目角色
projectRole string

此配置連結到的角色識別碼。 此欄位僅與 RESOURCE 或 RESOLVE_BY_KEY_OR_NAME 類型結合使用時有效。 如果 type 設定為 RESOLVE_BY_KEY_OR_NAME,則會依名稱解析 projectRole。

開始
start True date
結束
finish True date
弗特
fte double

請求接受 FTE、小時或天。

days double

請求接受 FTE、小時或天。

小時
hours double

請求接受 FTE、小時或天。

傳回

建立或更新實際工作時間

此端點可讓您建立新的實際工作時間,並更新實體 (資源或角色) 專案的現有實際工作時間。 我們不會更新指定專案和實體請求中未指定的預訂日期的實際工作時間。 使用 mode 屬性,您可以控制是否將現有的實際工作時間值替換為新值,或者是否將其值新增至請求中的預訂。 請注意,實際工作時間資料本身與其場景無關。 對於任何給定專案,在所有案例中都會相同。 每個專案和資源/角色的請求限制為 5000 個實際工作時間值。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

ID
id True string

此實際工作時間項目連結至的實體識別碼。 將類型設定為RESOLVE_BY_KEY_OR_NAME,以自動解析資源和團隊金鑰或角色名稱。

類型
type string
團隊識別碼
teamId string

此實際工作時間項目連結之實體的團隊識別碼

預訂日期
bookingDate True date

此預訂日期

小時
hours True double

實際工作時間(以小時為單位)

成本類型
costType string

預設:請參閱 Meisterplan 文件。

每小時成本
costPerHour double

此預訂的每小時費用

Mode
mode string

傳回

實際工作時間
ActualTimeWorkedResponse

建立程式

建立具有指定欄位的程式,並傳回新建立的程式。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件表示的程式。

傳回

此作業會輸出隨機的結果。

建立缺勤

使用此請求來新增特定時段的缺勤。 可以使用請求的開始和完成屬性來定義此時段。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

開始
start True string

格式:YYYY-MM-DD

結束
finish True string

格式:YYYY-MM-DD

開始日期類型
startDayType string

預設值為FULL_DAY

完成日類型
finishDayType string

預設值為FULL_DAY

傳回

建立行事曆

使用給定數據創建日曆。 將傳回新建立的行事曆。

參數

名稱 機碼 必要 類型 Description
名稱
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

傳回

建立角色

成功時傳回建立的角色。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
承載
payload True dynamic

由 JSON 文件表示的角色。

傳回

此作業會輸出隨機的結果。

建立財務資料

傳回新建立的財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

類型
type True string
總數
amount True double
另一
on True string

里程碑僅與欄位 milestoneId 中的值結合使用時有效。 日期僅與 dueDate 欄位中的值結合使用時有效。

里程碑 ID
milestoneId string

僅與 on: 里程碑結合使用時有效。 里程碑必須存在於專案中。 它不會被隱含地創建。

到期日
dueDate string

僅與 on: Date (格式: YYYY-MM-DD) 結合使用時有效。

Description
description string
名稱
name string

財務類別必須在建立之前就已存在。 它不會被隱含地創建。

傳回

建立資源

依指定欄位建立資源,並傳回新建立的資源。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
承載
payload True dynamic

由 JSON 文件表示的資源。

傳回

此作業會輸出隨機的結果。

建立里程碑

傳回新建立的里程碑

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

名稱
name True string
Date
date True string

格式:YYYY-MM-DD

名稱
name string

專案階段必須在建立之前存在。 它不會被隱含地創建。

價值觀
value string

傳回

里程碑
MilestoneResponse

建立里程碑相依性

傳回新建立里程碑相依性的 ID

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

從里程碑 ID
fromMilestoneId True string
前往里程碑 ID
toMilestoneId True string

傳回

里程碑相依性建立
MilestoneDependencyCreateResponse

從日曆中獲取偏差

讀取資源行事曆工作時間的偏差。 如果未傳遞開始和完成值,則會傳回所要求資源的所有偏差。 如果只通過start,則會傳回從此時間開始的所有偏差。 如果只通過 finish,則會傳回該點之前的所有偏差。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

開始
start date

篩選時段的開始日期

結束
finish date

篩選時段的完成日期

傳回

按 ID 刪除 OBS 單元

刪除指定 ID 指定的 OBS 單元。 如果具有指定 ID 的 OBS 單元不存在,則請求將失敗。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

Obs 單位 ID
obsUnitId True string

內部 Meisterplan 標識符

按 ID 刪除 OBS 類型

刪除指定 ID 指定的 OBS 類型。 如果具有指定 ID 的 OBS 類型不存在,則請求將失敗。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

按 ID 獲取 OBS 類型

此端點僅適用於 OBS 類型。 若要取得 OBS 單位,請使用 /obsTypes/<obs-type-id>/obsUnits

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

傳回

觀察類型
ObsTypeResponse

按 ID 獲取任務

傳回指定識別碼所指定的個別工作。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

任務標識符
taskId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

按 ID 獲取實際工作時間

傳回指定 ID 所指定的個別實際工作時間。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

實際值 ID
actualsId True string

內部 Meisterplan 標識符

傳回

Id 的實際工作時間
ActualTimeWorkedByIdResponse

更新 OBS 單元

更新單一 OBS 裝置的名稱或將其移至不同的父系。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

Obs 單位 ID
obsUnitId True string

內部 Meisterplan 標識符

名稱
name string
父 ID
parentId string

傳回

觀察單位
ObsUnitResponse

更新 OBS 類型

對指定 ID 指定的 OBS 類型執行更新。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

名稱
name True string

傳回

觀察類型
ObsTypeResponse

更新優先順序

此端點會更新專案和方案的優先順序。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

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 是預設值

更新分配

此端點可讓您更新專案的現有配置。 只會針對指定的日期範圍以及指定的資源和角色進行變更。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

配置識別碼
allocationId True string

內部 Meisterplan 標識符

開始
start True date
結束
finish True date
弗特
fte double

請求接受 FTE、小時或天。

days double

請求接受 FTE、小時或天。

小時
hours double

請求接受 FTE、小時或天。

傳回

更新團隊

對指定ID指定的團隊執行更新。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
團隊 ID
teamId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件代表的團隊。

傳回

此作業會輸出隨機的結果。

更新實際財務事件

傳回更新的實際財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

財務實際值 ID
actualFinancialEventId True string

內部 Meisterplan 標識符

類型
type string
總數
amount double
預訂日期
bookingDate string

格式:YYYY-MM-DD

Description
description string
名稱
name string

財務類別必須在建立之前就已存在。 它不會被隱含地創建。

傳回

財務實際值
FinancialActualsResponse

更新專案

對指定 ID 指定的專案執行更新。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

承載
payload True dynamic

專案由 JSON 文件表示。

傳回

此作業會輸出隨機的結果。

更新程序

對指定 ID 指定的程式執行更新。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

程式識別碼
programId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件表示的程式。

傳回

此作業會輸出隨機的結果。

更新缺勤

使用此請求來更新缺勤。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

缺勤標識碼
absenceId True string

內部 Meisterplan 標識符

開始
start string

格式:YYYY-MM-DD

結束
finish string

格式:YYYY-MM-DD

開始日期類型
startDayType string
完成日類型
finishDayType string

傳回

更新與行事曆的偏差

使用此要求來取代資源在特定時段內的所有行事曆偏差。 可以使用要求的根開始和完成屬性來定義此時段。 使用 deviations 屬性指定新的行事曆偏差清單。 請注意,指定期間內的所有偏差都會被偏差屬性中列出的偏差覆蓋。

  • 如果將 Null 用於開始期間和結束期間,則會改寫資源的所有行事曆偏差 - 如果只定義期間的開始日期,則會改寫從此時間開始的所有偏差 - 如果只定義期間的結束日期,則會改寫到該點之前的所有偏差 - 如果將 Null 用於行事曆偏差的開始和/或結束日期, 假設偏差會持續到上述根開始或完成日期為止。

所有偏差都會展平為循序結構。 重疊偏差的情況將通過優先於陣列中稍後發生的偏差來解決。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

開始
start date
結束
finish date
開始
start date
結束
finish date
相對容量
relativeCapacity True double

傳回

更新行事曆

對指定 ID 指定的行事曆執行更新。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
行事曆識別碼
calendarId True string

內部 Meisterplan 標識符

名稱
name string
星期一
monday True double
星期二
tuesday True double
星期三
wednesday True double
星期四
thursday True double
星期五
friday True double
星期六
saturday True double
星期日
sunday True double

傳回

更新行事曆例外狀況

使用此要求來取代特定時段內的所有行事曆例外狀況。 可以使用要求的根開始和完成屬性來定義此時段。 使用 exceptions 屬性指定行事曆例外的新清單。 請注意,指定期間內的所有例外狀況都會被exceptions屬性中列出的例外狀況覆寫。

  • 如果將 null 用於開始期間和結束期間,則會改寫行事曆的所有例外狀況 - 如果只定義期間的開始日期,則會覆寫從此時間開始的所有例外狀況 - 如果只定義期間的結束日期,則會覆寫該點之前的所有例外狀況 - 如果移除例外狀況,且父行事曆在該日期有例外狀況, 此行事曆會繼承父行事曆的例外狀況。

參數

名稱 機碼 必要 類型 Description
行事曆識別碼
calendarId True string

內部 Meisterplan 標識符

開始
start date
結束
finish date
Date
date True date
工作時間
workingHours True double
Description
description string

更新角色

對指定ID所指定的角色執行更新。 若要執行部分更新,只需要傳送更新的欄位。 若要刪除欄位值,必須以明確的 Null 值傳送欄位。 當設定為 null 時,具有預設值的欄位將重設為預設值。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
角色識別碼
roleId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件表示的角色。

傳回

此作業會輸出隨機的結果。

更新角色的容量區段

更新指定 ID 所指定角色的容量區段。 若要清除所有容量區段,請傳送沒有開始或完成且容量為 0 的區段

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

角色識別碼
roleId True string

內部 Meisterplan 標識符

start
start date
finish date
FTE
fte double

請求接受 FTE、小時或天。

days double

請求接受 FTE、小時或天。

小時
hours double

請求接受 FTE、小時或天。

傳回

更新財務狀況

依案例指定專案中的 ID 更新財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

財務 ID
financialsId True string

內部 Meisterplan 標識符

類型
type string
總數
amount double
另一
on True string

里程碑僅與欄位 milestoneId 中的值結合使用時有效。 日期僅與 dueDate 欄位中的值結合使用時有效。

里程碑 ID
milestoneId string

僅與 on: 里程碑結合使用時有效。 里程碑必須存在於專案中。 它不會被隱含地創建。

到期日
dueDate string

僅與 on: Date (格式: YYYY-MM-DD) 結合使用時有效。

Description
description string
名稱
name string

財務類別必須在建立之前就已存在。 它不會被隱含地創建。

傳回

更新資源

對指定 ID 所指定的資源執行更新。

Paths

以 / 分隔的路徑(例如,在日曆和 OBS 單位路徑中)可以透過轉義來定義包含 / 的路徑段。 例如,路徑 Europe/Berlin//Amsterdam 將被解釋為 ['Europe', 'Berlin/Amsterdam']。 不均勻數量的斜線將被解釋為以一或多個斜線開頭的以下區段。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

承載
payload True dynamic

由 JSON 文件表示的資源。

傳回

此作業會輸出隨機的結果。

更新里程碑

對指定ID指定的里程碑執行更新。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

里程碑標識符
milestoneId True string

內部 Meisterplan 標識符

名稱
name string
Date
date string

格式:YYYY-MM-DD

名稱
name string

專案階段必須在建立之前存在。 它不會被隱含地創建。

價值觀
value string

傳回

里程碑
MilestoneResponse

替換財務

取代案例中指定專案的財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

類型
type True string
總數
amount True double
另一
on True string

里程碑僅與欄位 milestoneId 中的值結合使用時有效。 日期僅與 dueDate 欄位中的值結合使用時有效。

里程碑 ID
milestoneId string

僅與 on: 里程碑結合使用時有效。 里程碑必須存在於專案中。 它不會被隱含地創建。

到期日
dueDate string

僅與 on: Date (格式: YYYY-MM-DD) 結合使用時有效。

Description
description string
名稱
name string

財務類別必須在建立之前就已存在。 它不會被隱含地創建。

業務目標

傳回所有業務目標

傳回

獲取 OBS 單元

此端點會傳回單一 OBS 裝置。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

Obs 單位 ID
obsUnitId True string

內部 Meisterplan 標識符

傳回

觀察單位
ObsUnitResponse

獲取實際財務事件列表

傳回專案實際財務事件的清單。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

獲取所有 OBS 單元

此端點會傳回指定 OBS 類型的所有 OBS 裝置清單。

參數

名稱 機碼 必要 類型 Description
obs 類型 ID
obsTypeId True string

內部 Meisterplan 標識符

傳回

獲取所有 OBS 類型

此端點僅適用於 OBS 類型。 若要取得 OBS 單位,請使用 /obsTypes/<obs-type-id>/obsUnits

傳回

獲取投資組合列表

傳回所有可用投資組合的清單。 如果您無權檢視任何產品組合,則會傳回您有權透過API權杖存取的所有可用產品組合清單。 如果您無權查看任何投資組合,則將返回一個空列表。

傳回

獲取程序列表

傳回指定案例中的程式清單

參數

名稱 機碼 必要 類型 Description
頁面大小
pageSize integer

頁面大小

之後的頁面
pageAfter string

擷取結果的游標。 游標可以從先前的要求取得。

Filter
filter string

字串化 JSON 物件,其中包含預期物件的屬性子集。 選取與指定性質完全相符的所有物件。 程式可依 programKey 與名稱搜尋。 注意:請注意對參數進行 URL 編碼。 { “programKey”: 字串, “name”: string }

案例識別碼
scenarioId True string

內部 Meisterplan 標識符

傳回

獲取財務清單

傳回專案的財務清單

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

傳回

設定預設行事曆

將現有日曆設置為 Meisterplan 系統中的默認日曆。

參數

名稱 機碼 必要 類型 Description
ID
id True string

透過身分證件取得缺勤

傳回指定 ID 所指定的個別缺勤。

參數

名稱 機碼 必要 類型 Description
資源標識碼
resourceId True string

內部 Meisterplan 標識符

缺勤標識碼
absenceId True string

內部 Meisterplan 標識符

傳回

通過 ID 獲取 Sprint

傳回指定識別碼所指定的個別短期衝刺。

參數

名稱 機碼 必要 類型 Description
短期衝刺標識符
sprintId True string

內部 Meisterplan 標識符

傳回

通過 ID 獲取團隊

傳回指定 ID 所指定的個別小組。

參數

名稱 機碼 必要 類型 Description
團隊 ID
teamId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

通過 ID 獲取實際財務事件

傳回指定 ID 所指定的個別實際財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

財務實際值 ID
actualFinancialEventId True string

內部 Meisterplan 標識符

傳回

財務實際值
FinancialActualsResponse

通過 ID 獲取日曆

在您的 Meisterplan 系統中獲取一個日曆。 使用特殊 ID defaultCalendar 來取得預設行事曆。

參數

名稱 機碼 必要 類型 Description
行事曆識別碼
calendarId True string

內部 Meisterplan 標識符

傳回

通過 ID 獲取程序

傳回指定識別碼所指定的個別程式。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

程式識別碼
programId True string

內部 Meisterplan 標識符

傳回

此作業會輸出隨機的結果。

通過 ID 獲取財務信息

傳回指定 ID 所指定的個別財務事件。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

財務 ID
financialsId True string

內部 Meisterplan 標識符

傳回

通過 ID 獲取里程碑

傳回指定ID所指定的個別里程碑。

參數

名稱 機碼 必要 類型 Description
案例識別碼
scenarioId True string

內部 Meisterplan 標識符

專案編號
projectId True string

內部 Meisterplan 標識符

里程碑標識符
milestoneId True string

內部 Meisterplan 標識符

傳回

里程碑
MilestoneResponse

觸發程序

建立 Webhook

透過指定的欄位建立 Webhook,並傳回新建立的 Webhook。 目前每個系統支援 1000 個 Webhook。

建立 Webhook

透過指定的欄位建立 Webhook,並傳回新建立的 Webhook。 目前每個系統支援 1000 個 Webhook。

參數

名稱 機碼 必要 類型 Description
事件類型
eventTypes True array of string

至少需要提供一種事件類型。

案例識別碼
scenarioId True string

您要訂閱的案例。

專案識別碼
projectId string

projectId 是選擇性的。 只有在您想要訂閱特定專案時才需要它。

傳回

此作業會輸出隨機的結果。

定義

UserRef回應

名稱 路徑 類型 Description
使用者識別碼
id string
使用者顯示名稱
displayName string

ListResponseRoleCapacity回應

名稱 路徑 類型 Description
物品
items array of RoleCapacityResponse

RoleCapacity回應

名稱 路徑 類型 Description
start
start date

此角色產能區段的開始日期。 選擇性。

finish date

此角色產能區段的結束日期。 選擇性。

FTE
fte double

角色在FTE中的容量

里程碑回應

名稱 路徑 類型 Description
ID
id string
名稱
name string
Date
date string

格式:YYYY-MM-DD

項目階段
projectPhase ProjectPhaseResponse
地位
status StatusResponse

專案階段回應

名稱 路徑 類型 Description
名稱
name string

狀態回應

名稱 路徑 類型 Description
價值觀
value string
顯示名稱
displayName string

FinanceCategory回應

名稱 路徑 類型 Description
名稱
name string

財務回應

名稱 路徑 類型 Description
ID
id string
類型
type string
總數
amount double
財務時機
timing FinancialsTimingResponse
Description
description string
金融類別
category FinanceCategoryResponse

財務時機回應

名稱 路徑 類型 Description
另一
on string
里程碑 ID
milestoneId string

僅在計時類型等於里程碑時才會出現

到期日
dueDate date

FinancialActuals回應

名稱 路徑 類型 Description
ID
id string
類型
type string
總數
amount double
預訂日期
bookingDate string

格式:YYYY-MM-DD

Description
description string
金融類別
category FinanceCategoryResponse

AllocatedEntity回應

名稱 路徑 類型 Description
ID
id string

此配置所連結之實體的識別碼

類型
type string

此分配的實體類型

項目角色
projectRole string

只有在類型等於 RESOURCE 時才會設定

分配回應

名稱 路徑 類型 Description
ID
id string

此配置的識別碼

分配的實體
allocatedEntity AllocatedEntityResponse
段落
segments array of AllocationSegmentResponse

配置的時間區段

AllocationSegment回應

配置的時間區段

名稱 路徑 類型 Description
開始
start date

此分配的開始日期

結束
finish date

此分配的結束日期

小時
hours double

分配值 (以小時為單位)

ActualTimeWorked回應

名稱 路徑 類型 Description
實際值實體連結
bookedEntity ActualsEntityLinkResponse
預訂
bookings array of ActualsBookingResponse

此實際工作時間條目的預訂日期和時間

ActualsBookingResponse

此實際工作時間條目的預訂日期和時間

名稱 路徑 類型 Description
Id
id string

此實際工作時間條目的預訂 ID

預訂日期
bookingDate date

此實際工作時間條目的預訂日期

小時
hours double

實際工作時間(以小時為單位)

成本類型
costType string
每小時成本
costPerHour double

實際值EntityLinkResponse

名稱 路徑 類型 Description
ID
id string

此實際工作時間項目連結至的實體識別碼

類型
type string

此實際工作時間項目的實體類型

團隊識別碼
teamId string

此實際工作時間項目連結之實體的團隊識別碼

里程碑相依性CreateResponse

名稱 路徑 類型 Description
ID
id string

CalendarDeviation回應

名稱 路徑 類型 Description
開始
start date
結束
finish date
相對容量
relativeCapacity double

ListResponseCalendarDeviationResponse

名稱 路徑 類型 Description
物品
items array of CalendarDeviationResponse

缺席回應

名稱 路徑 類型 Description
ID
id string

缺席的 ID

開始日期
start date

這次缺席的開始日期

完成日期
finish date

此缺席的完成日期

開始缺勤日類型
startDayType string
完成缺勤日類型
finishDayType string

ObsType回應

名稱 路徑 類型 Description
ID
id string
名稱
name string

觀察單位回應

名稱 路徑 類型 Description
ID
id string
名稱
name string
路徑
path string
顯示名稱
displayName string

顯示名稱的呈現方式與 Meisterplan 應用程式使用者介面中的呈現方式相同

父 ID
parentId string

Calendar回應

名稱 路徑 類型 Description
ID
id string
名稱
name string
父 ID
parentId string
路徑
path string
工作時間
workingHours WorkingHoursResponse

WorkingHoursResponse

名稱 路徑 類型 Description
星期一
monday double
星期二
tuesday double
星期三
wednesday double
星期四
thursday double
星期五
friday double
星期六
saturday double
星期日
sunday double

Cursor

名稱 路徑 類型 Description
Cursor
cursor string

分頁

名稱 路徑 類型 Description
Cursor
after Cursor

BasicUserGroup回應

名稱 路徑 類型 Description
群組識別碼
id string

使用者群組的 ID。

群組名稱
name string

使用者群組的名稱。

LinkedResourceResponse

名稱 路徑 類型 Description
ID
id string

連結資源的識別碼。

資源金鑰
resourceKey string

連結資源的資源索引鍵。

PaginatedResponseUser回應

名稱 路徑 類型 Description
物品
items array of UserResponse
分頁
_pagination Pagination

使用者回應

名稱 路徑 類型 Description
ID
id string
用戶名稱
userName string
外部 ID
externalId string
Active
active boolean
電子郵件地址
emailAddress string
姓氏
lastName string
名字
firstName string
顯示名稱
displayName string
Locale
locale string
groups
groups array of BasicUserGroupResponse
上次登入
lastLogin date-time
電子郵件已驗證
emailVerified boolean
連結資源
linkedResource LinkedResourceResponse
密碼永不過期
passwordNeverExpires boolean

Sprint回應

名稱 路徑 類型 Description
ID
id string
衝刺鍵
key string
名稱
name string
開始
start date-time
結束
end date-time

ListResponseScenario回應

名稱 路徑 類型 Description
物品
items array of ScenarioResponse

ScenarioResponse

名稱 路徑 類型 Description
ID
id string
名稱
name string

ListResponseRoleWithRoleCapacityResponse

名稱 路徑 類型 Description
物品
items array of RoleWithRoleCapacityResponse

RoleWithRoleCapacity回應

名稱 路徑 類型 Description
角色ID
roleId string

角色的識別碼。

segments
segments array of RoleCapacityResponse

角色的產能區段。

ListResponseMilestoneResponse

名稱 路徑 類型 Description
物品
items array of MilestoneResponse

ListResponse財務回應

名稱 路徑 類型 Description
物品
items array of FinancialsResponse

ListResponseFinancialActuals回應

名稱 路徑 類型 Description
物品
items array of FinancialActualsResponse

PaginatedResponseProjectCommentResponse

名稱 路徑 類型 Description
物品
items array of ProjectCommentResponse
分頁
_pagination Pagination

專案註解回應

名稱 路徑 類型 Description
ID
id string
Content
content string
用戶參考
author UserRefResponse
建立日期
createdDate string
提及
mentions array of UserRefResponse

ListResponse分配回應

名稱 路徑 類型 Description
物品
items array of AllocationResponse

AllocationCommentEntityResponse

名稱 路徑 類型 Description
ID
id string

此配置註解所連結之實體的識別碼

類型
type string

此配置註解連結至的實體類型

AllocationComment回應

名稱 路徑 類型 Description
ID
id string
Content
content string
用戶參考
author UserRefResponse
建立日期
createdDate string
提及
mentions array of UserRefResponse
分配的實體
allocatedEntity AllocationCommentEntityResponse

PaginatedResponseAllocationCommentResponse

名稱 路徑 類型 Description
物品
items array of AllocationCommentResponse
分頁
_pagination Pagination

PaginatedResponseActualTimeWorkedResponse

名稱 路徑 類型 Description
物品
items array of ActualTimeWorkedResponse
分頁
_pagination Pagination

ActualTimeWorkedById回應

名稱 路徑 類型 Description
實際值實體連結
bookedEntity ActualsEntityLinkResponse
Id
id string

此實際工作時間條目的預訂 ID

預訂日期
bookingDate date

此實際工作時間條目的預訂日期

小時
hours double

實際工作時間(以小時為單位)

成本類型
costType string
每小時成本
costPerHour double

PaginatedResponseProgramGetAllResponse

名稱 路徑 類型 Description
物品
items array of ProgramGetAllResponse
分頁
_pagination Pagination

ProgramGetAll回應

名稱 路徑 類型 Description
ID
id string
名稱
name string
程式金鑰
programKey string

必須是唯一的。 如果是空的,價值就會產生。

里程碑相依性回應

名稱 路徑 類型 Description
ID
id string
里程碑參考
from MilestoneReferenceResponse
里程碑參考
to MilestoneReferenceResponse

里程碑參考回應

名稱 路徑 類型 Description
專案識別碼
projectId string
里程碑 ID
milestoneId string

PaginatedResponseMilestoneDependencyResponse

名稱 路徑 類型 Description
物品
items array of MilestoneDependencyResponse
分頁
_pagination Pagination

ListResponseAbsenceResponse

名稱 路徑 類型 Description
物品
items array of AbsenceResponse

清單回應投資組合回應

名稱 路徑 類型 Description
物品
items array of PortfolioResponse

投資組合回應

名稱 路徑 類型 Description
ID
id string
名稱
name string

ListResponseObsType回應

名稱 路徑 類型 Description
物品
items array of ObsTypeResponse

ListResponseObsUnitResponse

名稱 路徑 類型 Description
物品
items array of ObsUnitResponse

ListResponseCalendar回應

名稱 路徑 類型 Description
物品
items array of CalendarResponse

CalendarException回應

名稱 路徑 類型 Description
Date
date date
工作時間
workingHours double
Description
description string
來源行事曆ID
sourceCalendarId string

ListResponseCalendarExceptionResponse 回應

名稱 路徑 類型 Description
物品
items array of CalendarExceptionResponse

BusinessGoalDefinition回應

名稱 路徑 類型 Description
名稱
name string
子目標
subGoals array of SubGoalDefinitionResponse

ListResponseBusinessGoalDefinitionResponse

名稱 路徑 類型 Description
物品
items array of BusinessGoalDefinitionResponse

SubGoalDefinition回應

名稱 路徑 類型 Description
名稱
name string
顯示名稱
displayName string