BPD 関連リソース用の REST インターフェース-タスク・インスタンス・リソース-PUT (キャンセル) メソッド

このメソッドを使用して、タスクを取り消します。

メソッドの呼び出し例

PUT /rest/bpm/wle/v1/task/{taskId}?action={string}[&parts={string}]

代替メソッドの呼び出し

POST /rest/bpm/wle/v1/task/{taskId}?action={string}[&parts={string}]

パラメーター

必須パラメーター
名前値タイプ製品の機能詳細
action ストリング
指定されたタスク・インスタンスに対して実行されるアクション。
値製品の機能詳細
キャンセル (Cancel)
指定されたタスクを取り消します。
オプション・パラメーター
名前値タイプ製品の機能詳細
パーツ ストリング
応答データのどのパーツを返すかを示すストリング。 以下の値を使用できます。
  • データ
  • アクション
  • すべて (デフォルト)
  • なし
data 部分は、外部タスク情報を参照します。

要求の内容

なし

応答の内容

なし

エラー応答の内容

詳細なエラー情報。

デフォルトのコンテンツ・タイプは次のとおりです。application/json.

MIME タイプ: application/json


スキーマ
{"description": "WLE エラー応答", 
   "type": "object",
   "Properties":
   {"status": {"タイプ": "ストリング",
         "description": "前の API 呼び出しの状況。"
      },
      "exceptionType": {"type": "string",
         "description": "例外に関連付けられたクラス名。"
      },
      "errorNumber": {"タイプ": "ストリング",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"タイプ": "ストリング",
         "description": "Message text of the exception."
      },
      "errorMessageパラメーター": {"type": ["string"], "optional": true,
         "description": "例外のメッセージ・テキスト・パラメーター。"
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "追加の例外詳細 (スタック・トレースなど)。"
      }
   }
}

MIME タイプ: application/xml


スキーマ
<?xml version="1.0" encoding="UTF-8"?>
< スキーマ targetNamespace= "http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat = "http://rest.bpm.ibm.com/v1/data/root">

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	このタイプはエラー応答を表します。
    -->    
    < element name= "RestRuntime例外 ">
	<complexType>
	    <sequence>
		< エレメント名 = "status "type="string" />
		< element name="Data " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 このタイプには、例外に関連した詳細なエラー情報が含まれます。
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < エレメント名 = "status "type="string" />

	    <! -- これは例外の Java クラス名を指定します -->
	    < エレメント名 = "exceptionType" type="string " />

	    <! -- エラー・メッセージのメッセージ ID -->
	    < エレメント名 = "errorNumber" type="string " minOccurs= "0" />

	    <! -- 完全なエラー・メッセージ -->
	    < エレメント名 = "errorMessage" type="string " />

	    <! -- エラー・メッセージに挿入されたストリングのリスト -->
	    < element name= "errorMessageパラメーター" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 例外に関連付けられたスタック・トレース。
		 「server-stacktrace-enabled」プロパティーが指定されていない場合、これは省略されることに注意してください。
		 サーバーの 100Custom.xml ファイルで有効になっています。
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- 以前の応答。  バルク・コマンドが使用された場合に設定 -->
	    < element name = "responses "type="dat:BulkCommandResponses" minOccurs= "0"> < /element>

            < エレメント名 = "errorData" type="tns:ErrorData" minOccurs= "0" />
	</sequence>
    </complexType>

    <complexType name= "ErrorData">
        <sequence>
            < element name = "code "type = "string" /> (エレメント名 = "code "タイプ = "string" />)
            < element name = "data "type="string" minOccurs= "0 " />
        </sequence>
    </complexType>
    
</schema>

MIME タイプ: application/x-javascript

状況コード

このメソッドは、以下のいずれかの状況コードを返します。
コード製品の機能詳細
200 OK正常終了。
400 間違った要求パラメーターが有効でないか、欠落しています。
401 認証が必要呼び出し側は、この要求に対して許可されていません。
404 Not Found
タスクが存在しません。
500 内部サーバー・エラー重大な問題が発生しました。プログラマーの詳細が提供されます。

使用開始

7.5.0

親トピック: タスク・インスタンス・リソース



フィードバック