ドキュメントWorkfrontWorkfront ガイド

API バージョン 12 の新機能

最終更新日： 2024年7月18日
  • トピック：

作成対象：

  • 開発者

Workfront は、2020年11月12日（PT）に API バージョン 12 をリリースしました。API バージョン 12 では、バージョン 11 から次の変更が行われました。

追加されたリソース

Workfront API バージョン 12 で次の新しいリソースが追加されました。

  • BreadCrumb
  • RichTextParameterValue

BreadCrumb

BreadCrumb オブジェクトは、Adobe Workfront 作業アイテムの親子階層内の要素を表します。パンくずリストは、作業アイテムがポートフォリオ、プロジェクトおよびタスクの大きい構造にどのように適合するかを示します。

Workfront のパンくずリストについて詳しくは、新しい Adobe Workfront エクスペリエンスのパンくずリストの概要を参照してください。

  • getObjectHierarchy

RichTextParameterValue

より多くのオブジェクトでリッチテキストフィールドを使用できるようになりました。この可用性をサポートするため、RichTextParameterValue オブジェクトが Workfront に追加されました。

詳しくは、Adobe Workfront API のリッチテキストフィールドを参照してください。

  • ID
  • ID
  • objCode

削除されたリソース

API バージョン 12 ではリソースが削除されませんでした。

変更されたリソース

Workfront API バージョン 12 で次のリソースを変更しました。

  • AccessLevel

  • AccessLevelPermissions

  • AccessRequest

  • AccessRule

  • ActivityLog

  • AnnouncementAttachment

  • 承認

  • CalendarSection

  • 会社

  • 顧客

  • CustomerPreferences

  • ドキュメント

  • DocumentVersion

  • グループ

  • LinkedFolder

  • OpTask

  • パラメーター

  • ポートフォリオ

  • プログラム

  • QueueDef

  • ScheduledReport

  • ScoreCardQuestion

  • タスク

  • チーム

  • TemplateTask

  • タイムシート

  • ユーザー

  • 作業

AccessLevel

AccessLevel オブジェクトはユーザーに関連付けられていて、ユーザーのアクセス権を指定する AccessLevelPermissions のセットを表します。

アクセスレベルについて詳しくは、アクセスレベルの仕組みを参照してください。

AccessLevelPermissions

AccessLevelPermissions オブジェクトは、Workfront オブジェクトにアクセス、作成または変更を行うための特定の権限を表します。これらの権限は、アクセスレベルに関連付けることができます。

直接フィールド

  • coreAction

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

      この権限を含むアクセスレベルを持つユーザーは、ワークロードバランサーで予定時間を更新できます。

      詳しくは、ワークロードバランサーでのユーザー割り当ての管理のユーザー割り当て管理時にタスク予定時間数を更新を参照してください。

    • ADD_TO_CUSTOM_FORMS

      この権限を含むアクセスレベルのユーザーは、カスタムフォームにフィールドを追加できます。

      詳しくは、カスタムフォームの作成または編集を参照してください。

    • EDIT_SYSTEMWIDE

      この権限を含むアクセスレベルを持つユーザーは、ユーザーフィールドをシステム全体で削除アクセス権と共有できます。

  • forbiddenActions

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

  • secondaryActions

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

AccessRequest

Workfront のオブジェクトに対する必要なアクセス権をユーザーが持っていない場合、そのオブジェクトへの利用申請を行うことができます。AccessRequest オブジェクトは、このリクエストを表します。

直接フィールド

  • アクション

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

      この権限を含むアクセスレベルを持つユーザーは、ワークロードバランサーで予定時間を更新できます。

      詳しくは、ワークロードバランサーでのユーザー割り当ての管理のユーザー割り当て管理時にタスク予定時間数を更新を参照してください。

    • ADD_TO_CUSTOM_FORMS

      この権限を含むアクセスレベルのユーザーは、カスタムフォームにフィールドを追加できます。

      詳しくは、カスタムフォームの作成または編集を参照してください。

    • EDIT_SYSTEMWIDE

      この権限を含むアクセスレベルを持つユーザーは、ユーザーフィールドをシステム全体で削除アクセス権と共有できます。

