メソッドの概要

返却値の型 メソッド名
ResultObject addIframeInfo (IframeInfoRegistration parameter)
Webページ情報を登録します。
ResultObject addItem (IframeRegistration parameter)
Webページアイテムを追加します。
ResultObject deleteIframeInfo (ItemKey itemKey)
Webページ情報を削除します。
ResultObject deleteItem (ItemKey itemKey)
Webページアイテムを削除します。
ResultObject findIframeInfo (ItemKey itemKey)
Webページ情報を取得します。
ResultObject findItem (ItemKey itemKey)
Webページアイテムを取得します。
ResultObject updateItemSetting (IframeItemSettingUpdate parameter)
Webページアイテムの編集種別を更新します。

メソッドの詳細

ResultObject addIframeInfo (IframeInfoRegistration parameter)
Webページ情報を登録します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

  • jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
  • jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ
parameter : IframeInfoRegistration
Webページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、IframeInfo を設定します。
ResultObject addItem (IframeRegistration parameter)
Webページアイテムを追加します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

  • ワークスペースに対してオーナー権限を保持している
  • ワークスペースのアイテム追加を許可されている

パラメータ
parameter : IframeRegistration
Webページアイテム情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Iframe を設定します。
ResultObject deleteIframeInfo (ItemKey itemKey)
Webページ情報を削除します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

  • jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
  • jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject deleteItem (ItemKey itemKey)
Webページアイテムを削除します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

  • jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
  • jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject findIframeInfo (ItemKey itemKey)
Webページ情報を取得します。

該当するデータがない場合、NULLを返却します。

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、IframeInfo を設定します。
ResultObject findItem (ItemKey itemKey)
Webページアイテムを取得します。

該当するデータがない場合、NULLを返却します。

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Iframe を設定します。
ResultObject updateItemSetting (IframeItemSettingUpdate parameter)
Webページアイテムの編集種別を更新します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

  • ワークスペースに対してオーナー権限を保持している
  • アイテム登録者

パラメータ
parameter : IframeItemSettingUpdate
Webページアイテム情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。