文件WorkfrontWorkfront 指南

API 12版的新增功能

最後更新： 2024年7月18日
  • 主題：

建立對象：

  • 開發人員

Workfront於2020年11月12日發行API第12版。 API第12版具有第11版的下列變更

新增的資源

下列是Workfront API 12版的新資源。

  • BreadCrumb
  • RtfParameterValue

BreadCrumb

BreadCrumb物件代表Adobe Workfront工作專案之父/子階層中的元素。 階層連結可指出工作專案如何融入Portfolio、專案、專案和任務的較大結構。

如需Workfront階層連結的詳細資訊，請參閱新Adobe Workfront體驗中的階層連結概觀

  • getObjectHierarchy

RtfParameterValue

RTF文字欄位現在可用於更多物件。 已將RichTextParameterValue物件新增至Workfront，以支援此可用性。

如需詳細資訊，請參閱Adobe Workfront API中的 RTF欄位。

  • ID
  • ID
  • 物件代碼

已移除的資源

未移除API版本12的資源。

已修改的資源

已針對Workfront API 12版修改下列資源。

  • 存取層級

  • AccessLevelPermissions

  • AccessRequest

  • 存取規則

  • 活動記錄檔

  • AnnouncementAttachment

  • 核准

  • 行事曆區段

  • 公司

  • 客戶

  • 客戶喜好設定

  • 檔案

  • DocumentVersion

  • 群組

  • LinkedFolder

  • OpTask

  • 引數

  • Portfolio

  • 程式

  • QueueDef

  • 排程報告

  • ScoreCardQuestion

  • 任務

  • 團隊

  • 範本任務

  • 時程表

  • 使用者

  • 工作

存取層級

AccessLevel物件與使用者相關聯，並描述決定使用者可存取內容的AccessLevelPermissions集合。

如需存取層級的詳細資訊，請參閱存取層級的運作方式。

AccessLevelPermissions

AccessLevelPermissions物件代表存取、建立或修改Workfront物件的特定許可權。 然後，這些許可權可以與存取層級相關聯。

直接欄位

  • coreAction

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

      具有包含此許可權的存取層級的使用者可以在工作負載平衡器中更新規劃時數。

      如需詳細資訊，請參閱在工作負載平衡器中管理使用者指派時更新任務計畫時數。

    • ADD_TO_CUSTOM_FORMS

      具有包含此許可權的存取層級的使用者可以將欄位新增到自訂表單。

      如需詳細資訊，請參閱建立或編輯自訂表格。

    • EDIT_SYSTEM範圍

      具有包含此許可權的存取層級的使用者可以在系統範圍內以刪除存取權共用自訂欄位。

  • forbiddenActions

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEM範圍

  • secondaryActions

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEM範圍

AccessRequest

如果使用者無權存取Workfront中他們需要的物件，他們可以請求存取該物件。 AccessRequest物件代表此要求。

直接欄位

  • 動作

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

      具有包含此許可權的存取層級的使用者可以在工作負載平衡器中更新規劃時數。

      如需詳細資訊，請參閱在工作負載平衡器中管理使用者指派時更新任務計畫時數。

    • ADD_TO_CUSTOM_FORMS

      具有包含此許可權的存取層級的使用者可以將欄位新增到自訂表單。

      如需詳細資訊，請參閱建立或編輯自訂表格。

    • EDIT_SYSTEM範圍

      具有包含此許可權的存取層級的使用者可以在系統範圍內以刪除存取權共用自訂欄位。

存取規則

AccessRule物件代表自訂存取層級中的規則集，可決定使用者如何共用他們建立的專案。

直接欄位

  • coreAction

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

      具有包含此許可權的存取層級的使用者可以在工作負載平衡器中更新規劃時數。

      如需詳細資訊，請參閱在工作負載平衡器中管理使用者指派時更新任務計畫時數。

    • ADD_TO_CUSTOM_FORMS

      具有包含此許可權的存取層級的使用者可以將欄位新增到自訂表單。

      如需詳細資訊，請參閱建立或編輯自訂表格。

    • EDIT_SYSTEM範圍

      具有包含此許可權的存取層級的使用者可以在系統範圍內以刪除存取權共用自訂欄位。

  • forbiddenActions

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEM範圍

  • secondaryActions

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEM範圍

