文档WorkfrontWorkfront 指南

API版本12中的新增功能

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined

Workfront于2020年11月12日发布了API版本12。 API版本12具有对版本11的以下更改

已添加资源

Workfront API版本12中新增了以下资源。

BreadCrumb对象表示Adobe Workfront工作项的父/子层次结构中的元素。 痕迹导航指示工作项如何适应Portfolio、项目、项目和任务的较大结构。

有关Workfront中的痕迹导航的更多信息，请参阅新Adobe Workfront体验中的痕迹导航概述

  • getObjectHierarchy

RtfParameterValue richtextparametervalue

富文本字段现在可用于更多对象。 已将RichTextParameterValue对象添加到Workfront以支持此可用性。

有关详细信息，请参阅Adobe Workfront API中的富文本字段。

  • ID
  • ID
  • 对象代码

已删除资源

未删除API版本12的资源。

已修改的资源

为Workfront API版本12修改了以下资源。

访问级别 accesslevel

AccessLevel对象与用户相关联，并描述确定用户可以访问的AccessLevelPermissions集。

有关访问级别的详细信息，请参阅访问级别的工作方式。

AccessLevelPermissions accesslevelpermissions

AccessLevelPermissions对象表示访问、创建或修改Workfront对象的特定权限。 然后，可将这些权限与访问级别关联。

直接字段

Accessrequest accessrequest

如果用户无权访问Workfront中他们需要的对象，则可以请求对该对象的访问权限。 AccessRequest对象表示此请求。

直接字段

访问规则 accessrule

AccessRule对象表示自定义访问级别中的规则集，该规则集确定用户如何共享他们创建的项目。

直接字段

活动日志 activitylog

ActivityLog对象是在给定Workfront Proof帐户中发生的所有活动的完整列表。

运营

以下操作已从ActivityLog对象中删除：

  • 添加

公告附件 announcementattachment

AnnouncementAttachment对象表示已附加到Workfront公告的文件。

有关公告附件的详细信息，请参阅发送公告

直接字段

  • 文件扩展名

    添加了可能的值：

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

审批 approval

给定工作项，如任务、文档或时间表，可能要求主管或其他用户签发该工作项。 审批对象表示在工作项上注销的操作。

直接字段

  • backlogOrder

    删除了以下标志：

    • 动态，

    • 延迟读取，

    • NOT_GROUP

  • groupID

    添加了以下标志

    • AUTO_LOAD

    • 动态，

    • READ_ONLY

  • 工作投入

    添加了此字段，表示用户完成任务需要花费少量、中量或大量的每日工作量。 可能的值包括：

    • 1（小）

    • 2 (Medium)

    • 3 （大）

    有关Workfront中工作投入的详细信息，请参阅工作投入概述。

日历节 calendarsection

日历部分是一个日历报告。

有关日历报告的详细信息，请参阅日历报告概述。

直接字段

向CalendarSection对象中添加了以下字段，以支持在日历报表中使用自定义日期的新功能。

有关详细信息，请参阅在日历报告中使用自定义日期字段。

  • customdate

  • customEndDateParameterID

  • customStartDateParameterID

  • ignoreActualDates

公司 company

Company对象表示由人员集合组成的组织。

有关公司的详细信息，请参阅创建和编辑公司。

直接字段

  • groupID

    公司关联的组的ID。

引用字段

  • 组

    公司关联的组。 将公司与组关联允许组管理员将组访问权限扩展到公司。

客户 customer

Customer对象表示一个使用Workfront实例的组织。

操作

  • 产品已启用

    此操作采用CustomerProductTypeEnum参数并返回一个布尔值，指示该客户是否拥有该产品帐户。

客户首选项 customerpreferences

CustomerPreferences对象表示客户为其Workfront实例设置的首选项集。

直接字段

  • name

    添加了可能的值：

    • password：zoomIntegrationEnabled（在更新流中启用缩放集成）
    • 密码：quipIntegrationEnabled (config.general.quip.enabled)

文档 document

Document对象表示文件（如书面材料、图像或其他形式的信息）。

操作

  • createLinkedProofVersion

    已添加

文档版本 documentversion

