POST /rest/bpm/wle/v1/process?action={string}&message={string}| 名前 | 値タイプ | 説明 | ||||
|---|---|---|---|---|---|---|
| action | ストリング | プロセスに対して実行するアクション。
|
||||
| メッセージ | ストリング | 送信されるメッセージ・テキストを表す URLEncoded ストリング。 メッセージには、イベント名が含まれている必要があります。これは、Undercover Agent の作成時に生成されるメッセージ・イベントの ID です。 また、パラメーター名と値をキーと値のペアで含めることもできます。 UCA 実装が (エディターで)「変数」を使用する場合、システムは、1 つの入力パラメーター (名前:「入力」) を持つ UCA のサービスを生成します。 「入力」のタイプは、エディターで指定された変数タイプです。 サービスの要求本体と入力パラメーターが一致していることを確認してください。
メッセージは、以下の例に示すように XML として構造化する必要があります。 変数の実装: 例 1 (変数型整数): < イベント・メッセージ> <! -- Process App の頭字語は必須です。 スナップショット名と UCA 名はオプションです。 ただし、UCA 名が指定されていない場合、イベント名は required.--> です。 < イベント processApp= "[acronym]" snapshot=" [snapshot_name] " ucaname=" [UCA_name] "> [event_name] < /event> <! -- オプション: イベントの実行に使用するキューの名前。 --> <parameters> <parameter> < key> 入力 < /key> < 値タイプ = " 整数 "> <![CDATA [integer_value_for_Input]] > < /value> </parameter> </parameters> < /イベント・メッセージ> 例 2 (変数型ストリング): < イベント・メッセージ> <! -- Process App の頭字語は必須です。 スナップショット名と UCA 名はオプションです。 ただし、UCA 名が指定されていない場合、イベント名は required.--> です。 < イベント processApp= "[acronym]" snapshot=" [snapshot_name] " ucaname=" [UCA_name] "> [event_name] < /event> <! -- オプション: イベントの実行に使用するキューの名前。 --> <parameters> <parameter> < key> 入力 < /key> < value type="String"> <![CDATA [string_value_for_Input]] > < /value> </parameter> </parameters> < /イベント・メッセージ> 例 3 (変数タイプ NameValueペア): < イベント・メッセージ> <! -- Process App の頭字語は必須です。 スナップショット名と UCA 名はオプションです。 ただし、UCA 名が指定されていない場合、イベント名は required.--> です。 < イベント processApp= "[acronym]" snapshot=" [snapshot_name] " ucaname=" [UCA_name] "> [event_name] < /event> <! -- オプション: イベントの実行に使用するキューの名前。 --> <parameters> <parameter> < key> 入力 < /key> < 値> < name type = "String"> <![CDATA [value_for_name]] > < /name> < value type="String"> <![CDATA [value_for_value]] > < /value> </値> </parameter> </parameters> < /イベント・メッセージ> 例 4 (ID、名前、およびアドレスの 3 つのフィールドを持つ変数タイプ・ビジネス・オブジェクト): < イベント・メッセージ> <! -- Process App の頭字語は必須です。 スナップショット名と UCA 名はオプションです。 ただし、UCA 名が指定されていない場合、イベント名は required.--> です。 < イベント processApp= "[acronym]" snapshot=" [snapshot_name] " ucaname=" [UCA_name] "> [event_name] < /event> <! -- オプション: イベントの実行に使用するキューの名前。 --> <parameters> <parameter> < key> 入力 < /key> < 値> < ID type="String"> <![CDATA [value_for_ID]] > < /ID> < name type = "String"> <![CDATA [value_for_name]] > < /name> < address type="String"> <![CDATA [value_for_address]] > < /address> </値> </parameter> </parameters> < /イベント・メッセージ> サービス実装: 例 (2 つの入力パラメーター: input1 および input2。 input1 パラメーターはプリミティブ型「String」です。 input2 パラメーターは複合タイプ BO1です。 BO1 には、ID、名前、およびアドレスの 3 つのフィールドがあります。 < イベント・メッセージ> <! -- Process App の頭字語は必須です。 スナップショット名と UCA 名はオプションです。 ただし、UCA 名が指定されていない場合、イベント名は required.--> です。 < イベント processApp= "[acronym]" snapshot=" [snapshot_name] " ucaname=" [UCA_name] "> [event_name] < /event> <! -- オプション: イベントの実行に使用するキューの名前。 --> <parameters> <parameter> <key>input1</key> < value type="String"> <![CDATA [value_for_input1]] > < /value> </parameter> <parameter> <key>input2</key> < 値> < ID type="String"> <![CDATA [value_for_ID]] > < /ID> < name type = "String"> <![CDATA [value_for_name]] > < /name> < address type="String"> <![CDATA [value_for_address]] > < /address> </値> </parameter> </parameters> < /イベント・メッセージ> メッセージにスナップショット名を含めない場合、Event Manager はメッセージの開始イベントに対してターゲット Workflow Server 上のデフォルト・スナップショットを使用します。 中間メッセージ・イベントの場合には、メッセージにスナップショット名を含めないと、すべてのアクティブなスナップショットがイベントを受け取ります。 注: < value> エレメントの値に XML エレメントまたは類似のコンテンツが含まれている場合は、前の例に示すように、値を CDATA タグでラップする必要があります。 |
なし
デフォルトのコンテンツ・タイプは次のとおりです。application/json.
{"description": "WLE メッセージ送信状況",
"type": "object",
"Properties":
{"messageSent": {"type": "boolean",
"description": "メッセージが正常に送信されたかどうかを示すフラグ。"
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/process"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/process"
xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
xmlns:common="http://rest.bpm.ibm.com/v1/data/common"
xmlns:execution="http://rest.bpm.ibm.com/v1/data/execution"
xmlns:task="http://rest.bpm.ibm.com/v1/data/task"
xmlns:activity="http://rest.bpm.ibm.com/v1/data/activity"
xmlns:relationship = "http://rest.bpm.ibm.com/v1/data/relationship">
< 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" />
< import schemaLocation= "Task.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/task"> < /import>
< import schemaLocation= "ExecutionTree.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/execution"> < /import>
< import schemaLocation= "Activity.xsd" 名前空間 = "http://rest.bpm.ibm.com/v1/data/activity" />
< import schemaLocation= "Relationship.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/relationship" />
<complexType name= "ProcessSearch結果 ">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
< element name="overview "type="common :Map" />
< element name = "processes "type="tns:ProcessSummary" maxOccurs= "unbounded " minOccurs= "0" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name= "ProcessSummary">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- プロセス・インスタンス ID -->
< element name = "piid "type = "string" /> (エレメント名 = "piid "タイプ = "string" />)
<! -- このプロセスの名前 -->
< エレメント名 = "name "タイプ = "string" />
<! -- BPD の名前。-->
< エレメント名 = "bpdName" type = "string " />
<! -- スナップショット ID -->
< element name= "snapshotID" type = "string "nillable = "true" />
<! -- プロジェクト ID -->
< element name= "projectID" type = "string "nillable = "true" />
<! -- プロセスに関連付けられた期限 -->
< element name= "dueDate" type= "dateTime" />
<! -- プロセスに関連付けられたリスクのある日付 -->
< エレメント名 = "atRiskDate" type= "dateTime" />
<!-- The current status of the process instance
有効な値は以下のとおりです。
"アクティブ",
"Completed",
"失敗",
"Suspended",
"終了" -->
< エレメント名 = "executionState" type = "string " />
<! -- 失敗したプロセス・インスタンスのエラー・メッセージ -->
< エレメント名 = "instanceError" type = "string " />
<! -- プロセス・インスタンスが作成されたときのタイム・スタンプ -->
< エレメント名 = "creationDate" type= "dateTime" />
<! -- プロセスが最後に変更されたときのタイム・スタンプ -->
< element name= "lastModificationTime" type= "dateTime" />
<! -- プロセス・インスタンスがクローズされたときのタイム・スタンプ -->
< エレメント名 = "closedDate" type= "dateTime" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains details related to a process instance.
-->
<complexType name= "ProcessDetails">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- プロセス・インスタンスが作成されたときのタイム・スタンプ -->
< エレメント名 = "creationTime" type= "dateTime" />
<! -- このプロセスの説明 -->
< element name = "description "type = "string" nillable = "true "/> (エレメント名 = "description" type = "string "nillable = "true" />)
< エレメント名 = "richDescription" type = "string "nillable = "true" />
<!-- The current status of the process instance
有効な値は以下のとおりです。
"アクティブ",
"Completed",
"失敗",
"Suspended",
"終了" -->
< エレメント名 = "executionState" type = "string " />
<! -- プロセス・インスタンスの現在の状態。 -->
< element name = "state "type = "string" /> (エレメント名 = "state "タイプ = "string" />)
<! -- プロセスが最後に変更されたときのタイム・スタンプ -->
< element name= "lastModificationTime" type= "dateTime" />
<! -- このプロセスの名前 -->
< エレメント名 = "name "タイプ = "string" />
<! -- プロセス・インスタンス ID -->
< element name = "piid "type = "string" /> (エレメント名 = "piid "タイプ = "string" />)
<! -- ケース・フォルダー ID -->
< エレメント名 = "caseFolderID" type = "string " />
<! -- ケース・フォルダー・サーバー名 -->
< element name= "caseFolderServerName" type = "string "nillable="true" />
<! -- プロセス・テンプレート (BPD) ID -->
< エレメント名 = "processTemplateID" type = "string " />
<! -- プロセス・テンプレート (BPD) 名 -->
< エレメント名 = "processTemplateName" type="string " />
<! -- プロセス・アプリケーションの名前 -->
< エレメント名 = "processAppName" type="string "nillable = "true" />
<! -- プロセス・アプリケーションの頭字語 -->
< element name= "processApp頭字語" type="string "nillable = "true" />
<! -- プロセス・アプリケーションの ID -->
< エレメント名 = "processAppID" type = "string "nillable = "true" />
<! -- スナップショットの名前 ---->
<! -- スクリプト実行の結果 -->
< element name = "result "type = "string" nillable = "true "/> (element name = "result" type = "string "nillable = "true" />)
< エレメント名 = "snapshotName" type = "string "nillable = "true" />
<! -- スナップショット ID -->
< element name= "snapshotID" type = "string "nillable = "true" />
<! -- ブランチ (トラック) ID -->
< エレメント名 = "branchID" type = "string " />
<! -- ブランチ (トラック) の名前。-->
< エレメント名 = "branchName" type = "string " />
<! -- スナップショットのヒント -->
< 要素名 = "snapshotTip" type = "boolean" />
<! -- 開始文書 ID -->
< エレメント名 = "startingDocumentID" type = "string " />
<! -- 開始文書サーバー名 -->
< エレメント名 = "startingDocumentServerName" type = "string "nillable="true" />
<! -- 親ケース ID -->
< エレメント名 = "parentCaseId" type="string "nillable="true" />
<! -- 親アクティビティー ID -->
< エレメント名 = "parentActivityId" type="string "nillable="true" />
<! -- ワークフロー・アプリケーション -->
< 要素名 = "workflowApplication" type = "string "nillable="true" />
<! -- ケース ID -->
< エレメント名 = "caseIdentifier" type = "string "nillable="true" />
<! -- ケース・タイプ ID -->
< エレメント名 = "caseTypeId" type="string "nillable="true" />
<! -- ケース・ステージ状況 -->
< element name= "caseStage状況" type="string "nillable="true" />
<! -- ケース・プロセス・タイプの場所 -->
< エレメント名 = "caseProcessTypeLocation" type = "string "nillable="true" />
<! -- ケース・ターゲット・オブジェクト・ストア名 -->
< element name= "caseTargetOSSymname" type="string "nillable="true" />
<! -- 失敗したプロセス・インスタンスのエラー・メッセージ -->
< エレメント名 = "instanceError" type = "string " />
<! -- プロセスに関連付けられた期限 -->
< element name= "dueDate" type= "dateTime" />
<! -- プロセスに関連付けられた予測された期限 -->
< 要素名 = "predictedDueDate" タイプ = "dateTime" />
<! -- プロセス・インスタンスに関連付けられたコメント -->
< element name = "comments "type="tns:CommentsType" maxOccurs= "unbounded " minOccurs= "0" />
<! -- プロセスに関連付けられたゼロ個以上のタスクのリスト -->
< element name = "tasks "type="task:TaskDetails" maxOccurs= "unbounded " minOccurs= "0" />
<! -- プロセスに関連付けられた 0 個以上の文書のリスト -->
< element name = "documents "type="tns:documentsType" maxOccurs= "unbounded " minOccurs= "0" />
<! -- 該当する場合に実行されるアクションの詳細 -->
< element name= "actionDetails" type="tns:ActionDetails" minOccurs= "0" />
<!--
The data associated with the process instance in a json String.
To understand this, you'll need the data model associated with the BPD.
-->
< element name = "data "type = "string" /> (エレメント名 = "data "タイプ = "string" />)
<!--
Data information stored in an actual Map like the TaskDetails information
-->
< element name="variables "type="common :Map" />
<!--
入力、出力、およびプライベート変数名情報
-->
< element name= "variableNames" type="tns:VariableNames" />
<!--
List of all relationships referencing this particular process instance either as target or source.
-->
< element name = "relationship "type="relationship:RelationshipDetails" maxOccurs= "unbounded " minOccurs= "0" />
<!--
Business data information stored as list of variables.
-->
< element name= "businessData" type="common :Variable " maxOccurs= "unbounded" />
<! -- プロセスに関連付けられた実行ツリー -->
< element name= "executionTree" type="execution:ExecutionTree" />
<! -- プロセス・インスタンスに関連付けられたダイアグラム -->
< element name = "diagram "type="tns:DiagramType" />
<! -- プロセス・インスタンスに関連付けられたデータ・モデル -->
< element name= "dataModel" type="tns:DataModelタイプ " />
<! -- プロセス・インスタンスの適用可能なアクションのリスト -->
< element name = "actions "type="string" maxOccurs= "unbounded " minOccurs= "0" />
<! -- BPD の名前。-->
< エレメント名 = "bpdName" type = "string " />
<! -- プロセス・インスタンスを開始したユーザーの ID -->
< エレメント名 = "starterId" タイプ = "string " />
</sequence>
</extension>
</complexContent>
</complexType>
<! -- このタイプは、プロセス詳細のリストを返すために使用されます。 -->
<complexType 名 = "ProcessDetailsリスト ">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- これはゼロ個以上のプロセス詳細のリストです。 -->
< element name= "processInstance" type="tns:ProcessDetails" minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType 名 = "ProcessBusinessDataList">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- ゼロ個以上の失敗した操作のリスト -->
< エレメント名 = "failedOperations" type="tns:FailedOperations" minOccurs= "0" maxOccurs= "unbounded " />
< element name= "processBusinessData" type="tns:ProcessBusinessData " minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType 名 = "ProcessBusinessデータ ">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- プロセス・インスタンス ID -->
< element name = "piid "type = "string" /> (エレメント名 = "piid "タイプ = "string" />)
<! -- variables.-->
< element name= "businessData" type="common :Variable " maxOccurs= "unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains information about a Business Process Definition Model.
-->
<complexType name="BPDModel">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
< element name="Header "type="tns:HeaderType" />
< element name= "DataModel" type="tns:DataModelタイプ " />
< element name="Diagram "type="tns:DiagramType" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains the "header" type information associated with a BPD Model.
-->
<complexType 名前 = "HeaderType">
<sequence>
<! -- BPD ID -->
< エレメント名 = "ID "type="string" />
<! -- BPD 名 -->
<element name="name" type="string"/>
<! -- BPD の説明 -->
<element name="description" type="string"/>
< element name= "richDescription" type="string " />
</sequence>
</complexType>
<!--
This type contains information about a BPD's "data model".
This includes the inputs and outputs associated with a BPD.
-->
<complexType name= "DataModelタイプ ">
<sequence>
<! -- BPD モデルによって定義された変数のリスト -->
< element name="properties "type="common :Map" />
<! -- プロセスへの入力のリスト -->
< element name="input "type="common :Map" />
<! -- プロセスによって生成される出力のリスト -->
< element name="output "type="common :Map" />
<! -- BPD のデータ・モデルを説明する構造 -->
< element name="validation "type="common :Map" />
</sequence>
</complexType>
<!--
This type contains information about a diagram associated
with a BPD or Process instance.
-->
<complexType 名前 = "DiagramType">
<sequence>
<! -- プロセス・アプリケーション ID (短縮名) -->
< element name= "processAppID" type="string " />
<!--
A list of zero or more phases associated with the process.
A phase represents a phase of process execution.
-->
< element name = "milestone "type="tns:milestoneType" minOccurs= "0 " maxOccurs= "unbounded" />
<! -- プロセスに関連付けられたゼロ個以上のステップのリスト -->
< element name = "step "type="tns:stepType" maxOccurs= "unbounded " minOccurs= "0" />
<!--
A list of zero or more lanes associated with the process.
A "lane" typically represents a department within a business organization.
-->
< element name = "lanes "type="tns:lanesType" maxOccurs= "unbounded " minOccurs= "0" />
<!--
A list of zero or more tokens associated with the process but not to a specific step or attached element.
-->
< element name = "orphaned "type="tns:orphanType" maxOccurs= "unbounded " minOccurs= "0" />
</sequence>
</complexType>
<!--
This type represents a "phase" which models a
phase of execution within a process.
-->
<complexType 名 = "milestoneType">
<sequence>
<! -- このフェーズの名前 -->
<element name="name" type="string"/>
<! -- このフェーズの「幅」(ピクセル単位) -->
< 要素名 = "width "type="int" />
</sequence>
</complexType>
<!--
This type contains the detailed information associated with a "step" within a process.
-->
<complexType 名 = "stepType">
<sequence>
<! -- ステップ ID -->
< エレメント名 = "ID "type="string" />
<! -- このステップの名前 -->
<element name="name" type="string"/>
<!--
The step type associated with this step.
Examples: event, gateway, activity, etc.
-->
< エレメント名 = "type "type="string" />
<!--
If the type is "activity", this field specifies the type of activity.
Examples: task, externalActivity, subBpd, etc.
-->
< エレメント名 = "activityType" type="string " minOccurs= "0" />
<!--
If the activity type is "subBpd", the externalID is the Process id
of the subBpd.
If the activity type is "task", the externalID is the Service id of the task's service.
If the activity type is "externalTask", the externalID is the External Activity id of
the external task.
-->
< element name= "externalID" type="string " minOccurs= "0" />
<! -- サブプロセスを示す図 -->
< element name = "diagram "type="tns:DiagramType" minOccurs= "0 " />
<! -- このステップが属するフェーズの名前。 -->
< エレメント名 = "milestone "type="string" />
<! -- ステップが属しているスイムレーンの名前 -->
< 要素名 = "lane "type="string" />
<! -- 図の中のこのステップの中心点の X, Y 座標 -->
< エレメント名 = "x "type="int" />
< 要素名 = "y "type="int" />
<! -- ダイアグラム内のステップに関連付けられた色 -->
< 要素名 = "color "type="string" />
<! -- このステップに付加されたゼロ個以上のタイマーのリスト -->
< element name= "attachedTimer" type="tns:attachedTimerType " maxOccurs= "unbounded" minOccurs= "0 " />
<! -- このステップに付加されたオプションの事前トラッキング・ポイント -->
< element name= "preTrackingPoint" type="tns:trackingPointType " maxOccurs= "1" minOccurs= "0 " />
<! -- このステップに付加されたオプションのポスト・トラッキング・ポイント -->
< element name= "postTrackingPoint" type="tns:trackingPointType " maxOccurs= "1" minOccurs= "0 " />
<! -- このステップに付加されたゼロ個以上のイベント・ハンドラーのリスト -->
< element name= "attachedEventHandler" type="tns:attachedEventHandlerType" maxOccurs= "unbounded" minOccurs= "0 " />
<! -- 図のこのステップから外に出ている 0 行以上の線のリスト -->
< element name = "lines "type="tns:linesType" maxOccurs= "unbounded " minOccurs= "0" />
<! -- このステップに関連付けられたトークン ID のリスト -->
< エレメント名 = "tokenID" type="string " maxOccurs= "unbounded" minOccurs= "0 " />
<! -- 関連付けられたタスクがある場合は、このステップに関連付けられたタスク ID -->
< エレメント名 = "taskID" type="string " maxOccurs= "1" minOccurs= "0 " />
</sequence>
</complexType>
<!--
-->
<complexType name= "attachedTimerタイプ ">
<sequence>
< エレメント名 = "ID "type="string" />
<element name="name" type="string"/>
<element name="description" type="string"/>
< element name= "richDescription" type="string " />
< エレメント名 = "tokenID" type="string " maxOccurs= "unbounded" minOccurs= "0 " />
</sequence>
</complexType>
<!--
-->
<complexType name= "trackingPointタイプ ">
<sequence>
< エレメント名 = "ID "type="string" />
<element name="name" type="string"/>
<element name="description" type="string"/>
< element name= "richDescription" type="string " />
< エレメント名 = "tokenID" type="string " maxOccurs= "unbounded" minOccurs= "0 " />
< element name= "eventID" type="string " />
</sequence>
</complexType>
<!--
-->
<complexType 名 = "attachedEventHandlerType">
<sequence>
< エレメント名 = "ID "type="string" />
<element name="name" type="string"/>
<element name="description" type="string"/>
< element name= "richDescription" type="string " />
<! -- イベント・メッセージ終了メッセージまたは中間メッセージのタイプ -->
< element name= "eventType" type="string " minOccurs= "0" />
< エレメント名 = "tokenID" type="string " maxOccurs= "unbounded" minOccurs= "0 " />
</sequence>
</complexType>
<!--
This type represents a single line which extends out from a particular step within a BPD diagram.
-->
<complexType 名 = "linesType">
<sequence>
<! -- この行が拡張されるステップのステップ ID -->
< element name = "to "type="string" />
<!--
A string containing a comma-separated list of coordinates through which this line extends.
The list of points must contain the first point (coordinate of the "fromPort")
and the last point (coordinate of the "toPort").
-->
< エレメント名 = "points "type="string" />
< エレメント名 = "tokenID" type="string " maxOccurs= "unbounded" minOccurs= "0 " />
<element name="name" type="string"/>
</sequence>
</complexType>
<!--
This type represents a lane which is associated with a BPD diagram.
-->
<complexType 名 = "lanesType">
<sequence>
<! -- スイムレーンの名前 -->
<element name="name" type="string"/>
<! -- レーンの高さ (ピクセル単位) -->
< 要素名 = "height "type="int" />
<! -- このレーンが「システム」レーンであるかどうかを示します -->
< element name = "system "type=" boolean " /> -->
</sequence>
</complexType>
<!--
This type represents a orphan token which is associated with a BPD diagram.
-->
<complexType 名 = "orphanType">
<sequence>
<! -- このプロセス・インスタンスに関連付けられたトークン ID -->
< エレメント名 = "tokenID" type="string " maxOccurs= "unbounded" minOccurs= "0 " />
< element name= "snapshotID" type = "string "nillable = "true" />
< element name= "bpdID" type="string " />
< element name= "stepID" type="string " />
< element name = "step "type="tns:stepType" maxOccurs= "1 " minOccurs= "0" />
</sequence>
</complexType>
<!--
This type represents a comment associated with a process instance.
-->
<complexType 名前 = "CommentsType">
<sequence>
<! -- コメントを入力したユーザーのユーザー名 -->
< エレメント名 = "who "type="string" />
<! -- コメントを入力したユーザーの fullName 。-->
< element name= "whoFullName" type="string " />
<! -- コメントを入力したユーザーの E メール・アドレス -->
< element name= "whoEmail" type="string " />
<! -- コメントが入力されたときのタイム・スタンプ -->
< エレメント名 = "date "type="dateTime" />
<! -- コメントに関連付けられたメッセージ -->
< エレメント名 = "message "type="string" />
</sequence>
</complexType>
<!--
This type represents a document that is associated with a process instance.
-->
<complexType 名前 = "documentsType">
<sequence>
<! -- 文書に関連付けられた ID。これは「更新」および「削除」に使用されます。-->
< エレメント名 = "ID "type="string" />
<! -- 文書に関連付けられた ECM ID。これはコンテンツ統合ステップに使用されます -->
< エレメント名 = "ecmID" type="string " />
<! -- この文書の名前 -->
<element name="name" type="string"/>
<! -- 文書のコンテンツ・タイプ (ファイル、URL) -->
< エレメント名 = "type "type="string" />
<! -- 文書が追加されたときのタイム・スタンプ -->
< エレメント名 = "date "type="dateTime" />
<! -- 文書コンテンツの長さ (バイト単位) -->
< エレメント名 = "length "type="int" />
<!--
For a document of type "url" this specifies the URL associated with the document.
Note that for a "url" type document, we store the URL and not the document
contents.
-->
< 要素名 = "url "type="string" />
<! -- この文書のバージョン -->
< エレメント名 = "version "type="int" />
</sequence>
</complexType>
<!--
This type is used to return the status from the "sendMessage" action.
-->
<complexType name= "SendMessage状況 ">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- メッセージが正常に送信されたかどうかを示すフラグ -->
< element name= "messageSent" type= "boolean" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the result of evaluating a javascript expression.
-->
<complexType 名 = "JSReturnData">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! --「結果」は属性/値のペアのリストで構成されます -->
< エレメント名 = "result "type="string" />
</sequence>
</extension>
</complexContent>
</complexType>
<! -- トリガー・アクション・ハンドラー結果 -->
<complexType 名 = "ActionResult">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
< element name = "tkiid "type="string" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
<! -- アクションに特定の詳細がある場合があります -->
<complexType 名 = "ActionDetails">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
< element name= "actionName" type="string " />
</sequence>
</extension>
</complexContent>
</complexType>
<! -- アドホック・アクションの詳細 -->
<complexType name= "AdhocActionの詳細 ">
<complexContent>
< extension base="tns:ActionDetails">
<sequence>
< element name= "createdTaskIDs" type="string " maxOccurs= "unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name= "diagramInstanceタイプ ">
<sequence>
< element name = "diagram "type="tns:DiagramType" />
< エレメント名 = "tokenID" type="string " />
< element name= "taskID" type="string " />
</sequence>
</complexType>
<complexType name="Action">
<sequence>
< エレメント名 = "ID "type="string" />
< element name= "displayName" type="string " />
<element name="description" type="string"/>
< element name= "richDescription" type="string " />
</sequence>
</complexType>
<complexType name = " イベント ">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<sequence>
< element name="actions "type="tns: Action" minOccurs= "0 " maxOccurs= "unbounded" />
</sequence>
<sequence>
< element name= "standardActions" type="string " minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains the list of available actions available for a particular process instance.
-->
<complexType 名 = "tProcessWithActions">
<sequence>
<! -- プロセス・インスタンス ID -->
< element name = "piid "type = "string" /> (エレメント名 = "piid "タイプ = "string" />)
<! -- プロセス・インスタンスに関連付けられたゼロ個以上の使用可能なアクションのリスト -->
<sequence>
< element name = "actions "type="string" minOccurs= "0 " maxOccurs= "unbounded" />
</sequence>
</sequence>
</complexType>
<complexType 名 = "ProcessActions">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<!--
This field specifies the primary identifier of the process instance;
this will be set to "piid" .
-->
< エレメント名 = "identifier "type = "string" />
<! -- ゼロ個以上の「ProcessWithActions」構造体のリスト -->
< element name = "process "type="tns:tProcessWithActions" minOccurs= "0 " maxOccurs= "unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type describes a failed operation during a bulk process-related operation.
-->
<complexType 名 = "FailedOperations">
<sequence>
<! -- プロセス・インスタンス ID -->
< element name= "instanceId" type = "string " />
<! -- エラーに関連したエラー・メッセージ接頭部 -->
< element name= "errorNumber" type = "string " />
<! -- エラーに関連したエラー・メッセージ -->
< element name= "errorMessage" type = "string " />
</sequence>
</complexType>
<!--
This type is used to return the results from performing a bulk operation on multiple process instances.
-->
<complexType 名 = "ProcessBulkOperationResponse">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- ゼロ個以上の失敗した操作のリスト -->
< エレメント名 = "failedOperations" type="tns:FailedOperations" minOccurs= "0" maxOccurs= "unbounded " />
<!-- A list of zero or more objects which contain the updated process details
操作が実行された後。 -->
< element name= "processDetails" type="tns:ProcessDetails" minOccurs= "0" maxOccurs= "unbounded " />
<! -- 要求されたアクションを正常に実行したインスタンスの数を提供します -->
< element name = "succeeded "type="int" minOccurs= "0 " maxOccurs= "1" />
<! -- 要求されたアクションを実行できなかったインスタンスの数を提供します -->
< element name = "failed "type="int" minOccurs= "0 " maxOccurs= "1" />
</sequence>
</extension>
</complexContent>
</complexType>
<complexType 名 = "ProcessBulkOperationCountOnlyResponse">
<complexContent>
< extension base="tns:ProcessBulkOperationResponse">
<sequence>
<! -- インスタンスの数を指定します -->
< element name= "instanceCount" type="long " minOccurs= "0" maxOccurs= "1 " />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to represent the runtime error information associated with a single process instance.
-->
<complexType 名 = "RuntimeError">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
< element name= "instanceId" type="string " minOccurs= "0" maxOccurs= "1 " />
< エレメント名 = "taskId" type="string " minOccurs= "0" maxOccurs= "1 " />
< エレメント名 = "errorMessage" type="string " minOccurs= "0" maxOccurs= "1 " />
< element name= "javaTrace" type="string " minOccurs= "0" maxOccurs= "1 " />
< element name= "jsTrace" type="string " minOccurs= "0" maxOccurs= "1 " />
< エレメント名 = "twTrace" type="string " minOccurs= "0" maxOccurs= "1 " />
< element name = "timestamp "type="dateTime" minOccurs= "0" maxOccurs= "1 " />
< element name= "branchId" type="string " minOccurs= "0" maxOccurs= "1 " />
< element name= "snapshotId" type="string " minOccurs= "0" maxOccurs= "1 " />
< element name= "rootSnapshotId" type="string " minOccurs= "0" maxOccurs= "1 " />
< エレメント名 = "sourceGuid" type="string " minOccurs= "0" maxOccurs= "1 " />
< エレメント名 = "errorCode" type="string " minOccurs= "0" maxOccurs= "1 " />
< エレメント名 = "errorData" type="string " minOccurs= "0" maxOccurs= "1 " />
< element name= "BPMN2Style" type= "boolean" minOccurs= "0 " maxOccurs= "1" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type is used to return the runtime error detail for one or more instance id.
-->
<complexType name= "RuntimeError応答 ">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- ゼロ個以上の失敗した操作のリスト -->
< エレメント名 = "failedOperations" type="tns:FailedOperations" minOccurs= "0" maxOccurs= "unbounded " />
<! -- プロセス・インスタンスのランタイム・エラー情報を含む 0 個以上のオブジェクトのリスト -->
< element name= "runtimeErrors" type="tns:RuntimeError" minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type represents a list of currently executing processes
-->
<complexType 名前 = "CurrentlyExecuting">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- 現在実行中のプロセス ID のリスト -->
< element name= "instanceIDs" type="string " minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
<! -- アドホック・アクティビティーのリスト。 -->
<complexType 名 = "adHocActivities">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
< element name="activities "type="activity :Activity" minOccurs= "0 " maxOccurs= "unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<! -- 入力、出力、およびプライベート変数名のデータ型 -->
<complexType 名前 = "VariableNames">
<complexContent>
< 拡張子 base= " pref :Data">
<sequence>
<! -- 入力変数名のリスト -->
< エレメント名 = "inputVariables" type="string " minOccurs= "0" maxOccurs= "unbounded " />
< エレメント名 = "outputVariables" type="string " minOccurs= "0" maxOccurs= "unbounded " />
< element name= "privateVariables" type="string " minOccurs= "0" maxOccurs= "unbounded " />
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
デフォルトのコンテンツ・タイプは次のとおりです。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": "追加の例外詳細 (スタック・トレースなど)。"
}
}
}
<?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>
| コード | 説明 |
|---|---|
| 200 OK | 正常終了。 |
| 400 間違った要求 | パラメーターが有効でないか、欠落しています。 |
| 401 認証が必要 | 呼び出し側は、この要求に対して許可されていません。 |
| 404 Not Found | プロセスが存在しません。
|
| 406 Not Acceptable | 要求されたコンテンツ・タイプまたはコンテンツ・エンコード方式がサポートされていません。 |
| 500 内部サーバー・エラー | 重大な問題が発生しました。プログラマーの詳細が提供されます。 |
7.5.0
親トピック: プロセス・リソース