BPD 関連リソース用の REST インターフェース-タスク・テンプレート・リソース-GET メソッド

このメソッドを使用して、特定のヒューマン・タスク・テンプレートを取得します。

メソッドの呼び出し例

GET /rest/bpm/wle/v1/taskTemplate/{templateId}

パラメーター

なし

要求の内容

なし

応答の内容

タスク・テンプレートの詳細 (TaskTemplate complexType)。

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

MIME タイプ: application/json


スキーマ
{"description": "WLE タスク・テンプレート", 
   "type": "object",
   "Properties":
   {  
      "clientTypes": {"type": ["string"]、
         "description": "UI クライアント情報を指定するユーザー定義クライアント・タイプ、固定値 IBM_WLE_COACH。"
      },
      "description": {"type": "string",
         "description": "タスク・テンプレートの説明。"
      },
      "displayName": {"タイプ": "ストリング",
         "description": "タスク・テンプレートの表示名。"
      },
      "effectiveDate": {"type": "string", "format": "date-time",
         "description": "タスク・テンプレートが有効になった時刻。"
      },
      "isDefault": {"type": "boolean",
         "description": "タスク・テンプレートがデフォルト・スナップショットの一部であるかどうかを示します。"
      },
      "isTip": {"type": "boolean",
         "description": "タスク・テンプレートがヒントの一部であるかどうかを示します。"
      },
      "kind": {"型": "ストリング",
         "description": "このテンプレートから派生したタスクの種類。"
      },
      "name": {"type": "string",
         "description": "タスク・テンプレートの名前。"
      },
      "processApp頭字語": {"type": "string",
         "description": "プロセス・アプリケーションの頭字語。"
      },
      "processAppName": {"type": "string",
         "description": プロセス・アプリケーション名。"
      },
      "snapshotID": {"type": "string",
         "description": "プロセス・アプリケーションまたは最上位ツールキットのスナップショット ID。"
      },
      "snapshotName": {"type": "string",
         "description": "プロセス・アプリケーションまたは最上位ツールキットのスナップショット名。"
      },
      "state": {"type": "string",
         "description": "タスク・テンプレートが開始されているか停止されているかを示します。"
      },
      "tktid": {"タイプ": "ストリング",
         "description": "タスク・テンプレート ID。"
      },
      "toolkitAcronym": {"タイプ": "ストリング",
         "description": "ツールキット頭字語。"
      },
      "toolkitName": {"タイプ": "ストリング",
         "description": "ツールキット名。"
      },
      "topLevelToolkitName": {"タイプ": "ストリング",
         "description": "最上位のツールキット名。"
      },
      "topLevelToolkitAcronym": {"type": "ストリング",
         "description": "最上位のツールキット頭字語。"
      }
      "trackName": {"タイプ": "ストリング",
         "description": "タスク・テンプレートの VersionDetails がツールキットを表している場合、このフィールドは最上位のツールキットのブランチ名です。"
      }
   }
}

