11.5.40　イベント（メッセージ）の送信処理 : uCosminexus Service Coordinator Interactive Workflow BPMN連携機能　使用の手引

メソッドとURL

POST /v1/event/send-message/<案件ID>

<案件ID>：イベント（メッセージ）の送信処理をする案件ID（必須）

リクエストボディ

項番	名前	型	指定要否	内容
1	UserDescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。
2	ProcessDataList	配列	省略可	プロセスデータ一覧を指定します。省略した場合はプロセスデータを更新しません。
3	ProcessData	オブジェクト	必須	プロセスデータオブジェクトを指定します。次の2つの要素（KeyおよびValue）から構成されています。
4	Key	文字列	必須	プロセスデータキー名を指定します。空文字列は指定できません。
5	Value	文字列	省略可	プロセスデータ値を指定します。省略した場合，Keyに対応する値は未設定となります。空文字列は指定できません。
6	MessageRef	文字列	必須	メッセージを受信するイベントのMessageRefを指定します。空文字列は指定できません。

リクエストボディの構造を次に示します。

項番	名前				出現回数
1	Parameter				1
2		UserDescription			0または1
3		ProcessDataList			0または1
4			ProcessData		1以上
5				Key	1
6				Value	0または1
7		MessageRef			1

リクエスト例

リクエストURL

POST http://restserver/csciwws/v1/event/send-message/5001

リクエストボディ（XMLの場合）

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <UserDescription>csciwuser</UserDescription>
  <ProcessDataList>
    <ProcessData>
      <Key>$Sdata1</Key>
      <Value>stringvalue1</Value>
    </ProcessData>
    <ProcessData>
      <Key>$Ndata2</Key>
      <Value>100</Value>
    </ProcessData>
  </ProcessDataList>
  <MessageRef>message1</MessageRef>
</Parameter>

リクエストボディ（JSONの場合）

{
  "UserDescription" : "csciwuser",
  "ProcessDataList" : {
    "ProcessData" : [
      {
        "Key" : "$Sdata1",
        "Value" : "stringvalue1"
      },
      {
        "Key" : "$Ndata2",
        "Value" : "100"
      }
    ]
  },
  "MessageRef" : "message1"
}

レスポンス

レスポンスボディは空になります。

ステータスコード

項番	ステータスコード	内容
1	204	成功
2	400	リクエストパラメタの不正
3	404	データが見つからなかった
4	500	内部処理エラー

レスポンス例

レスポンスボディは空になります。

11.5.40 イベント（メッセージ）の送信処理

11.5.40　イベント（メッセージ）の送信処理