DocumentVersion对象表示文件的特定版本（如书面材料、图像或其他形式的信息）。

有关文档版本的详细信息，请参阅上载文档的新版本。

直接字段

  • externalIntegrationType

    删除了可能的值：

    • QUIP (Quip)

  • proofDecision

    已添加

操作

已将以下操作添加到Document对象。

  • getDocumentReviewerDecision

    此操作采用documentVersonID参数（字符串）并返回一个指示审阅人决策的映射。

  • setDocumentReviewerDecision

    此操作采用以下参数：

    • documentVersionID（字符串）

    • reviewerDecision（字符串）

    • 注释（字符串）

组 group

组对象表示一组用户和团队。 组通常代表部门结构。

直接字段

  • 业务领导者ID

    分配给组的业务负责人ID。

引用字段

  • 业务领导者

    分配给组的业务负责人。 业务负责人是为组制定业务决策的人员。

    有关商业领袖的详细信息，请参阅商业领袖概述。

操作

  • assignMultiple

    此操作采用以下参数：

    • userIDs (string[])

    • roleIDs (string[])

    • teamID（字符串）

  • getGroupMembers

  • updateMembersList

    此操作采用以下参数：

    • newMemberIDs (string[])

    • removedMemberDs (string[])

链接文件夹 linkedfolder

LinkedFolder对象表示从外部文档提供商(如Google驱动器或Dropbox)链接的文件夹。

有关链接文件夹的详细信息，请参阅链接来自外部应用程序的文档。

直接字段

  • externalIntegrationType

    删除了可能的值：

    • QUIP (Quip)

Op 任务 optask

OpTask对象通常称为“问题”。 问题是一个工作项，它通常表示存在阻止任务或项目完成的问题。 问题也可以是技术支持请求。 变更单、请求和错误也是问题。

直接字段

  • backlogOrder

    顺序指示任务或故事在敏捷积压中的位置。

    此字段删除了以下标志：

    • 动态，
    • 延迟读取，
    • NOT_GROUPABLE：
操作

这些操作添加参数状态以支持新的“开始”按钮功能，当用户单击按钮以指示他们已开始处理工作项时，该功能会更改工作项的状态。

有关详细信息，请参阅将处理此项按钮替换为开始按钮。

  • acceptWork

  • unacceptWork

参数 parameter

Parameter对象是一个自定义字段。

Parameter资源添加了标记SHARABLE。

有关自定义字段的详细信息，请参阅创建或编辑自定义表单中的创建或编辑自定义表单。

直接字段

  • 数据类型

    添加的可能值：

    • RTF（富文本）

      有关详细信息，请参阅Adobe Workfront API中的富文本字段。

  • 显示类型

    添加的可能值：

    • RTF（带格式的文本字段）

      有关详细信息，请参阅Adobe Workfront API中的富文本字段。

  • 标签

    已添加

收藏集字段

  • accessRules

    已添加

默认字段

  • 标签

    已添加

项目组合 portfolio

Portfolio对象是争夺相同资源（通常是资金或人员来完成这些资源）的项目集合。

有关项目组合的详细信息，请参阅Adobe Workfront中的Portfolio概述。

直接字段

  • groupID

    与项目组合关联的组的ID。

引用字段

  • 组

    项目组合关联的组。

项目群 program

项目群对象是项目组合中项目的子集，其中类似的项目可以分组在一起。

直接字段

  • groupID

    与项目关联的组的ID。

引用字段

  • 组

    与项目关联的组。

QueueDef queuedef

QueueDef对象表示队列，这是一个已发布到技术支持区域以允许用户向其提交问题的项目。

有关请求队列的详细信息，请参阅创建请求队列。

直接字段

计划报告 scheduledreport

ScheduledReport对象表示已配置为计划提交的报表。

直接字段

  • 格式

    添加了可能的值：

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

记分卡问题 scorecardquestion

ScoreCardQuestion对象表示已添加到记分卡的问题。 这些问题通常由Portfolio经理决定，这些问题的答案让经理能够了解项目与项目组合目标的符合程度。

有关记分卡问题的详细信息，请参阅创建记分卡。

