文件WorkfrontWorkfront 指南

API 11版的新增功能

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

建立對象：

  • 開發人員
  • 已新增資源
  • 已移除資源
  • 已修改的資源

新增的資源

  • ReportableBudgetedHour
  • accessExpirationDate
  • 存取子ID
  • customerID
  • ID
  • userID
  • 存取子
  • 客戶
  • 使用者
  • ID
  • 物件代碼
  • customerID
  • ID
  • loginAsSettingsID
  • 物件ID
  • 物件代碼
  • 客戶
  • ID
  • 物件代碼
  • customerID
  • licenseType
  • ID
  • restrictedLoginAs
  • 客戶
  • 其他規則
  • ID
  • 物件代碼

ReportableBudgetedHour

ReportableBudgedHour已新增至Adobe Workfront API作為報表的資源。 它具有BudgetedHour中不存在的參考欄位、核心欄位和預設欄位。

直接欄位

  • allocationDate

    配置日期是您在「資源規劃工具」中編列時數預算的一週的第一天（星期日）。

  • budgetedHours

    預算時數是資源管理員預算專案上資源需要完成的工作的時數

  • ID

    指派給特定可報告預算時數物件的唯一Workfront ID。

  • plannedBudgetedHours

  • projectID

    指派給特定專案的唯一Workfront ID。

  • roleID

    指派給特定工作角色的唯一Workfront ID。

  • userID

    指派給特定使用者的唯一Workfront ID。

參考欄位

  • 專案

    ReportableBudgetedHour相關聯的專案。

  • 角色

    與ReportableBudgetedHour相關聯的工作角色。

  • 使用者

    ReportableBudgetedHour相關聯的使用者。

核心欄位
  • ID
  • 名稱
  • 物件代碼
預設欄位
  • 名稱
營運
  • 計數
  • GET
  • 報告
  • SEARCH

已移除的資源

未移除API v11的資源。

已修改的資源

  • AccessLevelPermissions
  • AccessRequest
  • 存取規則
  • 核准
  • 核准路徑
  • ApprovalProcess
  • 工作分派
  • 基準線任務
  • 類別
  • 公司
  • CustomEnum
  • 客戶
  • 客戶喜好設定
  • DocMetadataLinkGroup
  • 檔案
  • 反複專案
  • 配置範本
  • 里程碑路徑
  • 附註
  • OpTask
  • 引數
  • Portfolio
  • 程式
  • 專案
  • 校訂核准
  • QueueDef
  • 保留時間
  • ResourcePlannerFilter
  • 風險
  • 排程報告
  • ScoreCardQuestion
  • 任務
  • 團隊
  • 範本
  • 範本指派
  • 範本任務
  • 時程表
  • 使用者附註
  • 工作

AccessLevelPermissions

AccessLevelPermissions物件代表一組許可權。 然後可以將這組許可權與存取層級相關聯。

直接欄位

下列欄位新增了可能的值BUDGETING_INFORMATION。 這允許具有許可權的使用者編輯規劃工具中的優先順序和預算時數。

  • coreAction
  • forbiddenActions
  • secondaryActions

AccessRequest

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

直接欄位

  • 動作

    已新增可能的值BUDGETING_INFORMATION。 這允許具有許可權的使用者編輯規劃工具中的優先順序和預算時數。

存取規則

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

直接欄位

下列欄位新增了可能的值BUDGETING_INFORMATION。 這允許具有許可權的使用者編輯規劃工具中的優先順序和預算時數。

  • coreAction
  • forbiddenActions
  • secondaryActions

核准

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

直接欄位

下列欄位新增了驗證器AT_DATE_BEFORE_YEAR和AT_DATE_AFTER_YEAR。 這些驗證器指定相關物件上的日期不能設定在1900年之前或2200年之後。

  • actualCompletionDate
  • actualStartDate
  • constraintdate
  • plannedCompletionDate
  • plannedStartDate