活動記錄

ActivityLog物件是在指定Workfront Proof帳戶中發生的所有活動的完整清單。

營運

下列作業已從ActivityLog物件中移除：

  • 新增

宣告附件

AnnouncementAttachment物件代表已附加至Workfront宣告的檔案。

如需宣告附件的詳細資訊，請參閱傳送宣告

直接欄位

  • 副檔名

    新增可能的值：

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

核准

指定的工作專案，例如工作、檔案或時程表，可能需要主管或其他使用者登出該工作專案。 Approval物件代表在工作專案上簽核的動作。

直接欄位

  • backlogOrder

    已移除下列標幟：

    • 動態，

    • 延遲讀取，

    • NOT_GROUPABLE

  • groupID

    已新增下列旗標

    • AUTO_LOAD，

    • 動態，

    • READ_ONLY

  • 工作量

    此欄位已新增，並代表使用者需要少量、中量或大量每日努力才能完成任務。 可能的值包括：

    • 1 （小）

    • 2 (Medium)

    • 3 （大）

    如需有關Workfront中工作量的詳細資訊，請參閱工作量概觀。

行事曆區段

行事曆區段是行事曆報告。

如需行事曆報告的詳細資訊，請參閱行事曆報告總覽。

直接欄位

CalendarSection物件新增了下列欄位，以支援在行事曆報表中使用自訂日期的新功能。

如需詳細資訊，請參閱在行事曆報告中使用自訂日期欄位。

  • customDate

  • customEndDateParameterID

  • customStartDateParameterID

  • ignoreActualDates

公司

Company物件代表由人員集合組成的組織。

如需有關公司的詳細資訊，請參閱建立和編輯公司。

直接欄位

  • groupID

    與公司相關聯的群組ID。

參考欄位

  • 群組

    與公司相關聯的群組。 將公司與群組建立關聯可讓群組管理員擴充對公司的群組存取權和許可權。

客戶

Customer物件代表使用Workfront例項的組織。

動作

  • 產品已啟用

    此動作會採用CustomerProductTypeEnum引數並傳回布林值，指出該客戶是否有該產品的帳戶。

客戶喜好設定

CustomerPreferences物件代表客戶已針對其Workfront例項設定的偏好設定集。

直接欄位

  • 名稱

    新增可能的值：

    • password：zoomIntegrationEnabled （啟用更新資料流中的縮放整合）
    • 密碼：quipIntegrationEnabled (config.general.quip.enabled)

文件

Document物件代表檔案（例如書面材料、影像或其他形式的資訊）。

動作

  • createLinkedProofVersion

    已新增

檔案版本

DocumentVersion物件代表檔案的特定版本（例如書面材料、影像或其他形式的資訊）。

如需檔案版本的詳細資訊，請參閱上傳檔案的新版本。

直接欄位

  • externalIntegrationType

    已移除可能的值：

    • QUIP (Quip)

  • 校訂決定

    已新增

動作

下列動作已新增至Document物件。

  • getDocumentReviewerDecision

    此動作採用documentVersonID引數（字串）並傳回指出檢閱者決定的地圖。

  • setDocumentReviewerDecision

    此動作會採用下列引數：

    • documentVersionID （字串）

    • reviewerDecision （字串）

    • 註解（字串）

群組

群組物件代表一組使用者和團隊。 群組通常代表部門結構。

直接欄位

  • 業務領導者ID

    指派給群組的業務領導者ID。

參考欄位

  • 業務領導者

    指派給群組的業務領導者。 業務主管是負責為群組制定業務決策的人。

    如需商務領導者的詳細資訊，請參閱商務領導概述。

動作

  • assignMultiple

    此動作會採用下列引數：

    • userIDs (string[])

    • roleIDs (string[])

    • teamID （字串）

  • getGroupMembers

  • updateMembersList

    此動作會採用下列引數：

    • newMemberIDs (string[])

    • removedMemberDs (string[])

