メソッドの概要

返却値の型 メソッド名
ResultObject addItem (ChecklistRegistration parameter)
チェックリストアイテムを追加します。
ResultObject addTask (ChecklistTaskRegistration parameter)
タスクを追加します。
ResultObject deleteItem (ItemKey itemKey)
チェックリストアイテムを削除します。
ResultObject deleteTask (ItemKey itemKey, TaskKey taskKey)
タスクを削除します。
ResultObject findItem (ItemKey itemKey)
チェックリストアイテムを取得します。
ResultObject findTaskList (ItemKey itemKey)
タスクを取得します。
ResultObject findTask (ItemKey itemKey, TaskKey taskKey)
タスクを取得します。
ResultObject isExistTodoModule ()
ToDo機能の存在チェックします。
ResultObject updateItemSetting (ChecklistItemSettingUpdate parameter)
チェックリストアイテム設定を更新します。
ResultObject updateStatus (ChecklistTaskStatusUpdate parameter)
タスクのステータスを更新します。
ResultObject updateTask (ChecklistTaskUpdate parameter)
タスクを更新します。

メソッドの詳細

ResultObject addItem (ChecklistRegistration parameter)
チェックリストアイテムを追加します。

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

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

パラメータ
parameter : ChecklistRegistration
チェックリスト情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Checklist を設定します。
ResultObject addTask (ChecklistTaskRegistration parameter)
タスクを追加します。

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

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

パラメータ
parameter : ChecklistTaskRegistration
タスク情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ChecklistTask を設定します。
ResultObject deleteItem (ItemKey itemKey)
チェックリストアイテムを削除します。

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

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

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

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

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

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

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

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

指定したアイテムに登録しているタスクを取得します。
ソート順は、チェックリストのアイテム設定に従います。
該当データがない場合、空のリストを返却します。

パラメータ
itemKey : ItemKey
アイテムキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ChecklistTask[] を設定します。
ResultObject findTask (ItemKey itemKey, TaskKey taskKey)
タスクを取得します。

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

パラメータ
itemKey : ItemKey
アイテムキー
taskKey : TaskKey
タスクキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ChecklistTask を設定します。
ResultObject isExistTodoModule ()
ToDo機能の存在チェックします。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、true : ToDo機能がある / false : ToDo機能がない を設定します。
ResultObject updateItemSetting (ChecklistItemSettingUpdate parameter)
チェックリストアイテム設定を更新します。

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

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

パラメータ
parameter : ChecklistItemSettingUpdate
設定情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateStatus (ChecklistTaskStatusUpdate parameter)
タスクのステータスを更新します。

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

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

パラメータ
parameter : ChecklistTaskStatusUpdate
タスク情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateTask (ChecklistTaskUpdate parameter)
タスクを更新します。

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

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

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