1.8. http://localhost:7080/rest/operation: 操作のエンドポイント。

メソッド

• GET /operation/definition/{id}

  description

  ID で単一の操作定義を取得します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	取得する定義の ID	true	int	all
  resourceId	クエリー	この操作をサポートするリソースの ID	false	整数	all

  return type: javax.ws.rs.core.Response

• GET /operation/definitions

  description

  リソースの操作定義をすべて一覧表示する

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  resourceId	クエリー	リソースの ID	true	整数	all

  return type: javax.ws.rs.core.Response

• post /operation/definition/{id}

  description

  渡されたリソースの渡された定義 ID から新しい（ドラフト）操作を作成します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	定義の ID	true	int	all
  resourceId	クエリー	リソースの ID	true	整数	all

  return type: javax.ws.rs.core.Response

• GET /operation/{id}

  description

  （ドラフト）操作を返します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	取得する操作の ID	true	int	all

  return type: javax.ws.rs.core.Response

• put /operation/{id}

  description

  (draft)操作を更新します。状態が 'ready' に設定されている場合、操作はスケジュールされます。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	更新する操作の ID	true	int	all
  	-body-	更新に使用する操作定義。	true	OperationRest	-all-	-none-

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のドラフト操作がない
  406	スケジューリング用にドラフトが設定されていましたが、パラメーターの検証に失敗しました。
  200	Update was successful, operation was scheduled if request

• delete /operation/{id}

  description

  （ドラフト）操作の削除
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	削除する操作の ID	true	int	all

  return type: javax.ws.rs.core.Response

• GET /operation/history/{id}

  description

  スケジュールされた操作の結果を返します。

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	送信されたジョブの名前。	true	string	all

  return type: javax.ws.rs.core.Response

• GET /operation/history

  description

  リソースに対して実行された操作の結果を返します。

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  resourceId	クエリー	制限するリソースの ID	false	int	all
  ps	クエリー	ページングのページサイズ	false	int	all	20
  page	クエリー	ページングのページ 0 ベース	false	整数	all

  return type: javax.ws.rs.core.Response

• delete /operation/history/{id}

  description

  渡された ID 操作履歴項目を削除します。

  注記

  この操作はデフォルトでべき等で、204.ジョブがジョブが存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	送信されたジョブの名前	true	string	all
  Validate	クエリー	ジョブが存在するかどうかを検証します。	false	ブール値	all	false

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  204	項目が削除されるか、検証が設定されていない状態で存在しなかった
  404	アイテムは存在せず、検証が設定されている
  406	渡されたジョブ ID が名前の検証をパスしませんでした。