メソッドの概要

返却値の型 メソッド名
ResultObject addCategoryTop (CategoryDetail category, String companyCd) 非推奨
TOP施設カテゴリを登録します。
ResultObject addCategory (CategoryDetail category)
施設カテゴリを追加します。
ResultObject addTopCategory (CategoryDetail category, String companyCd)
TOP施設カテゴリを登録します。
ResultObject changeSort (CategoryKey parentKey, CategoryKey key, Integer fromSortKey, Integer toSortKey)
カテゴリ表示順を更新します。
ResultObject deleteCategoryWithResource (Array keys, String companyCd)
施設カテゴリを削除します。
ResultObject deleteCategory (CategoryKey[] keys)
施設カテゴリを削除します。
ResultObject findCategoryDirectList (CategoryKey key)
施設カテゴリ直下の施設カテゴリを取得します。
ResultObject findCategoryLimitedList (CategoryKey key)
施設カテゴリ配下の施設カテゴリを取得します。
ResultObject findCategoryListAll (String companyCd)
施設カテゴリ配下の施設カテゴリを取得します。
ResultObject findCategoryListTop ()
TOP施設カテゴリを取得します。
ResultObject findCategoryListTop (String companyCd)
TOP施設カテゴリを取得します。
ResultObject findCategory (CategoryKey key)
施設カテゴリを取得します。
ResultObject updateCategory (CategoryDetail category)
施設カテゴリを更新します。

メソッドの詳細

ResultObject addCategoryTop (CategoryDetail category, String companyCd) 非推奨
TOP施設カテゴリを登録します。

指定した会社コードの施設カテゴリとして登録します。
会社コードがNULLの場合、カレント組織の会社の施設カテゴリとして登録します。

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

  • Collaboration管理者
  • Schedule機能管理者

パラメータ
category : CategoryDetail
カテゴリ情報
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategoryDetail が設定されます。
ResultObject addCategory (CategoryDetail category)
施設カテゴリを追加します。

カレント組織の会社の施設カテゴリとして追加します。

パラメータ
category : CategoryDetail
カテゴリ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategoryDetail が設定されます。
ResultObject addTopCategory (CategoryDetail category, String companyCd)
TOP施設カテゴリを登録します。

指定した会社コードの施設カテゴリとして登録します。
会社コードがNULLの場合、カレント組織の会社の施設カテゴリとして登録します。

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

  • Collaboration管理者
  • Schedule機能管理者

パラメータ
category : CategoryDetail
カテゴリ情報
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategoryDetail が設定されます。
ResultObject changeSort (CategoryKey parentKey, CategoryKey key, Integer fromSortKey, Integer toSortKey)
カテゴリ表示順を更新します。

同じ親カテゴリ内の子カテゴリの表示順を更新します。
親カテゴリキーがNULLの場合、TOPカテゴリの表示順を更新します。
但し、TOPカテゴリの表示順更新は、Collaboration管理者のみ操作が可能です。

パラメータ
parentKey : CategoryKey
親カテゴリキー
key : CategoryKey
移動元の施設カテゴリキー
fromSortKey : Integer
移動元の表示順位置
toSortKey : Integer
移動先の表示順位置
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 が設定されます。
ResultObject deleteCategoryWithResource (Array keys, String companyCd)
施設カテゴリを削除します。

[ TOP施設カテゴリの削除について ]
TOP施設カテゴリは、以下の管理者のみ削除が可能です。

  • Collaboration管理者
  • Schedule管理者

パラメータ
keys : Array
施設カテゴリキー(CategoryKey)の配列
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategoryKey[] が設定されます。
ResultObject deleteCategory (CategoryKey[] keys)
施設カテゴリを削除します。

[ TOP施設カテゴリの削除について ]
TOP施設カテゴリは、以下の管理者のみ削除が可能です。

  • Collaboration管理者
  • Schedule管理者

パラメータ
keys : CategoryKey[]
施設カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategoryKey[] が設定されます。
ResultObject findCategoryDirectList (CategoryKey key)
施設カテゴリ直下の施設カテゴリを取得します。

取得結果の順序は、ソートキーの昇順となります。
直下にカテゴリがない場合、空の配列を返却します。

パラメータ
key : CategoryKey
施設カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategory[] が設定されます。
ResultObject findCategoryLimitedList (CategoryKey key)
施設カテゴリ配下の施設カテゴリを取得します。

取得結果の順序は、ソートキーの昇順となります。
配下にカテゴリがない場合、空の配列を返却します。

パラメータ
key : CategoryKey
施設カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategory[] が設定されます。
ResultObject findCategoryListAll (String companyCd)
施設カテゴリ配下の施設カテゴリを取得します。

配下にカテゴリがない場合、空の配列を返却します。

パラメータ
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategory[] が設定されます。
ResultObject findCategoryListTop ()
TOP施設カテゴリを取得します。

管理権限の範囲で操作可能なTOPカテゴリをすべて取得します。
取得結果の順序は、ソートキーの昇順となります。

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

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

返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategory[] が設定されます。
ResultObject findCategoryListTop (String companyCd)
TOP施設カテゴリを取得します。

指定した会社コードに該当するTOP施設カテゴリを取得します。
取得結果の順序は、ソートキーの昇順となります。

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

  • Collaboration管理者

パラメータ
companyCd : String
会社コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategory[] が設定されます。
ResultObject findCategory (CategoryKey key)
施設カテゴリを取得します。
パラメータ
key : CategoryKey
施設カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleCategoryDetail が設定されます。
ResultObject updateCategory (CategoryDetail category)
施設カテゴリを更新します。

[ 施設カテゴリの移動について ]
施設カテゴリを行うと、指定したカテゴリに付与しているアクセス権が全て削除されます。
施設カテゴリの移動は、管理権限によってできるものが異なります。

  • TOPカテゴリを異なるTOPカテゴリへの移動は、Collaboration管理者またはSchedule機能管理者が利用可能です。
  • 子カテゴリからTOPカテゴリへの移動は、Collaboration管理者またはSchedule機能管理者が利用可能です。
  • 異なるTOPカテゴリ間での移動は、Collaboration管理者またはSchedule機能管理者、Scheduleオーナーが利用可能です。
  • 同一TOPカテゴリ間での移動は、Collaboration管理者またはSchedule機能管理者、Scheduleオーナーが利用可能です。

パラメータ
category : CategoryDetail
施設カテゴリ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 が設定されます。