メソッドの概要

返却値の型 メソッド名
ResultObject delete (AddressbookKey addressbookKey)
アドレスブックを削除します。
ResultObject findList (AddressbookFilter addressbookFilter, PagingParameter target)
アドレスブックを取得します。
ResultObject findList (String companyCd, AddressbookFilter addressbookFilter, PagingParameter target)
アドレスブックを取得します。
ResultObject find (AddressbookKey addressbookKey)
アドレスブックを取得します。
ResultObject register (EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI)
アドレスブックを登録します。
ResultObject register (EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI, String companyCd)
アドレスブックを登録します。
Integer update (EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI)
アドレスブックを更新します。

メソッドの詳細

ResultObject delete (AddressbookKey addressbookKey)
アドレスブックを削除します。
パラメータ
addressbookKey : AddressbookKey
アドレスブックキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject findList (AddressbookFilter addressbookFilter, PagingParameter target)
アドレスブックを取得します。

指定した検索条件に該当するアドレスブックをページ情報分取得します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

  • Addressbook機能管理者
  • Addressbookオーナー

パラメータ
addressbookFilter : AddressbookFilter
検索条件
target : PagingParameter
ページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、PagingAddressbookListItems# を設定します。
ResultObject findList (String companyCd, AddressbookFilter addressbookFilter, PagingParameter target)
アドレスブックを取得します。

指定した検索条件に該当するアドレスブックをページ情報分取得します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

  • Collaboration管理者

パラメータ
companyCd : String
会社コード
addressbookFilter : AddressbookFilter
検索条件
target : PagingParameter
ページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、PagingAddressbookListItems# を設定します。
ResultObject find (AddressbookKey addressbookKey)
アドレスブックを取得します。
パラメータ
addressbookKey : AddressbookKey
アドレスブックキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、AddressbookDisplayItem を設定します。
ResultObject register (EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI)
アドレスブックを登録します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

  • Addressbook機能管理者
  • Addressbookオーナー

パラメータ
addressbook : EditAddressbook
アドレスブック情報
itemDefinition : EditItemDefinition
項目定義情報
additionalItemsI : RegisterAdditionalItemsI[]
独自項目定義(国際)情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、EditAddressbook を設定します。
ResultObject register (EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI, String companyCd)
アドレスブックを登録します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

  • Collaboration管理者

パラメータ
addressbook : EditAddressbook
アドレスブック情報
itemDefinition : EditItemDefinition
項目定義情報
additionalItemsI : RegisterAdditionalItemsI[]
独自項目定義(国際)情報
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、EditAddressbook を設定します。
Integer update (EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI)
アドレスブックを更新します。
パラメータ
addressbook : EditAddressbook
アドレスブック情報
itemDefinition : EditItemDefinition
項目定義情報
additionalItemsI : RegisterAdditionalItemsI[]
独自項目定義(国際)情報
返却値
Integer
Integer 処理件数