AccessRule

AccessRule オブジェクトは、作成したプロジェクトをユーザーが共有する方法を決定する、カスタムアクセスレベルのルールセットを表します。

直接フィールド

  • coreAction

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

      この権限を含むアクセスレベルを持つユーザーは、ワークロードバランサーで予定時間を更新できます。

      詳しくは、ワークロードバランサーでのユーザー割り当ての管理のユーザー割り当て管理時にタスク予定時間数を更新を参照してください。

    • ADD_TO_CUSTOM_FORMS

      この権限を含むアクセスレベルのユーザーは、カスタムフォームにフィールドを追加できます。

      詳しくは、カスタムフォームの作成または編集を参照してください。

    • EDIT_SYSTEMWIDE

      この権限を含むアクセスレベルを持つユーザーは、ユーザーフィールドをシステム全体で削除アクセス権と共有できます。

  • forbiddenActions

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

  • secondaryActions

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

    • ADD_TO_CUSTOM_FORMS

    • EDIT_SYSTEMWIDE

ActivityLog

ActivityLog オブジェクトは、特定の Workfront Proof アカウントで発生したすべてのアクティビティの完全なリストです。

操作

次の操作が ActivityLog オブジェクトから削除されました。

  • ADD

AnnouncementAttachment

AnnouncementAttachment オブジェクトは、Workfront のお知らせに添付されたファイルを表します。

お知らせの添付ファイルについて詳しくは、お知らせの送信を参照してください。

直接フィールド

  • fileExtension

    次の値を追加しました。

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

承認

タスク、ドキュメント、タイムシートなどの所定の作業アイテムは、上司または他のユーザーが承認することが必要な場合があります。承認オブジェクトは、作業アイテムに対する承認の操作を表します。

直接フィールド

  • backlogOrder

    次のフラグを削除しました。

    • DYNAMIC

    • LAZY_READ

    • NOT_GROUPABLE

  • groupID

    次のフラグを追加しました。

    • AUTO_LOAD

    • DYNAMIC

    • READ_ONLY

  • workEffort

    このフィールドは、タスクを完了するためにユーザーが 1 日にあたりに必要とする作業量が小、中、大のどれになるかを表します。次の値を指定できます。

    • 1（小）

    • 2（中）

    • 3（大）

    Workfront の作業量について詳しくは、作業量の概要を参照してください。

CalendarSection

カレンダーセクションは、カレンダーレポートです。

カレンダーレポートの詳細については、カレンダーレポートの概要を参照してください。

直接フィールド

カレンダーレポートでカスタム日付を使用する新機能をサポートするために、次のフィールドが CalendarSection オブジェクトに追加されました。

詳しくは、カレンダーレポートでのカスタム日付フィールドの使用を参照してください。

  • customDate

  • customEndDateParameterID

  • customStartDateParameterID

  • ignoreActualDates

会社

会社オブジェクトは、人物の集まりで構成される組織を表します。

会社について詳しくは、会社の作成と編集を参照してください。

直接フィールド

  • groupID

    会社が関連付けられているグループの ID。

参照フィールド

  • グループ

    会社が関連付けられているグループ。会社をグループに関連付けると、グループ管理者はグループアクセスと会社に対する権限を拡張できます。

顧客

顧客オブジェクトは、Workfront のインスタンスを使用する組織を表します。

アクション

  • productEnabled

    このアクションは、引数 CustomerProductTypeEnum を受け取り、その顧客がその製品のアカウントを持っているかどうかを示すブール値を返します。

CustomerPreferences

CustomerPreferences オブジェクトは、Workfront のインスタンスに対して顧客が設定した一連の環境設定を表します。