MIME タイプ: application/xml


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

    < import schemaLocation= "BPMRestData.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
    < import schemaLocation= "Common.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/common" />

    <!--
	This type represents a task template.
    -->
    <complexType name= "TaskTemplate">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- タスク・テンプレート ID -->
		    < element name = "tktid "type = "string" /> (エレメント名 = "tktid "タイプ = "string" />)
		    
		    <! -- タスク・テンプレートの名前 -->
		    < エレメント名 = "name "タイプ = "string" />

		    <! -- タスク・テンプレートの表示名 -->
		    < エレメント名 = "displayName" タイプ = "string "nillable = "true" />

		    <! -- タスク・テンプレートの説明 -->
		    < element name = "description "type = "string" nillable = "true "/> (エレメント名 = "description" type = "string "nillable = "true" />)

		    <! -- タスク・テンプレートに関連付けられた「種類」。これは「KIND_親」に設定されます。-->
		    < element name = "kind "type = "string" /> (エレメント名 = "kind "タイプ = "string" />)

		    <! -- タスク・テンプレートの状態。これは「STARTED」、「STOPPED」のいずれかになります。-->
		    < element name = "state "type = "string" /> (エレメント名 = "state "タイプ = "string" />)

		    <! -- このタスク・テンプレートに関連付けられたクライアント・タイプ。これは {"IBM_WLE_COACH"} -->
		    < element name= "clientTypes" type="string " minOccurs= "0" maxOccurs= "unbounded " />

		    <! -- タスク・テンプレートの有効日を表すタイム・スタンプ -->
		    < element name= "effectiveDate" type= "dateTime" />

		    <! -- タスク・テンプレートに関連付けられたスナップショット ID -->		    
		    < element name= "snapshotID" type = "string "nillable = "true" />

		    <! -- タスク・テンプレートに関連付けられたスナップショット名 -->
		    < エレメント名 = "snapshotName" type = "string "nillable = "true" />

		    <!-- 
			 If the task template's VersionDetails represents a toolkit, then these fields will be set 
			 to the top-level toolkit's acronym (short name) and name .
		    -->
		    < エレメント名 = "topLevelToolkitAcronym" type = "string "nillable = "true" />
		    < エレメント名 = "topLevelToolkitName" type = "string "nillable = "true" />

		    <!-- 
			 If the task template's VersionDetails represents a process app, then these fields will be set 
			 to the process app's acronym (short name) and name.
		    -->
		    < エレメント名 = "processAppName" type="string "nillable = "true" />
		    < element name= "processApp頭字語" type="string "nillable = "true" />

		    <!-- 
			 If the task template's VersionDetails represents a toolkit, then this field will be set 
			 to the top-level toolkit's branch name.
		    -->
		    < エレメント名 = "trackName" type = "string "nillable = "true" />

		    <! -- このタスク・テンプレートが「ヒント」を表すかどうかを示すフラグ -->
		    < element name= "isTip" type = "boolean" /> (エレメント名 = "isTip" type = "boolean" />)


		    <! -- これがデフォルトのタスク・テンプレートであるかどうかを示すフラグ -->
		    < エレメント名 = "isDefault" タイプ = "boolean" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <complexType name= "TaskSummaryリスト ">
    <complexContent>
        < extension base="data :Data">
        <sequence>
            <! -- 結果の合計数 (ページ編集が適用されている場合に有用) -->
            < element name = "total "type = "long" /> (エレメント名 = "total "タイプ = "long" />)

            <! -- プロセスに関連付けられたゼロ個以上のタスクのリスト -->
            < element name = "tasks "type="tns:TaskSummary" maxOccurs= "unbounded " minOccurs= "0" />
        </sequence>
        </extension>
    </complexContent>
    </complexType>

    <!--
    This type represents summary information for a task. The intent is to provide a response
    as quickly as possible by avoiding joins.
     -->
    <complexType name= "TaskSummary">
    <complexContent>
        < extension base="data :Data">
        <sequence>
            <! -- タスク・インスタンス ID -->
            < element name = "tkiid "type = "string" /> (エレメント名 = "tkiid "タイプ = "string" />)

            <! -- タスクのアクティビティー名 -->
            < element name = "name "type = "string" nillable = "true "/> (エレメント名 = "name" タイプ = "string "nillable = "true" />)

            <!--
             タスクの状況。 This will be one of:
             -「新規」
             - "Received"
             - "Replied"
             - "Forwarded"
             - "Sent"
             - "Actioned"
             - "Closed"
             - "Special"
             -"削除"
             -"アラート"
             - "Help_Request"
             -"コメント"
             - "Answered_Help_Request"
             - "Ignored_Help_Request"
            -->
            < エレメント名 = "status "type = "string" />

            <! -- タスクの所有者の userName -->
            < element name = "owner "type = "string" nillable = "true "/> (エレメント名 = "owner" type = "string "nillable = "true" />)

            <! -- このタスクの割り当て先であるユーザーまたはグループの名前 -->
            < エレメント名 = "assignedTo" type = "string " />
            < element name= "assignedToDisplayName" type = "string " />
            < エレメント名 = "assignedToID" type = "long " />

            <!--
             The type of the assignedTo element. This will be one of:
             -"ユーザー"
             -"グループ"
            -->
            < element name= "assignedToタイプ" type="string " />

            <! -- タスクに関連付けられた期限 -->
            < element name= "dueTime" type= "dateTime" nillable = "true " />
            
            <! -- タスクをクローズしたユーザー -->
            < エレメント名 = "closeByUser" type="string "nillable = "true" />
            < element name= "closeByUserFull名前" type="string "nillable = "true" />
        </sequence>
        </extension>
    </complexContent>
    </complexType>

    <!-- 
	 This type contains information about a task instance, and contains
	 information from both the Federation layer and the BPM Standard (WLE) layer.
    -->
    <complexType name= "TaskDetails">
	<complexContent>
	    < extension base="tns:TaskSummary">
		<sequence>
		    <! -- BPM Standard (WLE) および拡張 (WPS) 共通プロパティー -->
		    <! -- このタスクがアクティブ化されたときのタイム・スタンプ -->
		    < element name= "activationTime" type= "dateTime" />
		    
		    <! -- タスクに関連付けられたリスクのある日付 -->
		    < element name= "atRiskTime" type= "dateTime" nillable = "true " />

		    <! -- このタスクに関連付けられたクライアント・タイプ。 {"IBM_WLE_COACH"} -->
		    < element name= "clientTypes" type="string " minOccurs= "0" maxOccurs= "unbounded " />

		    <! -- タスクが完了したときのタイム・スタンプ -->
		    < element name= "completionTime" type= "dateTime" nillable = "true " />

		    <! -- タスクにプロセスが接続されている場合、これにはプロセス・インスタンス ID が含まれます -->
		    < エレメント名 = "containmentContextID" type = "string "nillable = "true" />

		    <! -- タスクの「ナラティブ」-->
		    < element name = "description "type = "string" nillable = "true "/> (エレメント名 = "description" type = "string "nillable = "true" />)

		    <! -- タスクの「件名」-->
		    < エレメント名 = "displayName" タイプ = "string "nillable = "true" />

            <! -- タスクがリスク状態であることを示すフラグ -->
            < element name= "isAtRisk" type= "boolean" />

		    <!-- 
			 The task's "kind".  This will be one of:
			 - "KIND_HUMAN"
			 - "KIND_ORIGINATING"
			 - "KIND_PARTICIPATING"
			 - "KIND_ADMINISTRATIVE"
		    -->
		    < element name = "kind "type = "string" /> (エレメント名 = "kind "タイプ = "string" />)

		    <! -- タスクが作成、開始、または完了した最も遅い時刻 -->
		    < element name= "lastModificationTime" type= "dateTime" />

		    <! -- タスクを発生させたユーザーの userName -->
		    < element name = "originator "type = "string" nillable = "true "/> (element name = "originator" type = "string "nillable = "true" />)

		    <! -- タスクに関連付けられた優先順位 -->
		    < element name = "priority "type = "integer" nillable = "true "/> (エレメント名 = "priority" type = "integer "nillable = "true" />)

		    <! -- このタスクの開始時刻 -->
		    < element name= "startTime" type= "dateTime" nillable = "true " />

		    <!-- 
			 タスクの状態。  This will be one of:
			 - "STATE_INACTIVE"
			 - "STATE_FINISHED"
			 - "STATE_TERMINATED"
			 - "STATE_SUSPENDED_BY_PARENT"
			 - "STATE_READY"
			 - "STATE_CLAIMED"
			 - "STATE_RUNNING"
		    -->
		    < element name = "state "type = "string" /> (エレメント名 = "state "タイプ = "string" />)

		    <! -- BPM Standard (WLE) 固有のプロパティー -->

		    <! -- タスクにプロセスが接続されている場合、これにはプロセス・インスタンス ID が含まれます -->
		    < element name = "piid "type = "string" nillable = "true "/> (エレメント名 = "piid" タイプ = "string "nillable = "true" />)

		    <! -- タスクにプロセスが接続されている場合、これにはプロセス・インスタンス名が含まれます -->
		    < エレメント名 = "processInstanceName" type="string "nillable = "true" />

		    <!-- -->
		    < エレメント名 = "priorityName" type = "string " />

		    <! -- このタスクに関連付けられた外部タスク・データ -->
		    < element name = "data "type="tns:ExternalTaskデータ" />

			<! -- タスクを含むインスタンスに関連付けられたプロセス・データ -->
		    < element name= "processData" type="tns:ProcessData" />
		    
			<! -- このタスクが所有するフェーズの名前..将来の使用のために予約済み -->
		    < エレメント名 = "milestone "type = "string" />

            <! -- タスクが外部アクティビティーの場合、このフィールドにはアクティビティーの ID が含まれます -->
            < エレメント名 = "externalActivityID" type = "string " />
            < element name= "externalActivitySnapshotID" type = "string "nillable = "true" />

            <! -- タスクがサービスの場合、このフィールドにはサービスの ID が含まれます。-->
            < エレメント名 = "serviceID" type = "string " />
            < エレメント名 = "serviceSnapshotID" type = "string "nillable = "true" />
            < エレメント名 = "serviceType" type = "string "nillable = "true" />
            < エレメント名 = "flowObjectID" type = "string " />

		    <! -- 未使用 -->
		    < エレメント名 = "runURL" type = "string " />

            <! -- 自動フローが有効になっていて、次のタスクが検出された場合は、次のタスクの ID が含まれます -->
            < element name= "nextTaskId" type="integer "nillable="true" minOccurs= "0 " maxOccurs= "unbounded" />

            < element name="collaboration "type="tns: コラボレーション" />

            <!--
             The list of applicable actions of the task. 有効値: 
             - "ACTION_CANCELCLAIM" 
             - "ACTION_CLAIM" 
             - "ACTION_COMPLETE"
             - "ACTION_CREATEMESSAGE" 
             - "ACTION_GETTASK" 
             - "ACTION_SETTASK" 
             - "ACTION_GETUISETTINGS" 
             - "ACTION_UPDATEDUEDATE" 
             - "ACTION_UPDATEPRIORITY" 
             - "ACTION_REASSIGNTOUSER" 
             - "ACTION_REASSIGNTOGROUP" 
             - "ACTION_VIEW_TASK"
             - "ACTION_VIEW_TASK_DETAILS"
            -->
            < element name = "actions "type="string" maxOccurs= "unbounded " minOccurs= "0" />
            
            <! -- タスクに割り当てられたチーム -->
            < 要素名 = "teamDisplayName" type="string "nillable = "true" />
            
            <! -- タスクに割り当てられたチーム名 -->
            < エレメント名 = "teamName" type = "string "nillable = "true" />
            
            <! -- タスクに割り当てられたチーム ID -->
            < エレメント名 = "teamID" type = "long "nillable="true" />
            
            <! -- チームに関連付けられたマネージャーのチーム表示名 -->
            < element name= "managerTeamDisplayName" type = "string "nillable = "true" />
            
            <! -- チームに関連付けられたマネージャーのチーム名 -->
            < エレメント名 = "managerTeamName" type="string "nillable = "true" />
            
            <! -- チームに関連付けられたマネージャーのチーム ID -->
            < エレメント名 = "managerTeamID" type = "long "nillable="true" />
            
            <!-- The customProperties associated with the external activity
	         The key is the name of the property.
	         The value containing a description of the property:
	            * type (name of the type)
	            * isList
	            * 説明
	            * richDescription
	        -->
		    < エレメント名 = "customProperties" type="cmn :Map "nillable="true" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>
	
	<!--
	This type contains collaboration details about the task.
    -->

     <complexType name="Collaboration">
   		 <sequence>
   		 	<! -- タスクがコラボレーションされているかどうか -->
	    	< エレメント名 = "status "タイプ =" boolean " />
     		 
		    <! -- サービス状況が「Coach」の場合、このフィールドには使用可能な currentUsers (エンドポイント) のリストが含まれます。-->
		    < element name= "currentUsers" type="string " minOccurs= "0" maxOccurs= "unbounded " />
			    
		    <! -- これには、任意のコラボレーション・タスクに招待されたユーザーの URL が保持されます -->
	 		< エレメント名 = "taskURL" type = "string " />
			    
	    </sequence>
     </complexType>
	
    <!--
	This type contains details about the task.
	For legacy reasons it is named ExternalTaskData even though
	it is used for all tasks.
    -->
    <complexType name= "ExternalTaskデータ ">
	<sequence>
	    < エレメント名 = "bpdToken" type="cmn :BPDToken " />
	    < element name="variables "type="cmn :Map" />
	    < エレメント名 = "reference "type="cmn :Reference" />
	</sequence>
    </complexType>


	<!--
	This type contains details about the instance containing the task.
    -->
    <complexType name= "ProcessData">
	<sequence>	
	    < エレメント名 = "businessData" type="cmn :Variable " maxOccurs= "unbounded" />
	</sequence>
    </complexType>	
	
    <!-- 
	 This type is used to return the available actions for a list of tasks.
    -->
    <complexType name= "TaskActions">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <!-- 
			 This field specifies the primary identifier of the tasks; 
			 this will be set to "tkiid" .
		    -->
		    < エレメント名 = "identifier "type = "string" />

		    <! -- ゼロ個以上の「TasksWithActions」構造体のリスト -->
		    < element name = "tasks "type="tns:tTasksWithActions" minOccurs= "0 " maxOccurs= "unbounded" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	 This type contains the list of available actions available for a particular task instance.
    -->
    <complexType name= "tTasksWithActions">
	<sequence>

	    <! -- タスク・インスタンス ID -->
	    < element name = "tkiid "type = "string" /> (エレメント名 = "tkiid "タイプ = "string" />)

	    <! -- タスク・インスタンスに関連付けられたゼロ個以上の使用可能なアクションのリスト -->
	    < element name = "actions "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
	</sequence>
    </complexType>

    <!--
	This type is used to return the URL which specifies 
	the location of a coach associated with a particular task
    -->
    <complexType name= "TaskClientSettings">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    <! -- Coach を指している URL -->
		    < element name = "url "type = "string" /> (エレメント名 = "url "タイプ = "string" />)
		</sequence>
	    </extension>
	</complexContent>
    </complexType>


    <!--
	This type is used to return the URL which specifies 
	the location of a coach associated with a particular service.
    -->
    <complexType name= "TaskTemplateClientSettings">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    <! -- Coach を指している URL -->
		    < element name = "url "type = "string" /> (エレメント名 = "url "タイプ = "string" />)
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!--
	This type is used to return a task instance ID which is the result
	of performing a task claim operation.
    -->
    <complexType name= "TaskClaim結果 ">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    < element name = "tkiid "type = "string" nillable = "true "/> (エレメント名 = "tkiid" タイプ = "string "nillable = "true" />)
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!--
	This type contains a list of task IDs to be passed to a 
	bulk operation on tasks.
    -->
    <complexType name= "TaskBulk操作 ">
	<complexContent>
            < extension base="data :Data">
                <sequence>
                    < element name= "taskIDs" type="string " minOccurs= "0" maxOccurs= "unbounded " />
                </sequence>
            </extension>
        </complexContent>
    </complexType>

    <!-- 
	 This type is used to return the results from performing a bulk operation on multiple tasks.
    -->
    <complexType name= "TaskBulkOperationResponse">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
			
		    <! -- ゼロ個以上の失敗した操作のリスト -->
		    < エレメント名 = "failedOperations" type="tns:tFailedOperations " minOccurs= "0" maxOccurs= "unbounded " />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

	    <!-- 
	 This type is used to return the results from performing a bulk operation on multiple tasks.
    -->
    <complexType name= "TaskDetailsBulkOperation応答 ">
	<complexContent>
	    < extension base="data :Data">
		<sequence>
		    <! -- ゼロ個以上のタスク詳細オブジェクトのリスト -->
		    < element name = "tasks "type="tns:TaskDetails" minOccurs= "0 " maxOccurs= "unbounded" />
			
		    <! -- ゼロ個以上の失敗した操作のリスト -->
		    < エレメント名 = "failedOperations" type="tns:tFailedOperations " minOccurs= "0" maxOccurs= "unbounded " />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>
	
    <!--
	This type describes a failed operation during a bulk task-related operation.
    -->
    <complexType 名 = "tFailed操作 ">
	<sequence>

	    <! -- タスク・インスタンス ID -->
	    < element name = "tkiid "type = "string" /> (エレメント名 = "tkiid "タイプ = "string" />)

	    <! -- エラーに関連したエラー・メッセージ接頭部 -->
	    < element name= "errorNumber" type = "string " />

	    <! -- エラーに関連したエラー・メッセージ -->
	    < エレメント名 = "errorMessage" type = "string " />
	</sequence>
    </complexType>

    <!-- 
	 This type describes the model of an external activity.
    -->
    <complexType name= "ExternalActivityモデル ">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <! -- 外部アクティビティーの ID。-->
		    < エレメント名 = "ID "type="string" />

		    <! -- 外部アクティビティーの名前。-->
		    <element name="name" type="string"/>

		    <! -- 外部アクティビティーの説明 -->
		    <element name="description" type="string"/>
		    < エレメント名 = "richDescription" type="string " />
		    
		    <! -- この外部アクティビティーが属するスナップショット -->
		    < エレメント名 = "snapshotId" type="string " />
		    
		    <! -- 警告 -->
	    	< エレメント名 = "warning "type = "string" />

		    <!-- The customProperties associated with the external activity
	         The key is the name of the property.
	         The value containing a description of the property:
	            * type (name of the type)
	            * isList
	            * 説明
	            * richDescription
	        -->
		    < エレメント名 = "customProperties" type="cmn :Map " />

		    <!-- The input variables associated with the external activity
	         The key is the name of the variable.
	         The value containing a description of the parameter:
	            * type (name of the type)
	            * isList
	            * 説明
	            * richDescription
	        -->
		    < element name="input "type="cmn :Map" />

		    <!-- The output variables associated with the external activity
	         The key is the name of the variable.
	         TThe value containing a description of the parameter:
	            * type (name of the type)
	            * isList
	            * 説明
	            * richDescription
	         -->
		    < element name="output "type="cmn :Map" />
		    
            <!-- Detailed information about the types referenced by the service.
             Each type referenced above and nested types are described.
	         The key is the name of the type.
	         The value is an map of information about the type  Here are some of the fields:
	            * ID, pattern, properties, isShared, options, min, max, description, fixedLength
	        -->
		    < element name="validations "type="cmn :Map" /> (element name="validations "type="cmn :Map" />)
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <!-- 
	 This type is used to return response data resulting from a task start operation.
    -->
    <complexType name= "TaskStartデータ ">
	<complexContent>
	    < extension base="data :Data">
		<sequence>

		    <!-- A list of attribute/value pairs which make up the task start.
		         The "data" key has a value that isjson string representing the variables and values of the task.
		         the "dataMap" key has a value that is a map containing the variables and values of the task.
		    -->
		    < エレメント名 = "return "type="cmn :Map" />
		</sequence>
	    </extension>
	</complexContent>
    </complexType>

    <complexType 名 = "ID " />

</schema>

MIME タイプ: application/x-javascript

エラー応答の内容

詳細なエラー情報。

デフォルトのコンテンツ・タイプは次のとおりです。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
タスク・テンプレートが存在しません。
406 Not Acceptable要求されたコンテンツ・タイプまたはコンテンツ・エンコード方式がサポートされていません。
500 内部サーバー・エラー重大な問題が発生しました。プログラマーの詳細が提供されます。

使用開始

7.5.0

親トピック: タスク・テンプレート・リソース