直接字段

  • 显示类型

    添加的可能值RTF（带格式的文本字段）

    有关详细信息，请参阅Adobe Workfront API中的富文本字段。

任务 task

Task对象表示作为实现最终目标（完成项目）的步骤而必须执行的工作项。

直接字段

  • 工作投入

    添加了此字段，表示用户完成任务需要花费少量、中量或大量的每日工作量。 可能的值包括：

    • 1（小）

    • 2 (Medium)

    • 3 （大）

    有关Workfront中工作投入的详细信息，请参阅工作投入概述。

操作

这些操作添加参数状态以支持新的“开始”按钮功能，当用户单击按钮以指示他们已开始处理工作项时，该功能会更改工作项的状态。

有关详细信息，请参阅将处理此项按钮替换为开始按钮。

  • acceptWork

  • unacceptWork

团队 team

团队对象是可分配给工作项的用户的集合。

直接字段

已将以下字段添加到团队资源：

  • groupID

    此字段将团队与组相关联。 这会将团队标识为组的一部分，并允许组管理员管理团队。

  • workOnItStatusChange

    这是一个布尔参数，指示团队的“处理此项工作”按钮是否已配置为“开始”按钮。 当团队成员单击“开始”按钮开始处理工作项目时，项目的状态将从“新建”更改为团队设置中配置的状态。

  • 以下字段允许您为各个工作项上的“开始”按钮指定自定义状态。

    • workOnItOpTaskBugReportStatuses

    • workOnItOpTaskChangeOrderStatuses

    • workOnItOpTaskIssueStatuses

    • workOnItOpTaskRequestStatuses

      workOnItTaskStatuses

    有关“开始”按钮的详细信息，请参阅将处理它按钮替换为“开始”按钮。

引用字段

以下字段已添加到团队资源：

  • 组

TemplateTask templatetask

TemplateTask对象表示属于Template一部分的Task。 模板任务将成为使用模板的项目中的任务。

有关模板任务的详细信息，请参阅编辑模板任务。

直接字段

  • 工作投入

    添加了此字段，表示用户完成任务需要花费少量、中量或大量的每日工作量。 可能的值包括：

    • 1（小）

    • 2 (Medium)

    • 3 （大）

    有关Workfront中工作投入的详细信息，请参阅工作投入概述。

时间表 timesheet

工时表对象表示一个虚拟工时表，允许用户输入任务、项目和管理费用小时类型的实际工作小时数。

有关时间表的详细信息，请参阅时间表概述

核心字段

以下字段已从时间表资源中删除：

  • objcode

更新

直接字段

  • updateType

    添加了以下可能值：

    • initiativeAdd (enum.updatetypeenum.initiativeadd)

    • initiativeEdit (enum.updatetypeenum.initiativeedit)

    有关计划的详细信息，请参阅Scenario Planner中的计划概述。

用户 user

User对象表示在Workfront中拥有帐户的人员，该帐户可以登录并与系统交互。

直接字段

以下字段已添加到用户资源：

  • actualDeactivationDate

    这表示停用用户的日期和时间。

    有关已停用用户的详细信息，请参阅停用或重新激活用户。

  • alignAccessType

    此字段显示用户对Workfront目标的访问权限。 可能的值包括：

    • 无权访问

    • 查看

    • 编辑

操作

以下操作已添加到User资源：

  • getUserAccessPermissionsByObjCode

    此操作采用以下参数

    • ids（字符串）

    • objCode（字符串）

工作 work

Work对象是Task和OpTask都继承的公用接口，它们共享公用代码。

直接字段

  • backlogOrder

    顺序指示任务或故事在敏捷积压中的位置。

    此字段删除了以下标志：

    • 动态，

    • 延迟读取，

    • NOT_GROUP

  • groupID

    此字段添加了以下标记：

    • AUTO_LOAD

    • 动态，

    • READ_ONLY

  • 工作投入

    添加了此字段，表示用户完成任务需要花费少量、中量或大量的每日工作量。 可能的值包括：

    • 1（小）

    • 2 (Medium)

    • 3 （大）

    有关Workfront中工作投入的详细信息，请参阅工作投入概述。

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