直接フィールド

  • 名前

    次の値を追加しました。

    • password:zoomIntegrationEnabled（更新ストリームで Zoom 統合を有効にする）
    • password:quipIntegrationEnabled（config.general.quip.enabled）

ドキュメント

Document オブジェクトは、ファイル（書かれた資料、画像、その他の形式の情報など）を表します。

アクション

  • createLinkedProofVersion

    追加済み

DocumentVersion

DocumentVersion オブジェクトは、ファイルの特定のバージョン（書き込まれた資料、画像、その他の形式の情報など）を表します。

ドキュメントのバージョンについて詳しくは、新しいバージョンのドキュメントのアップロードを参照してください。

直接フィールド

  • externalIntegrationType

    可能性のある値を削除しました：

    • QUIP（Quip）

  • proofDecision

    追加済み

アクション

次のアクションがドキュメントオブジェクトに追加されました。

  • getDocumentReviewerDecision

    このアクションは、documentVersonID 引数（文字列）を受け取り、レビュアーの決定を示すマップを返します。

  • setDocumentReviewerDecision

    このアクションは、次の引数を受け取ります。

    • documentVersionID（文字列）

    • reviewerDecision（文字列）

    • comment (string)

グループ

グループオブジェクトは、一連のユーザーとチームを表します。グループは、多くの場合、部門の構造を表します。

直接フィールド

  • businessLeaderID

    グループに割り当てられたビジネスリーダーの ID。

参照フィールド

  • businessLeader

    グループに割り当てられたビジネスリーダー。ビジネスリーダーとは、グループのビジネス上の決定を行う人物のことです。

    ビジネスリーダーについて詳しくは、ビジネスリーダーの概要を参照してください。

アクション

  • assignMultiple

    このアクションは、次の引数を受け取ります。

    • userIDs (string[])

    • roleIDs (string[])

    • teamID (string)

  • getGroupMembers

  • updateMembersList

    このアクションは、次の引数を受け取ります。

    • newMemberIDs (string[])

    • removedMemberDs (string[])

LinkedFolder

LinkedFolder オブジェクトは、Google Drive や Dropbox など、外部のドキュメントプロバイダからリンクされたフォルダーを表します。

リンクされたフォルダーの詳細情報については、外部アプリケーションからドキュメントをリンクを参照してください。

直接フィールド

  • externalIntegrationType

    可能性のある値を削除しました：

    • QUIP（Quip）

OpTask

OpTask オブジェクトは、一般にイシューと呼ばれます。イシューは、通常、タスクまたはプロジェクトを完了できない問題があることを示す作業アイテムです。イシューは、ヘルプデスクへのリクエストである場合もあります。変更指示、リクエスト、バグもイシューです。

直接フィールド

  • backlogOrder

    順序は、アジャイルバックログ上のタスクまたはストーリーの位置を示します。

    このフィールドは、次のフラグを削除しました。

    • DYNAMIC
    • LAZY_READ
    • NOT_GROUPABLE
アクション

これらのアクションでは、引数のステータスが追加され、新しい「開始」ボタン機能をサポートするようになりました。この機能は、ユーザーがボタンをクリックして、アイテムの作業を開始したことを示す作業アイテムのステータスを変更します。

詳しくは、「作業をする」ボタンを「開始」ボタンに置き換えを参照してください。

  • acceptWork

  • unacceptWork

パラメーター

パラメーターオブジェクトは、カスタムフィールドです。

パラメーターリソースにより、フラグ SHARABLE が追加されました。

カスタムフィールドについて詳しくは、カスタムフォームの作成または編集でカスタムフォームの作成または編集を参照してください。

直接フィールド

  • dataType

    次の値を追加できます。

    • RICH（リッチテキスト）

      詳しくは、Adobe Workfront API のリッチテキストフィールドを参照してください。

  • displayType

    次の値を追加できます。

    • RICH（書式付きテキストフィールド)

      詳しくは、Adobe Workfront API のリッチテキストフィールドを参照してください。

  • ラベル

    追加済み

コレクションフィールド

  • accessRules

    追加済み