LinkedFolder

LinkedFolder物件代表連結自外部檔案提供者(例如Google Drive或Dropbox)的資料夾。

如需連結資料夾的詳細資訊，請參閱從外部應用程式連結檔案。

直接欄位

  • externalIntegrationType

    已移除可能的值：

    • QUIP (Quip)

Op 任務

OpTask物件通常稱為「問題」。 問題指工作專案，通常表示發生問題而無法完成任務或專案。 問題也可以是服務檯請求。 變更單、請求和錯誤也是問題。

直接欄位

  • backlogOrder

    「順序」表示任務或劇本在敏捷待辦專案上的位置。

    此欄位已移除下列標幟：

    • 動態，
    • 延遲讀取，
    • NOT_GROUPABLE：
動作

這些動作新增引數狀態以支援新的「開始」按鈕功能，當使用者按一下按鈕以指示他們已開始處理專案時，該功能會變更工作專案的狀態。

如需詳細資訊，請參閱以開始按鈕取代處理它按鈕。

  • acceptWork

  • unacceptWork

參數

Parameter物件是自訂欄位。

Parameter資源已新增可共用的標幟。

如需自訂欄位的詳細資訊，請參閱建立或編輯自訂表單中的建立或編輯自訂表單。

直接欄位

  • 資料型別

    新增可能的值：

    • RTF (RTF)

      如需詳細資訊，請參閱Adobe Workfront API中的 RTF欄位。

  • displayType

    新增可能的值：

    • RTF （含格式的文字欄位）

      如需詳細資訊，請參閱Adobe Workfront API中的 RTF欄位。

  • 標籤

    已新增

集合欄位

  • 存取規則

    已新增

預設欄位

  • 標籤

    已新增

專案組合

Portfolio物件是競爭相同資源（通常是金錢或人力）的專案集合。

如需投資組合的詳細資訊，請參閱Adobe Workfront中的Portfolio概觀。

直接欄位

  • groupID

    與投資組合相關聯的群組ID。

參考欄位

  • 群組

    與投資組合相關聯的群組。

方案

計畫物件是投資組合中專案的子集，其中類似的專案可以分組在一起。

直接欄位

  • groupID

    與方案相關聯的群組ID。

參考欄位

  • 群組

    與方案相關聯的群組。

QueueDef

QueueDef物件代表佇列，這是已發佈至服務檯區域的專案，可讓使用者向其提交問題。

如需請求佇列的詳細資訊，請參閱建立請求佇列。

直接欄位

  • requestorCoreAction

    已新增下列可能值：

    • PLANNED_HOURS_CONTOURING

      具有包含此許可權的存取層級的使用者可以在工作負載平衡器中更新規劃時數。

      如需詳細資訊，請參閱在工作負載平衡器中管理使用者指派時更新任務計畫時數。

    • ADD_TO_CUSTOM_FORMS

      具有包含此許可權的存取層級的使用者可以將欄位新增到自訂表單。

      如需詳細資訊，請參閱建立或編輯自訂表格。

    • EDIT_SYSTEM範圍

      具有包含此許可權的存取層級的使用者可以在系統範圍內以刪除存取權共用自訂欄位。

      • PLANNED_HOURS_CONTOURING

      • ADD_TO_CUSTOM_FORMS

      • EDIT_SYSTEM範圍

排程報告

ScheduledReport物件代表已設定為排程傳送的報表。

直接欄位

  • 格式

    新增可能的值：

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

ScorecardQuestion

ScoreCardQuestion物件代表已新增至計分卡的問題。 這些問題通常由Portfolio經理決定，而他們的答案可讓經理瞭解專案與產品組合目標的對齊程度。

如需計分卡問題的詳細資訊，請參閱建立計分卡。

直接欄位

  • 顯示型別

    新增可能的值RTF （文字欄位含格式）

    如需詳細資訊，請參閱Adobe Workfront API中的 RTF欄位。

任務

Task物件代表作為達成最終目標（完成專案）的步驟而必須執行的工作專案。