下列欄位已新增到公用API，以透明方式計算EAC （預估完成成本）。

  • bcwp

    「已執行工作之預算成本(BCWP)」也稱為「盈餘值」，是一種專案績效量度，代表計算此量度時實際完成之任務量的預算成本。 若為作業，BCWP =實際完成百分比x作業預算。 對於專案，BCWP = SUM（所有父系和個別任務的BCWP值）。

  • bcws

    「已排程工作之預算成本(BCWS)」也稱為計畫值，是專案效能量度，代表計算此量度時應該完成之任務量的預算成本。 若為工作，BCWS =計畫完成百分比x工作預算。 對於專案，BCWS = SUM（所有父系和個別任務的BCWS值）。

下列欄位新增了可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

  • durationUnit
  • 工作單位

下列欄位已新增標幟CURRENCY

  • projectBudgetedCost
  • 專案淨值

下列欄位已從核准物件中移除。

  • 保留時間ID
  • timelineExceptionInfo

下列欄位已新增至核准物件。

  • storyPoint
參考欄位

  • 保留時間

    已從核准物件移除

集合欄位

  • allConditions

    已新增至「核准」物件。

ApprovalPath

ApprovalPath物件是核准流程中的分支。 「核准路徑」是以與「核准流程」相關聯之物件的狀態為基礎。

直接欄位

  • durationUnit

    新增可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

ApprovalProcess

ApprovalProcess物件是可與專案、任務或問題相關聯的多步驟核准。

直接欄位

  • isActive

    此欄位已新增，且是布林引數，如果物件為作用中，則值為true，否則為false。 設定為「作用中」的物件會出現在下拉式選單和預先輸入欄位中，並可附加到其他物件。 未設定為「作用中」的物件在下拉式選單和要附加至其他物件的預先輸入欄位中不可見。

預設欄位

  • isActive

    已新增

指派

工作指派物件代表工作專案與指派處理該工作專案的使用者、專案團隊或群組之間的連線。

直接欄位

  • 工作單位

    新增可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

基準線任務

基準線是專案在指定時間的效能快照。 這類檔案會儲存專案的關鍵資訊，例如關鍵日期、進度、成本和收入值。 當您建立基準線時，也會擷取該基準線之基準線工作上的工作資訊。

直接欄位

  • durationUnit

    新增可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

類別

類別物件是自訂表單。 您可以建立此物件的報表，也可以在其他物件報表中顯示它。

直接欄位

  • isActive

    此欄位已新增，且是布林引數，如果物件為作用中，則值為true，否則為false。 設定為「作用中」的物件會出現在下拉式選單和預先輸入欄位中，並可附加到其他物件。 未設定為「作用中」的物件在下拉式選單和要附加至其他物件的預先輸入欄位中不可見。

預設欄位

  • isActive

    已新增

公司

Company物件代表由人員集合組成的組織。 公司與使用者或專案相關聯。

直接欄位

  • isActive

    此欄位已新增，且是布林引數，如果物件為作用中，則值為true，否則為false。 設定為「作用中」的物件會出現在下拉式選單和預先輸入欄位中，並可附加到其他物件。 未設定為「作用中」的物件在下拉式選單和要附加至其他物件的預先輸入欄位中不可見。

預設欄位

  • isActive

    已新增

CustomEnum

動作

下列動作已新增至CustomEnum物件

  • getDefaultOpTaskConditionEnum
  • getDefaultProjectConditionEnum
  • getDefaultTaskConditionEnum
查詢

下列查詢已新增到CustomEnum物件

  • opTaskConditions
  • projectConditions
  • 任務條件

客戶

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

直接欄位

  • customEnumType

    新增可能的值：

    • CONDITION_PROJ （專案狀態）
    • CONDITION_TASK （工作條件）
    • CONDITION_OPTASK （問題條件）
動作

下列動作已新增至Customer物件

  • Goalenabled
  • updateLoginAsSettings

客戶喜好設定

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

  • 名稱

    新增可能的值：

    • password：password.eauthPolicy （密碼複雜性要求）
    • password：password.minimumLength （最小密碼長度）
    • 密碼：mobileSessionTimeout （行動工作階段逾時）
    • project.mgmt：default.project.usertimeoff （使用者休假）
    • 時程表：default.timesheet.manualrole （手動控制角色）
    • proof：defaultNonRecipientRole (config.proofhq.defaultnonrecipientrole)
    • proof：defaultNonRecipientGuestRole (config.proofhq.defaultnonrecipientguestrole)

