Data API 23.1 の OCAPI フック
OCAPI のバージョン 23.1 では以下のフックを使用できます。
Data API の Content (コンテンツ) フック。
dw.ocapi.data.content.content.afterCreate
PUT /libraries/{library_id}/content/{content_id}
メソッドの詳細
afterCreate (library : dw.content.Library, content : dw.content.Content, create : ContentAsset) : dw.system.Status
この関数は、新規コンテンツアセットが作成された後で呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- content - 新規コンテンツアセット。
- create - コンテンツアセット作成ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.content.afterDelete
DELETE /libraries/{library_id}/content/{content_id}
メソッドの詳細
afterDelete (library : dw.content.Library) : dw.system.Status
この関数は、コンテンツアセットが削除された後で呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.content.afterUpdate
PATCH /libraries/{library_id}/content/{content_id}
メソッドの詳細
afterUpdate (library : dw.content.Library, content : dw.content.Content, update : ContentAsset) : dw.system.Status
この関数は、更新ドキュメントを使用してコンテンツアセットが更新された後で呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- content - 更新するコンテンツアセット。
- update - 更新ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.content.beforeCreate
PUT /libraries/{library_id}/content/{content_id}
メソッドの詳細
beforeCreate (library : dw.content.Library, create : ContentAsset) : dw.system.Status
この関数は、指定されたドキュメントでコンテンツアセットが作成される前に呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- create - コンテンツアセット作成ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.content.beforeDelete
DELETE /libraries/{library_id}/content/{content_id}
メソッドの詳細
beforeDelete (library : dw.content.Library, content : dw.content.Content) : dw.system.Status
この関数は、コンテンツアセットが削除される前に呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- content - 削除するコンテンツアセット。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.content.beforeUpdate
PATCH /libraries/{library_id}/content/{content_id}
メソッドの詳細
beforeUpdate (library : dw.content.Library, content : dw.content.Content, update : ContentAsset) : dw.system.Status
この関数は、更新ドキュメントを使用してコンテンツアセットが更新される前に呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- content - 更新するコンテンツアセット。
- update - 更新ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Content Folder (コンテンツフォルダー) フック。
dw.ocapi.data.content.folder.afterCreate
PUT /libraries/{library_id}/folders/{folder_id}
メソッドの詳細
afterCreate (library : dw.content.Library, folder : dw.content.Folder, create : ContentFolder) : dw.system.Status
この関数は、新規コンテンツフォルダーが作成された後で呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- folder - 新規コンテンツフォルダー。
- create - コンテンツフォルダー作成ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.folder.afterDelete
DELETE /libraries/{library_id}/folders/{folder_id}
メソッドの詳細
afterDelete (library : dw.content.Library) : dw.system.Status
この関数は、コンテンツフォルダーが削除された後で呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.folder.afterUpdate
PATCH /libraries/{library_id}/folders/{folder_id}
メソッドの詳細
afterUpdate (library : dw.content.Library, folder : dw.content.Folder, update : ContentFolder) : dw.system.Status
この関数は、更新ドキュメントを使用してコンテンツフォルダーが更新された後で呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- folder - 更新するコンテンツフォルダー。
- update - 更新ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.folder.beforeCreate
PUT /libraries/{library_id}/folders/{folder_id}
メソッドの詳細
beforeCreate (library : dw.content.Library, create : ContentFolder) : dw.system.Status
この関数は、指定されたドキュメントでコンテンツフォルダーが作成される前に呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- folder - コンテンツフォルダー作成ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.folder.beforeDelete
DELETE /libraries/{library_id}/folders/{folder_id}
メソッドの詳細
beforeDelete (library : dw.content.Library, folder : dw.content.Folder) : dw.system.Status
この関数は、コンテンツフォルダーが削除される前に呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- folder - 削除するコンテンツフォルダー。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.content.folder.beforeUpdate
PATCH /libraries/{library_id}/folders/{folder_id}
メソッドの詳細
beforeUpdate (library : dw.content.Library, folder : dw.content.Folder, update : ContentFolder) : dw.system.Status
この関数は、更新ドキュメントを使用してコンテンツフォルダーが更新される前に呼び出されます。
- パラメーター:
- library - 実際のコンテキスト内のライブラリ
- folder - 更新するコンテンツフォルダー。
- update - 更新ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Customer (顧客) フック。
dw.ocapi.data.customer_list.customer.afterDELETE
DELETE /customer_lists/{list_id}/customers/{customer_no}
メソッドの詳細
afterDelete (customerListId : String) : dw.system.Status
この関数は、顧客が削除された後で呼び出されます。
- パラメーター:
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.afterPATCH
PATCH /customer_lists/{list_id}/customers/{customer_no}
メソッドの詳細
afterPatch (customer : dw.customer.Customer, update : Customer, customerListId : String) : dw.system.Status
この関数は、更新ドキュメントを使用して顧客が更新された後で呼び出されます。
- パラメーター:
- customer - 更新する顧客。
- update - 更新ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.beforeDELETE
DELETE /customer_lists/{list_id}/customers/{customer_no}
メソッドの詳細
beforeDelete (customer : dw.customer.Customer, customerListId : String) : dw.system.Status
この関数は、顧客が削除される前に呼び出されます。
- パラメーター:
- customer - 削除する顧客
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.beforePATCH
PATCH /customer_lists/{list_id}/customers/{customer_no}
メソッドの詳細
beforePatch (customer : dw.customer.Customer, update : Customer, customerListId : String) : dw.system.Status
この関数は、更新ドキュメントを使用して顧客が更新される前に呼び出されます。
- パラメーター:
- customer - 更新する顧客。
- update - 更新ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Customers (顧客) フック。
dw.ocapi.data.customer_list.customers.afterPOST
POST /customer_lists/{list_id}/customers
メソッドの詳細
afterPost (customer : dw.customer.Customer, create : Customer, customerListId : String) : dw.system.Status
この関数は、新規顧客が作成された後で呼び出されます。
- パラメーター:
- customer - 新規顧客。
- create - 顧客作成ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customers.afterPUT
PUT /customer_lists/{list_id}/customers/{customer_no}
メソッドの詳細
afterPut (customer : dw.customer.Customer, create : Customer, customerListId : String) : dw.system.Status
この関数は、新規顧客が作成された後で呼び出されます。
- パラメーター:
- customer - 新規顧客。
- create - 顧客作成ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customers.beforePOST
POST /customer_lists/{list_id}/customers
メソッドの詳細
beforePost (create : Customer, customerListId : String) : dw.system.Status
この関数は、指定されたドキュメントで顧客が作成される前に呼び出されます。
- パラメーター:
- create - 顧客作成ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customers.beforePUT
PUT /customer_lists/{list_id}/customers/{customer_no}
メソッドの詳細
beforePut (create : Customer, customerListId : String) : dw.system.Status
この関数は、指定されたドキュメントで顧客が作成される前に呼び出されます。
- パラメーター:
- create - 顧客作成ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Customer Address (顧客の住所) フック。
dw.ocapi.data.customer_list.customer.address.afterDELETE
DELETE /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
メソッドの詳細
afterDelete (customer : dw.customer.Customer, customerListId : String) : dw.system.Status
この関数は、顧客住所が削除された後で呼び出されます。
- パラメーター:
- customer - 住所の削除対象の顧客。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.address.afterPATCH
PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
メソッドの詳細
afterPatch (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, update : CustomerAddress, customerListId : String) : dw.system.Status
この関数は、更新ドキュメントを使用して顧客住所が更新された後で呼び出されます。
- パラメーター:
- customer - 住所の更新対象の顧客。
- update - 更新ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.address.beforeDELETE
DELETE /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
メソッドの詳細
beforeDelete (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, customerListId : String) : dw.system.Status
この関数は、顧客が削除される前に呼び出されます。
- パラメーター:
- customer - 住所の削除対象の顧客。
- customerAddress - 削除する顧客住所。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.address.beforePATCH
PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
メソッドの詳細
beforePatch (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, update : CustomerAddress, customerListId : String) : dw.system.Status
この関数は、更新ドキュメントを使用して顧客住所が更新される前に呼び出されます。
- パラメーター:
- customer - 住所の更新対象の顧客。
- customerAddress - 更新する顧客住所。
- update - 更新ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Customer Addresses (顧客の住所) フック。
dw.ocapi.data.customer_list.customer.addresses.afterPOST
POST /customer_lists/{list_id}/customers/{customer_no}/addresses
メソッドの詳細
afterPost (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, create : CustomerAddress, customerListId : String) : dw.system.Status
この関数は、新規顧客住所が作成された後で呼び出されます。
- パラメーター:
- customer - 住所の作成対象の顧客。
- customerAddress - 新規顧客住所。
- create - 顧客住所作成ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.customer_list.customer.addresses.beforePOST
POST /customer_lists/{list_id}/customers/{customer_no}/addresses
メソッドの詳細
beforePost (customer : dw.customer.Customer, create : CustomerAddress, customerListId : String) : dw.system.Status
この関数は、指定されたドキュメントで顧客住所が作成される前に呼び出されます。
- パラメーター:
- customer - 住所の作成対象の顧客。
- create - 顧客住所作成ドキュメント。
- customerListId - 顧客が割り当てられている顧客リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Object (オブジェクト) フック。
dw.ocapi.data.object.afterDelete
DELETE /custom_objects/{object_type}/{key}
メソッドの詳細
afterDelete () : dw.system.Status
この関数は、カスタムオブジェクトが削除された後に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.afterDelete
DELETE /sites/{site_id}/custom_objects/{object_type}/{key}
メソッドの詳細
afterDelete () : dw.system.Status
この関数は、カスタムオブジェクトが削除された後に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.afterPatch
PATCH /custom_objects/{object_type}/{key}
メソッドの詳細
afterPatch (customObject : dw.object.CustomObject, create : CustomObject) : dw.system.Status
この関数は、更新ドキュメントを使用してカスタムオブジェクトが更新された後に呼び出されます。
- パラメーター:
- customObject - 更新されたカスタムオブジェクト
- update - 更新ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.afterPatch
PATCH /sites/{site_id}/custom_objects/{object_type}/{key}
メソッドの詳細
afterPatch (customObject : dw.object.CustomObject, create : CustomObject) : dw.system.Status
この関数は、更新ドキュメントを使用してカスタムオブジェクトが更新された後に呼び出されます。
- パラメーター:
- customObject - 更新されたカスタムオブジェクト
- update - 更新ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.afterPut
PUT /custom_objects/{object_type}/{key}
メソッドの詳細
afterPut (customObject : dw.object.CustomObject, create : CustomObject) : dw.system.Status
この関数は、作成ドキュメントを使用してカスタムオブジェクトが作成された後に呼び出されます。
- パラメーター:
- customObject - 作成されたカスタムオブジェクト
- create - 作成ドキュメント。
null も可能。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.afterPut
PUT /sites/{site_id}/custom_objects/{object_type}/{key}
メソッドの詳細
afterPut (customObject : dw.object.CustomObject, create : CustomObject) : dw.system.Status
この関数は、作成ドキュメントを使用してカスタムオブジェクトが作成された後に呼び出されます。
- パラメーター:
- customObject - 作成されたカスタムオブジェクト
- create - 作成ドキュメント。
null も可能。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.beforeDelete
DELETE /custom_objects/{object_type}/{key}
メソッドの詳細
beforeDelete (customObject : dw.object.CustomObject) : dw.system.Status
この関数は、カスタムオブジェクトが削除される前に呼び出されます。
- パラメーター:
- create - 作成ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.beforeDelete
DELETE /sites/{site_id}/custom_objects/{object_type}/{key}
メソッドの詳細
beforeDelete (customObject : dw.object.CustomObject) : dw.system.Status
この関数は、カスタムオブジェクトが削除される前に呼び出されます。
- パラメーター:
- create - 作成ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.beforePatch
PATCH /custom_objects/{object_type}/{key}
メソッドの詳細
beforePatch (customObject : dw.object.CustomObject, update : CustomObject) : dw.system.Status
この関数は、更新ドキュメントを使用してカスタムオブジェクトが更新される前に呼び出されます。
- パラメーター:
- update - 更新ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.beforePatch
PATCH /sites/{site_id}/custom_objects/{object_type}/{key}
メソッドの詳細
beforePatch (customObject : dw.object.CustomObject, update : CustomObject) : dw.system.Status
この関数は、更新ドキュメントを使用してカスタムオブジェクトが更新される前に呼び出されます。
- パラメーター:
- update - 更新ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.beforePut
PUT /custom_objects/{object_type}/{key}
メソッドの詳細
beforePut (create : CustomObject) : dw.system.Status
この関数は、作成ドキュメントを使用してカスタムオブジェクトが作成される前に呼び出されます。
- パラメーター:
- create - 作成ドキュメント。
null も可能。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.data.object.beforePut
PUT /sites/{site_id}/custom_objects/{object_type}/{key}
メソッドの詳細
beforePut (create : CustomObject) : dw.system.Status
この関数は、作成ドキュメントを使用してカスタムオブジェクトが作成される前に呼び出されます。
- パラメーター:
- create - 作成ドキュメント。
null も可能。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Data API の Users (ユーザー) フック。
dw.ocapi.data.users.afterPATCH
PATCH /users/this/password
メソッドの詳細
afterPatch (login : String , email : String) : dw.system.Status
この関数は、ユーザーのパスワードが更新された後で呼び出されます。
- パラメーター:
- login - ユーザーのログイン。
- email - ユーザーの Eメール。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します