メソッドの概要

返却値の型 メソッド名
ResultObject addCategoryTop (CategoryDetail category, String companyCd)
TOPカテゴリを追加します。
ResultObject addCategory (CategoryDetail category)
カテゴリを追加します。
ResultObject changeSort (CategoryKey parentKey, CategoryKey key, Integer fromSortKey, Integer toSortKey)
カテゴリ表示順を更新します。
ResultObject deleteCategory (CategoryKey[] keys)
カテゴリを削除します。
ResultObject findCategoryDirectList (CategoryKey key)
カテゴリ直下のカテゴリを取得します。
ResultObject findCategoryLimitedList (CategoryKey key)
カテゴリ配下のカテゴリを取得します。
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では、以下の管理者が操作可能です。

  • Collraboration管理者
  • Workspace機能管理者

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

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

パラメータ
category : CategoryDetail
カテゴリ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、WorkspaceCategoryDetail を設定します。
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 deleteCategory (CategoryKey[] keys)
カテゴリを削除します。

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

  • Collraboration管理者
  • Workspace管理者

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

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

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

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

パラメータ
key : CategoryKey
カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、WorkspaceCategory[] を設定します。
ResultObject findCategoryListTop ()
TOPカテゴリを取得します。

管理権限の範囲で操作可能なTOPカテゴリをすべて取得します。

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

  • Workspace機能管理者
  • Workspaceカテゴリオーナー

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

指定した会社コードに該当するTOPカテゴリを取得します。

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

  • Collaboration管理者

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

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

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

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