DocMetadataLinkGroup

動作

  • getMetadataDetailsForDocument

    已新增

文件

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

動作

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

  • completeLargeDocument
  • createLargeDocument
  • createProofRest
  • getDocumentProofTemplate
  • getProofRecipients
  • getProofStages
  • getProofTemplate

反覆項目

反複專案物件代表單一敏捷反複專案。 反複專案是用來規劃和完成敏捷內文的離散時段。

直接欄位

下列欄位已新增至版序物件。

  • originalTotalPoints
  • 完成點數
  • 總點數

版面配置範本

「版面配置範本」物件代表版面配置元素的特定排列，例如主功能表、導覽面板或「首頁」區域。 版面配置範本可以指派給使用者、團隊、群組或工作角色。

直接欄位

  • showHomeTimestamps

    此欄位已新增，是一個布林引數，如果「版面配置範本」設定為在工作清單和行事曆中顯示到期日的時間戳記，則值為true；如果設定為隱藏時間戳記，則值為false。

預設欄位

  • showHomeTimestamps

    已新增

里程碑路徑

里程碑是任務的標籤，表示它是專案中的關鍵點。 通常用於表示重大事件，例如專案某個階段或一組關鍵活動的完成。 MilestonePath物件是里程碑的集合。

直接欄位

  • isActive

    此欄位已新增，且是布林引數，如果物件為作用中，則值為true，否則為false。 設定為「作用中」的物件會出現在下拉式選單和預先輸入欄位中，並可附加到其他物件。 未設定為「作用中」的物件在下拉式選單和要附加至其他物件的預先輸入欄位中不可見。

預設欄位

  • isActive

    已新增

備註

Note物件是在Workfront物件上所做的註解或更新。

直接欄位

下列欄位已新增至Note物件。

  • proofID
集合欄位

  • 贊

    已新增

Op 任務

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

直接欄位

下列欄位新增了驗證器AT_DATE_BEFORE_YEAR和AT_DATE_AFTER_YEAR。 這些驗證器指定相關物件上的日期不能設定在1900年之前或2200年之後。

  • actualCompletionDate
  • actualStartDate
  • plannedCompletionDate
  • plannedStartDate

下列欄位已新增至OpTask。

  • kanbanBoardID

    Kanban展示板物件的唯一Workfront ID。

  • percentcomplete

    完成百分比是將傳回問題完成數量的引數（百分比）。

  • storyPoint

  • 工作

集合欄位

  • allConditions

    已新增

搜尋欄位

  • 工作

    已移除

預設欄位

  • percentcomplete

    已新增

動作

下列動作已新增至OpTask物件

  • bulkmove
  • copyissue

參數

Parameter物件是自訂欄位。

直接欄位

  • 顯示型別

    新增可能的值TYAH （自動提示）。

  • refObjCode

    此欄位已新增，並參考參考參考物件的物件程式碼。 您可以在API Explorer中找到所有物件的物件程式碼。

專案組合

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

直接欄位

  • 說明

    新增驗證器MAX_LENGTH，指定說明長度不得超過4000個字元。

方案

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

直接欄位

  • 說明

    新增驗證器MAX_LENGTH，指定說明長度不得超過4000個字元。

  • isActive

    此欄位已新增，且是布林引數，如果物件為作用中，則值為true，否則為false。 設定為「作用中」的物件會出現在下拉式選單和預先輸入欄位中，並可附加到其他物件。 未設定為「作用中」的物件在下拉式選單和要附加至其他物件的預先輸入欄位中不可見。

  • 名稱

    新增驗證器MAX_LENGTH，指定名稱長度不得超過255個字元。

預設欄位

  • isActive

    已新增

專案

專案是Workfront內的工作專案，也是Workfront協助人們完成工作的主要建置組塊。 Project物件代表具有共同特定目標的一組任務。

直接欄位