デフォルトのフィールド

  • ラベル

    追加済み

ポートフォリオ

ポートフォリオオブジェクトは、同じリソース（通常はプロジェクトを完了するための資金や人材）を競い合って完了するプロジェクトのコレクションです。

ポートフォリオについて詳しくは、Adobe Workfront の Portfolio の概要を参照してください。

直接フィールド

  • groupID

    ポートフォリオが関連付けられているグループの ID。

参照フィールド

  • グループ

    ポートフォリオが関連付けられているグループ。

プログラム

プログラムオブジェクトは、ポートフォリオ内のプロジェクトのサブセットで、類似のプロジェクトを 1 つにグループ化できます。

直接フィールド

  • groupID

    プログラムが関連付けられているグループの ID。

参照フィールド

  • グループ

    プログラムが関連付けられているグループ。

QueueDef

QueueDef オブジェクトは、キューを表します。キューは、ユーザーがイシューを送信できるようにヘルプデスクエリアに公開されたプロジェクトです。

リクエストキューについて詳しくは、リクエストキューの作成を参照してください。

直接フィールド

  • requestorCoreAction

    次の possibleValues が追加されました。

    • PLANNED_HOURS_CONTERING

      この権限を含むアクセスレベルを持つユーザーは、ワークロードバランサーで予定時間を更新できます。

      詳しくは、ワークロードバランサーでのユーザー割り当ての管理のユーザー割り当て管理時にタスク予定時間数を更新を参照してください。

    • ADD_TO_CUSTOM_FORMS

      この権限を含むアクセスレベルのユーザーは、カスタムフォームにフィールドを追加できます。

      詳しくは、カスタムフォームの作成または編集を参照してください。

    • EDIT_SYSTEMWIDE

      この権限を含むアクセスレベルを持つユーザーは、ユーザーフィールドをシステム全体で削除アクセス権と共有できます。

      • PLANNED_HOURS_CONTERING

      • ADD_TO_CUSTOM_FORMS

      • EDIT_SYSTEMWIDE

ScheduledReport

ScheduledReport オブジェクトは、配信のスケジュールを設定したレポートを表します。

直接フィールド

  • 形式

    次の値を追加しました。

    • qdoc (enum.fileextension.qdoc)

    • qslides (enum.fileextension.qslides)

    • qsheet (enum.fileextension.qsheet)

ScoreCardQuestion

ScoreCardQuestion オブジェクトは、スコアカードに追加された質問を表します。これらの質問は通常、ポートフォリオマネージャーが決定し、その回答によって、マネージャーはプロジェクトがポートフォリオの目標にどの程度適合しているかを理解できます。

スコアカードに関する質問について詳しくは、スコアカードを作成を参照してください。

直接フィールド

  • displayType

    可能な値 RICH（書式付きテキストフィールド）を追加しました

    詳しくは、Adobe Workfront API のリッチテキストフィールドを参照してください。

タスク

タスクオブジェクトは、最終目標を達成する（プロジェクトの完了）ためのステップとして実行する必要がある作業項目を表します。

直接フィールド

  • workEffort

    このフィールドは、タスクを完了するためにユーザーが 1 日にあたりに必要とする作業量が小、中、大のどれになるかを表します。次の値を指定できます。

    • 1（小）

    • 2（中）

    • 3（大）

    Workfront の作業量について詳しくは、作業量の概要を参照してください。

アクション

これらのアクションでは、引数のステータスが追加され、新しい「開始」ボタン機能をサポートするようになりました。この機能は、ユーザーがボタンをクリックして、アイテムの作業を開始したことを示す作業アイテムのステータスを変更します。

詳しくは、「作業をする」ボタンを「開始」ボタンに置き換えを参照してください。

  • acceptWork

  • unacceptWork

チーム

チームオブジェクトは、作業アイテムに割り当てることができるユーザーの集まりです。

直接フィールド

