イベント購読のバージョン管理

最終更新日： 2025年4月1日
  • トピック：

作成対象：

  • 開発者

Workfrontには、2 つのバージョンのイベント購読があります。 この記事では、これらの違いについて説明します。

新しいバージョンはWorkfront API に対する変更ではなく、イベント購読機能に対する変更です。

イベント購読をアップグレードまたはダウングレードする機能により、イベントの構造に変更が加えられても既存の購読が壊れずに、イベント購読に隙間なく新しいバージョンのテストとアップグレードが可能になります。

イベント購読を別のバージョンにアップグレードまたはダウングレードすると、バージョン変更後 5 分間、イベント配信ごとに重複したイベントが届きます。 重複には、イベント購読バージョン 1 とバージョン 2 がそれぞれ 1 つずつ含まれます。 これにより、イベント購読バージョンの変更に伴うイベントが見逃されなくなります。

イベント購読のアップグレードまたはダウングレードに使用されるエンドポイントについて詳しくは、イベント購読 API 記事の イベント購読のバージョン管理を参照してください。

IMPORTANT
次のリリースは、イベント購読のバージョン管理に影響します。
  • 25.2 リリース （2025 年 4 月 10 日（PT））:25.2 リリース以降に作成された新しいサブスクリプションはすべて、バージョン 2 として作成されます。
  • 25.3 リリース （2025 年 7 月 17 日（PT））:25.3 リリース後、サブスクリプションをバージョン 1 にアップグレードできなくなりました。
  • 2025 年 9 月 1 日：残りのすべてのバージョン 1 サブスクリプションがバージョン 2 に移行されます。

バージョン 1 とバージョン 2 の間の変更

イベント購読バージョン 2 に対して次の変更が行われました。

一般的な変更点

影響を受けるフィールドバージョン 1 （以前の動作）バージョン 2 （変更）修正アクション
パラメーター値カスタムフォームを含むテンプレートから作成された任意のオブジェクトの場合、CREATE イベントが送信された後、パラメーター値（計算フィールドとその値を含む）を含む UPDATE が送信されました。計算フィールドを含むパラメーター値を含む CREATE イベントのみが送信されます。パラメーター値（計算カスタムフィールドを含む）を持つ UPDATE イベントにフィルターがあり、パラメーター値を含むオブジェクト CREATE イベントの後に受け取ることを想定している場合、その UPDATE イベントは受け取らなくなります。 オブジェクトの作成時にパラメーター値を表示する場合は、追加の CREATE サブスクリプションを作成する必要があります。
複数選択タイプフィールド

複数選択タイプのフィールドに対する変更を含むイベントタイプの場合、フィールドに値が 1 つしか含まれていなければ、変換されて文字列として送信されます。 それ以外の場合は、配列として送信されます。

例：

  • myMultiSelectField: ["oneValue"] は変換され、myMultiSelectField: "oneValue" として送信されます。
  • myMultiSelectField: ["first", "second"] は myMultiSelectField: ["first", "second"] として送信されます。

配列内の値の数に関係なく、配列として送信されます。

例：

  • myMultiSelectField: ["oneValue"] は myMultiSelectField: ["oneValue"] として送信されます。
  • myMultiSelectField: ["first", "second"] は myMultiSelectField: ["first", "second"] として送信されます。
複数選択フィールドに対するフィルターを持つ購読があり、値を文字列とする場合、値を配列として持つのと同じフィルターを持つ新しい購読を作成する必要があります。

オブジェクト固有の変更

オブジェクトコード影響を受けるフィールドバージョン 1 （以前の動作）バージョン 2 （変更）是正措置
ASSGN
  • projectID
  • taskID
  • opTaskID
  • customerID
このオブジェクトが更新されると、UPDATE イベントで、影響を受けるフィールドが null から ID value に変更されることが誤って表示されることがありました。すべての UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。なし。影響を受けるフィールドにフィルターがある場合、UPDATE のイベントは、これらのフィールドが実際に変更された場合にのみ受け取り、その他の値が変更された場合には受け取りません。
DOCU
  • referenceObjID
このオブジェクトのパラメーター値が更新されると、UPDATE イベントで、影響を受けるフィールドが null から object id に変更されたことが誤って表示されていました。すべての UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。なし。影響を受けるフィールドにフィルターがある場合、UPDATE のイベントは、これらのフィールドが実際に変更された場合にのみ受け取り、その他の値が変更された場合には受け取りません。
  • groups
ドキュメントが削除されると、DELETE イベントで、影響を受けるフィールドが事前状態の空の配列として誤って表示されていました。DELETE イベントは、影響を受けるフィールドを事前状態で正しく表示します。なし。DELETE イベントは引き続き送信されますが、影響を受けるフィールドの正しいデータが表示されるようになりました。
DOCV
  • proofDecision
  • proofName
  • proofProgress
このオブジェクトが更新されると、2 つの UPDATE イベントが送信されます。 最初のイベントには影響を受けるフィールドは含まれませんでしたが、2 番目のイベントには含まれていました。影響を受けるフィールドを含むすべてのフィールド更新が 1 つの UPDATE イベントにのみ存在し、2 つ目の不要なイベントは送信されません。なし。影響を受けるフィールドにフィルターがある場合、イベントは最初のイベントで配信されます。
EXPNS
  • 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 イベントは引き続き送信されますが、影響を受けるフィールドの正しいデータが表示されるようになりました。
OPTASK
  • rootGroupID
このオブジェクトのパラメーター値が更新されると、UPDATE イベントで、影響を受けるフィールドが null から ID value に変更されたことが誤って表示されていました。すべての UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。なし。影響を受けるフィールドにフィルターがある場合、そのフィールドが実際に変更された場合にのみ UPDATE イベントが返され、他のパラメーター値が変更された場合には返されません。
  • resolveProjectID
  • resolveTaskID
  • resolvingObjID
このオブジェクトが更新されると、UPDATE イベントで、影響を受けるフィールドが null から ID value に変更されることが誤って表示されることがありました。すべての UPDATE イベントには、影響を受けるフィールドの正しい値が表示されます。
PROJ
  • 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 イベントが返され、他のパラメーター値が変更された場合には返されません。