下列欄位新增了驗證器AT_DATE_BEFORE_YEAR和AT_DATE_AFTER_YEAR。 這些驗證器指定相關物件上的日期不能設定在1900年之前或2200年之後。

  • actualCompletionDate
  • actualStartDate
  • plannedCompletionDate
  • plannedStartDate

下列欄位已新增到公用API，以透明方式計算EAC （預估完成成本）。

  • bcwp

    「已執行工作之預算成本(BCWP)」也稱為「盈餘值」，是一種專案績效量度，代表計算此量度時實際完成之任務量的預算成本。 若為作業，BCWP =實際完成百分比x作業預算。 對於專案，BCWP = SUM（所有父系和個別任務的BCWP值）。

  • bcws

    「已排程工作之預算成本(BCWS)」也稱為計畫值，是專案效能量度，代表計算此量度時應該完成之任務量的預算成本。 若為工作，BCWS =計畫完成百分比x工作預算。 對於專案，BCWS = SUM（所有父系和個別任務的BCWS值）。

下列欄位已新增標幟CURRENCY

  • projectBudgetedCost
  • 專案淨值

下列欄位已從專案物件中移除。

  • timelineExceptionInfo
集合欄位

  • allConditions

    已新增

ProofApproval

ProofApproval物件代表直接連線至校訂的核准。

直接欄位

  • isWaitingDecision

    此欄位已新增，並且是布林引數，如果校訂正在等待決定，則值為true，否則為false。

QueueDef

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

直接欄位

下列欄位新增了可能的值BUDGETING_INFORMATION。 這允許具有許可權的使用者編輯規劃工具中的優先順序和預算時數。

  • requestorCoreAction
  • requestorForbiddenActions

保留時間

ReservedTime物件代表在使用者個人時間中指定的天數，表示使用者將無法工作。

ReservedTime資源已新增旗標REPORTABLE。

直接欄位

下列欄位已移除標幟NOT_GROUPABLE。

  • endDate
  • extRefId
  • startDate

下列欄位已從ReservedTime物件中移除。

  • taskID
參考欄位

  • 任務

    已移除

營運

  • 編輯

    已新增

ResourcePlannerFilter

ResourcePlannerFilter物件是一組規則，可決定要在資源規劃工具中顯示哪些專案。

ResourcePlannerFilter資源已新增SHARABLE標幟。 物件沒有其他變更。

風險

風險物件代表可能阻止專案按時完成或在預算內完成的事件。 在計畫階段中會為專案新增風險，以在核准任何工作之前識別潛在障礙。

直接欄位

下列欄位已新增至Risk物件：

  • enteredById

    最初建立物件的使用者識別碼。

  • entryDate

    使用者在Workfront中提交物件的日期。

  • lastUpdateDate

    上次更新日期引數會傳回對物件進行上次更新的日期，

  • lastUpdatedByID

    上次更新者ID是將傳回上次更新物件之使用者的使用者ID的引數。

參考欄位

下列參考欄位已新增至RIsk物件。

  • 輸入者
  • lastUpdatedBy

排程報告

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

直接欄位

  • pageSize

    已新增下列可能值：

    • A2
    • A1
    • A0

ScorecardQuestion

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

直接欄位

  • 顯示型別

    新增可能的值TYAH （自動提示）

任務

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

直接欄位

下列欄位新增了驗證器AT_DATE_BEFORE_YEAR和AT_DATE_AFTER_YEAR。 這些驗證器指定相關物件上的日期不能設定在1900年之前或2200年之後。

  • actualCompletionDate
  • actualStartDate
  • constraintdate
  • plannedCompletionDate
  • plannedStartDate

下列欄位已新增到公用API，以透明方式計算EAC （預估完成成本）。

  • bcwp

    「已執行工作之預算成本(BCWP)」也稱為「盈餘值」，是一種專案績效量度，代表計算此量度時實際完成之任務量的預算成本。 若為作業，BCWP =實際完成百分比x作業預算。 對於專案，BCWP = SUM（所有父系和個別任務的BCWP值）。

  • bcws

    「已排程工作之預算成本(BCWS)」也稱為計畫值，是專案效能量度，代表計算此量度時應該完成之任務量的預算成本。 若為工作，BCWS =計畫完成百分比x工作預算。 對於專案，BCWS = SUM（所有父系和個別任務的BCWS值）。

