イベント購読のバージョン管理
Workfrontには、2 つのバージョンのイベント購読があります。 この記事では、これらの違いについて説明します。
新しいバージョンはWorkfront API に対する変更ではなく、イベント購読機能に対する変更です。
イベント購読をアップグレードまたはダウングレードする機能により、イベントの構造に変更が加えられても既存の購読が壊れずに、イベント購読に隙間なく新しいバージョンのテストとアップグレードが可能になります。
イベント購読を別のバージョンにアップグレードまたはダウングレードすると、バージョン変更後 5 分間、イベント配信ごとに重複したイベントが届きます。 重複には、イベント購読バージョン 1 とバージョン 2 がそれぞれ 1 つずつ含まれます。 これにより、イベント購読バージョンの変更に伴うイベントが見逃されなくなります。
イベント購読のアップグレードまたはダウングレードに使用されるエンドポイントについて詳しくは、イベント購読 API 記事の イベント購読のバージョン管理を参照してください。
- 25.2 リリース (2025 年 4 月 10 日(PT)):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"]
として送信されます。
オブジェクト固有の変更
projectID
taskID
opTaskID
customerID
UPDATE
イベントで、影響を受けるフィールドが null
から ID value
に変更されることが誤って表示されることがありました。UPDATE
イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE
のイベントは、これらのフィールドが実際に変更された場合にのみ受け取り、その他の値が変更された場合には受け取りません。referenceObjID
UPDATE
イベントで、影響を受けるフィールドが null
から object id
に変更されたことが誤って表示されていました。UPDATE
イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE
のイベントは、これらのフィールドが実際に変更された場合にのみ受け取り、その他の値が変更された場合には受け取りません。groups
DELETE
イベントで、影響を受けるフィールドが事前状態の空の配列として誤って表示されていました。DELETE
イベントは、影響を受けるフィールドを事前状態で正しく表示します。DELETE
イベントは引き続き送信されますが、影響を受けるフィールドの正しいデータが表示されるようになりました。proofDecision
proofName
proofProgress
UPDATE
イベントが送信されます。 最初のイベントには影響を受けるフィールドは含まれませんでしたが、2 番目のイベントには含まれていました。UPDATE
イベントにのみ存在し、2 つ目の不要なイベントは送信されません。topReferenceObjCode
referenceObjectName
UPDATE
イベントで、topReferenceObjCode が EXPNS
から PROJ
に変更され、referenceObjectName
が null
から string value of project name
に変更されたことが誤って表示されていました。UPDATE
イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE
のイベントは、これらのフィールドが実際に変更された場合にのみ受け取り、その他の値が変更された場合には受け取りません。topReferenceObjCode
referenceObjectName
UPDATE
イベントが送信され、DELETE
イベントが送信される前に、影響を受けるフィールドが null に変更されました。UPDATE
イベントは送信されません。 DELETE
イベントには、before 状態の影響を受けるフィールドに対する正しい値があります。UPDATE
イベントの影響を受けるフィールドのフィルターがあり、オブジェクトが削除されたときに受け取ることを期待していた場合、その UPDATE
イベントは受け取らなくなります。 オブジェクトの削除時にこれらのフィールドを表示する場合は、追加の DELETE
サブスクリプションを作成する必要があります。projectID
taskID
roleID
timesheetID
hourTypeID
projectOverheadID
referenceObjID
referenceObjCode
securityRootID
DELETE
イベントで、影響を受けるフィールドが null
のように誤って表示されていました。DELETE
イベントは、影響を受けるフィールドを事前状態で正しく表示します。DELETE
イベントは引き続き送信されますが、影響を受けるフィールドの正しいデータが表示されるようになりました。rootGroupID
UPDATE
イベントで、影響を受けるフィールドが null
から ID value
に変更されたことが誤って表示されていました。UPDATE
イベントには、影響を受けるフィールドの正しい値が表示されます。UPDATE
イベントが返され、他のパラメーター値が変更された場合には返されません。resolveProjectID
resolveTaskID
resolvingObjID
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 シナリオを保持するを参照してください。