Accel Collaboration

iac_information.SharedTagAdminServiceオブジェクト

コンポーネント情報
version	8.0.1

コンポーネント概要

インフォメーションの共有タグに対する管理操作を提供するサービスです。

[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。

[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。

Collaboration管理者ロールを持つユーザ
Information機能管理者ロールを持つユーザ

メソッドの概要

返却値の型	メソッド名
ResultObject	add (SharedTag `tag`) 共有タグを追加します。
ResultObject	add (String `companyCd`, SharedTag `tag`) 共有タグを追加します。
ResultObject	delete (SharedTagKey[] `keys`) 共有タグを削除します。
ResultObject	findList (SharedTagFilter `filter`) 共有タグを取得します。
ResultObject	findList (String `companyCd`, SharedTagFilter `filter`) 共有タグを取得します。
ResultObject	find (SharedTagKey `key`) 共有タグの詳細情報を取得します。
ResultObject	update (SharedTag `tag`) 共有タグを更新します。

メソッドの詳細

ResultObject add (SharedTag tag)

共有タグを追加します。

カレント組織の会社の共有タグとして追加します。

[ 利用可能な管理者について ]
このAPIは、機能管理者ロールをもつユーザのみ操作可能です。
またユーザコンテキストのカレント組織に所属組織情報が存在する必要があります。

パラメータ

tag : SharedTag: 共有タグ情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、SharedTag を設定します。

ResultObject add (String companyCd, SharedTag tag)

共有タグを追加します。

指定した会社の共有タグとして追加します。

[ 利用可能な管理者について ]
このAPIは、Collaboration管理者ロールをもつユーザのみ操作可能です。
また指定した会社コードが、認可で許可された会社である必要があります。

パラメータ

companyCd : String: 会社コード

tag : SharedTag: 共有タグ情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、SharedTag を設定します。

ResultObject delete (SharedTagKey[] keys)

共有タグを削除します。

[ Collaboration管理者の場合 ]
Collaboration管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、認可で許可された会社であること。

[ 機能管理者の場合 ]
機能管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、カレント組織の会社コードに一致すること。

パラメータ

keys : SharedTagKey[]: 共有タグキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject findList (SharedTagFilter filter)

共有タグを取得します。

[ 利用可能な管理者について ]
このAPIは、機能管理者ロールをもつユーザのみ操作可能です。
また、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、カレント組織の会社コードに一致すること。

パラメータ

filter : SharedTagFilter: 検索条件

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、SharedTagListItem[] を設定します。

ResultObject findList (String companyCd, SharedTagFilter filter)

共有タグを取得します。

[ 利用可能な管理者について ]
このAPIは、Collaboration管理者ロールをもつユーザのみ操作可能です。
また、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、認可で許可された会社であること。

パラメータ

companyCd : String: 会社コード

filter : SharedTagFilter: 検索条件

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、SharedTagListItem[] を設定します。

ResultObject find (SharedTagKey key)

共有タグの詳細情報を取得します。

[ Collaboration管理者の場合 ]
Collaboration管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、認可で許可された会社であること。

[ 機能管理者の場合 ]
機能管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、ユーザコンテキストのカレント組織の会社コードに一致すること。

パラメータ

key : SharedTagKey: 共有タグキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、SharedTag を設定します。

ResultObject update (SharedTag tag)

共有タグを更新します。

[ Collaboration管理者の場合 ]
Collaboration管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、認可で許可された会社であること。

[ 機能管理者の場合 ]
機能管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

指定した共有タグキーの会社コードが、カレント組織の会社コードに一致すること。

パラメータ

tag : SharedTag: 共有タグ情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。