下列欄位新增了可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

  • durationUnit
  • 工作單位

下列欄位已從Task物件中移除。

  • 保留時間ID

下列欄位已新增至Task物件。

  • storyPoint
參考欄位

  • 保留時間

    已移除

集合欄位

  • allConditions

    已新增

團隊

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

直接欄位

  • agileEstimateType

    此欄位已新增至Team物件。 敏捷估計型別決定如何估計劇本的工作負載。 如果以時數來預估，這是新增到劇本的計畫時數。 如果以點為單位進行預估，則每個點都會根據點的設定方式（預設為8小時），將數個計畫時數新增到劇本中。 「敏捷估算型別」可能的值包括：

    • STORY_POINTS （劇本點）
    • HOURS (Hours)
    • LEGACY_POINTS （以小時表示點）

範本

Template物件代表專案的模式。 可以從範本建立專案以節省時間。 範本包含團隊和任務，在使用範本時將會複製到專案。

直接欄位

  • isActive

    此欄位已新增，且是布林引數，如果物件為作用中，則值為true，否則為false。 設定為「作用中」的物件會出現在下拉式選單和預先輸入欄位中，並可附加到其他物件。 未設定為「作用中」的物件在下拉式選單和要附加至其他物件的預先輸入欄位中不可見。

集合欄位

  • 所有優先順序

    已新增

預設欄位

  • isActive

    已新增

範本指派

直接欄位

  • 工作單位

    新增可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

範本任務

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

直接欄位

下列欄位新增了可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

  • durationUnit
  • 工作單位
集合欄位

  • 所有優先順序

    已新增

時程表

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

核心欄位

  • 物件代碼

    已移除

更新

Workfront中的工作專案可以更新，以隨時通知使用者目前的狀態。 Update物件代表其中一項更新。 更新可由使用者輸入，或由Workfront系統建立。

直接欄位

  • updateType

    新增可能的值referenceObjectCustomData (enum.updatetypeenum.referenceobjectcustomdata)

查詢

下列查詢已新增到Update物件。

  • objectUpdatesMobile
  • updateThreadMobile

  • loginAsAccessRules

    已新增

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

  • hasGrantLoginAsAccess
  • isUserAdmin

  • userAdmins

    已新增

使用者附註

動作

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

  • acknowledgeMyNotifications
  • unacknowledgedAllObjectsTypeCount
查詢

  • myAllObjectTypesUnreadNotifications

    已新增

工作

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

直接欄位

下列欄位新增了驗證器AT_DATE_BEFORE_YEAR和AT_DATE_AFTER_YEAR。 這些驗證器指定相關物件上的日期不能設定在1900年之前或2200年之後。

  • actualCompletionDate
  • actualStartDate
  • constraintdate
  • plannedCompletionDate
  • plannedStartDate

下列欄位已新增到公用API，以透明方式計算EAC （預估完成成本）。

  • bcwp

    「已執行工作之預算成本(BCWP)」也稱為「盈餘值」，是一種專案績效量度，代表計算此量度時實際完成之任務量的預算成本。 若為作業，BCWP =實際完成百分比x作業預算。 對於專案，BCWP = SUM（所有父系和個別任務的BCWP值）。

  • bcws

    「已排程工作之預算成本(BCWS)」也稱為計畫值，是專案效能量度，代表計算此量度時應該完成之任務量的預算成本。 若為工作，BCWS =計畫完成百分比x工作預算。 對於專案，BCWS = SUM（所有父系和個別任務的BCWS值）。

下列欄位新增了可能的值ET。 此值代表經過的月時間單位，不考慮週末或假日。

  • durationUnit
  • 工作單位

下列欄位已從工作物件中移除。

  • 保留時間ID

下列欄位已新增至Work物件。

  • storyPoint
參考欄位

  • 保留時間

    已移除

集合欄位

  • allConditions

    已新增

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