イベント登録のバージョン管理
Workfront には、2 つのバージョンのイベント登録があります。 この記事では、それらの違いについて説明します。
新しいバージョンは Workfront API に対する変更ではなく、イベント登録機能に対する変更です。
イベント登録のアップグレードまたはダウングレード機能により、イベントの構造に変更が加えられても既存の登録には影響せず、イベント登録を中断することなく新しいバージョンのテストとアップグレードができます。
イベント登録を別のバージョンにアップグレードまたはダウングレードすると、バージョン変更後 5 分間にわたって、イベント配信ごとに重複したイベントが配信されます。 重複したイベントには、イベント登録バージョン 1 とバージョン 2 がそれぞれ 1 つずつ含まれます。 これにより、イベント登録バージョンを変更しても、イベントを見落とすことがなくなります。
イベントサブスクリプションのアップグレードまたはダウングレードに使用されるエンドポイントについて詳しくは、「イベントサブスクリプション API」の「 イベントサブスクリプションのバージョン管理」を参照してください。
- 25.2 リリース (2025年4月10日): 25.2 リリース以降に作成されたすべての新しいサブスクリプションは、バージョン 2として作成されます。
- 2026年1月15日:残りのバージョン 1 サブスクリプションはすべてバージョン 2に移行されます。
バージョン 1とバージョン 2の変更点
イベント サブスクリプション バージョン 2に対して、次の変更が行われました。
一般的な変更
CREATE イベントが送信され、次にUPDATEがパラメーター値(計算フィールドとその値を含む)とともに送信されます。CREATE イベントのみが送信され、計算フィールドを含むパラメーター値が含まれます。UPDATE イベントのサブスクリプションがあり、計算されたパラメーター値を使用してオブジェクトを作成した後にUPDATE イベントを受信することを想定している場合、そのUPDATE イベントは受信されなくなります。 オブジェクトの作成時に計算パラメーター値を表示するには、追加のCREATE サブスクリプションを作成する必要があります。複数選択タイプフィールドに変更を含む任意のタイプのイベントの場合、フィールドに1つの値のみが含まれている場合、変換され、文字列として送信されます。 それ以外の場合は、配列として送信されます。
例:
myMultiSelectField: ["oneValue"]は変換され、myMultiSelectField: "oneValue"として送信されます。myMultiSelectField: ["first", "second"]はmyMultiSelectField: ["first", "second"]として送信されます。
配列内の値の数に関係なく、配列として送信されます。
例:
myMultiSelectField: ["oneValue"]はmyMultiSelectField: ["oneValue"]として送信されます。myMultiSelectField: ["first", "second"]はmyMultiSelectField: ["first", "second"]として送信されます。
オブジェクト固有の変更
projectIDtaskIDopTaskIDcustomerID
UPDATE イベントで、影響を受けるフィールドがnullからID valueに変更されることが誤って表示されることがありました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他の値が変更された場合は表示されません。referenceObjID
UPDATE イベントに、影響を受けるフィールドがnullからobject idに変更されたことが誤って表示されました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他の値が変更された場合は表示されません。groups
DELETE イベントは、影響を受けるフィールドをbefore状態の空の配列として誤って表示しました。DELETE イベントは、影響を受けるフィールドをbefore状態で正しく表示します。DELETE イベントは引き続き送信されますが、影響を受けるフィールドの正しいデータが表示されるようになりました。proofDecisionproofNameproofProgress
UPDATE イベントが送信されます。 最初のイベントには影響を受けるフィールドが含まれず、2番目のイベントには含まれていました。UPDATE イベントにのみ存在し、2つ目の不要なイベントは送信されません。topReferenceObjCodereferenceObjectName
UPDATE イベントに誤ってEXPNSからPROJへのtopReferenceObjCodeの変更が表示され、referenceObjectNameがnullからstring value of project nameへの変更が表示されました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他の値が変更された場合は表示されません。topReferenceObjCodereferenceObjectName
DELETE イベントが送信される前に、影響を受けるフィールドをnullに変更するUPDATE イベントが送信されました。UPDATE イベントは送信されません。 DELETE イベントには、before状態の影響を受けるフィールドの正しい値があります。UPDATE イベントの影響を受けるフィールドのフィルターがあり、オブジェクトが削除されたときに受信することを想定している場合は、そのUPDATE イベントは受信されなくなります。オブジェクトが削除されたときにこれらのフィールドを表示するには、追加のDELETE サブスクリプションを作成する必要があります。projectIDtaskIDroleIDtimesheetIDhourTypeIDprojectOverheadIDreferenceObjIDreferenceObjCodesecurityRootID
DELETE イベントは、影響を受けるフィールドを誤ってbefore状態のnullとして表示しました。DELETE イベントは、影響を受けるフィールドをbefore状態で正しく表示します。DELETE イベントは引き続き送信されますが、影響を受けるフィールドの正しいデータが表示されるようになりました。rootGroupID
UPDATE イベントに、影響を受けるフィールドがnullからID valueに変更されたことが誤って表示されました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他のパラメーター値が変更された場合は表示されません。resolveProjectIDresolveTaskIDresolvingObjID
UPDATE イベントで、影響を受けるフィールドがnullからID valueに変更されることが誤って表示されることがありました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。rootGroupID
UPDATE イベントに、影響を受けるフィールドがnullからID valueに変更されたことが誤って表示されました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他のパラメーター値が変更された場合は表示されません。convertedOpTaskID
UPDATE イベントで、影響を受けるフィールドがnullからID valueに変更されることが誤って表示されることがありました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他のパラメーター値が変更された場合は表示されません。rootGroupID
UPDATE イベントに、影響を受けるフィールドがnullからID valueに変更されたことが誤って表示されました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他のパラメーター値が変更された場合は表示されません。convertedOpTaskID
UPDATE イベントで、影響を受けるフィールドがnullからID valueに変更されることが誤って表示されることがありました。UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE イベントが表示されます。他のパラメーター値が変更された場合は表示されません。Workfront Fusion シナリオでのイベントサブスクリプションバージョンの更新
Workfront Fusionでは、イベントサブスクリプションを使用して、Workfrontからトリガーへの変更を監視します。 Fusionがシナリオで直接使用するイベント購読バージョンを更新するには、Workfront/イベントペイロードバージョンを更新モジュールを使用します。
このモジュールの使用方法については、Workfront Fusion ドキュメントのWorkfront モジュール を参照してください。
ウェビナーの録画など、イベント登録のアップグレード中に Workfront Fusion シナリオを保持する方法について詳しくは、イベント登録 V2 のアップグレード中の Fusion シナリオの保持を参照してください。