チームリソースに次のフィールドが追加されました。

  • groupID

    このフィールドは、チームをグループに関連付けます。これにより、チームがグループの一部として識別され、グループ管理者がチームを管理できるようになります。

  • workOnItStatusChange

    チームの「作業」ボタンが「開始」ボタンとして設定されているかどうかを示すブール値パラメーターです。チームのメンバーが「開始」ボタンをクリックして作業アイテムの作業を開始すると、その項目のステータスが「新規」からチーム設定に設定されたステータスに変わります。

  • 次のフィールドでは、個々の作業アイテムの「開始」ボタンにカスタムステータスを指定できます。

    • workOnItOpTaskBugReportStatuses

    • workOnItOpTaskChangeOrderStatuses

    • workOnItOpTaskIssueStatuses

    • workOnItOpTaskRequestStatuses

      workOnItTaskStatuses

    「開始」ボタンについて詳しくは、「作業」ボタンを「開始」ボタンに置き換えを参照してください。

参照フィールド

チームリソースに次のフィールドが追加されました。

  • グループ

TemplateTask

TemplateTask オブジェクトは、テンプレートに含まれるタスクを表します。テンプレートタスクは、テンプレートが使用されるプロジェクト内のタスクになります。

テンプレートタスクについて詳しくは、テンプレートタスクの編集を参照ください。

直接フィールド

  • workEffort

    このフィールドは、タスクを完了するためにユーザーが 1 日にあたりに必要とする作業量が小、中、大のどれになるかを表します。次の値を指定できます。

    • 1（小）

    • 2（中）

    • 3（大）

    Workfront の作業量について詳しくは、作業量の概要を参照してください。

タイムシート

タイムシートオブジェクトは、タスク、プロジェクトおよびオーバーヘッド時間タイプの実際の時間数をユーザーが入力できる仮想タイムカードを表します。

タイムシートについて詳しくは、タイムシートの概要を参照してください。

コアフィールド

次のフィールドは、タイムシートリソースから削除されました。

  • objcode

アップデート

直接フィールド

  • updateType

    追加された可能な値は次のとおりです。

    • initiativeAdd (enum.updatetypeenum.initiativeadd)

    • initiativeEdit (enum.updatetypeenum.initiativeedit)

    イニシアチブについて詳しくは、シナリオプランナーのイニシアチブの概要を参照してください。

ユーザー

ユーザーオブジェクトは、ログインしてシステムとやり取りできる Workfront アカウントを持つユーザーを表します。

直接フィールド

ユーザーリソースに次のフィールドが追加されました。

  • actualDeactivationDate

    ユーザーが非アクティブ化された日時を表します。

    非アクティブ化されたユーザーについて詳しくは、ユーザーの非アクティブ化または再アクティブ化を参照してください。

  • alignAccessType

    このフィールドには、Workfront Goals へのユーザーのアクセス権が表示されます。次の値を指定できます。

    • アクセスなし

    • 表示

    • 編集

アクション

ユーザーリソースに次のアクションが追加されました。

  • getUserAccessPermissionsByObjCode

    このアクションは、次の引数を取ります。

    • ids（文字列）

    • objCode（文字列）

ワーク

作業オブジェクトは、Task と OpTask の両方が継承する共通のインターフェイスで、2 つの間で共通のコードを共有します。

直接フィールド

  • backlogOrder

    順序は、アジャイルバックログ上のタスクまたはストーリーの位置を示します。

    このフィールドは、次のフラグを削除しました。

    • DYNAMIC

    • LAZY_READ

    • NOT_GROUPABLE

  • groupID

    このフィールドには、次のフラグが追加されました。

    • AUTO_LOAD

    • DYNAMIC

    • READ_ONLY

  • workEffort

    このフィールドは、タスクを完了するためにユーザーが 1 日にあたりに必要とする作業量が小、中、大のどれになるかを表します。次の値を指定できます。

    • 1（小）

    • 2（中）

    • 3（大）

    Workfront の作業量について詳しくは、作業量の概要を参照してください。

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