直接欄位

  • 工作量

    此欄位已新增，並代表使用者需要少量、中量或大量每日努力才能完成任務。 可能的值包括：

    • 1 （小）

    • 2 (Medium)

    • 3 （大）

    如需有關Workfront中工作量的詳細資訊，請參閱工作量概觀。

動作

這些動作新增引數狀態以支援新的「開始」按鈕功能，當使用者按一下按鈕以指示他們已開始處理專案時，該功能會變更工作專案的狀態。

如需詳細資訊，請參閱以開始按鈕取代處理它按鈕。

  • acceptWork

  • unacceptWork

團隊

Team物件是可指派至工作專案的「使用者」集合。

直接欄位

下列欄位已新增至小組資源：

  • groupID

    此欄位會將團隊與群組建立關聯。 這會將團隊識別為群組的一部分，並允許群組管理員管理團隊。

  • workOnItStatusChange

    這是一個布林值引數，可指出團隊的「處理它」按鈕是否已設定為「開始」按鈕。 當專案團隊成員按一下「開始」按鈕開始處理工作專案時，專案的狀態會從「新增」變更為專案團隊設定中設定的狀態。

  • 下列欄位可讓您為個別工作專案上的「開始」按鈕指定自訂狀態。

    • workOnItOpTaskBugReportStatuses

    • workOnItOpTaskChangeOrderStatuses

    • workOnItOpTaskIssueStatuses

    • workOnItOpTaskRequestStatuses

      workOnItTaskStatuses

    有關[開始]按鈕的詳細資訊，請參閱以[開始]按鈕取代[處理它]按鈕。

參考欄位

下列欄位已新增至「專案團隊」資源：

  • 群組

範本任務

TemplateTask物件代表屬於Template一部分的Task。 範本任務會成為使用範本之專案中的任務。

如需範本工作的詳細資訊，請參閱編輯範本工作。

直接欄位

  • 工作量

    此欄位已新增，並代表使用者需要少量、中量或大量每日努力才能完成任務。 可能的值包括：

    • 1 （小）

    • 2 (Medium)

    • 3 （大）

    如需有關Workfront中工作量的詳細資訊，請參閱工作量概觀。

時程表

時程表物件代表虛擬時程表，可讓使用者輸入任務、專案和管理費用時數型別的實際工作時數。

如需時程表的詳細資訊，請參閱時程表總覽

核心欄位

下列欄位已從時程表資源中移除：

  • 物件代碼

更新

直接欄位

  • updateType

    已新增下列可能值：

    • initiativeAdd (enum.updatetypeenum.initiativeadd)

    • initiativeEdit (enum.updatetypeenum.initiativeedit)

    如需方案的詳細資訊，請參閱情境規劃工具中的方案概觀。

使用者

使用者物件代表擁有Workfront帳戶的人員，該帳戶可以登入並與系統互動。

直接欄位

下列欄位已新增至使用者資源：

  • actualDeactivationDate

    這代表停用使用者的日期和時間。

    如需已停用使用者的詳細資訊，請參閱停用或重新啟用使用者。

  • alignAccessType

    此欄位會顯示使用者對Workfront目標的存取權。 可能的值包括：

    • 無存取權

    • 檢視

    • 編輯

動作

下列動作已新增至使用者資源：

  • getUserAccessPermissionsByObjCode

    此動作會採用下列引數

    • ids （字串）

    • 物件代碼（字串）

工作

Work物件是Task和OpTask都繼承的公用介面，並在兩者之間共用公用程式碼。

直接欄位

  • backlogOrder

    「順序」表示任務或劇本在敏捷待辦專案上的位置。

    此欄位已移除下列標幟：

    • 動態，

    • 延遲讀取，

    • NOT_GROUPABLE

  • groupID

    此欄位新增了下列旗標：

    • AUTO_LOAD，

    • 動態，

    • READ_ONLY

  • 工作量

    此欄位已新增，並代表使用者需要少量、中量或大量每日努力才能完成任務。 可能的值包括：

    • 1 （小）

    • 2 (Medium)

    • 3 （大）

    如需有關Workfront中工作量的詳細資訊，請參閱工作量概觀。

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43