機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

プロセスにコメントを追加

post

/ic/api/process/v1/processes/{processId}/comments

プロセスにコメントを追加します

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• processId(required): string
  プロセスIDの値

本文()

CommentRequest

ルート・スキーマ : commentRequest

型: object

CommentRequestの表現

ソースを表示

• commentScope: string
  指定できる値: [ "BPM", "TASK" ]

  コメントのスコープ - REST APIによりコメントを投稿する場合は、SCOPEをBPMまたはTASKとして指定して、コメントをプロセス・インスタンス・レベルで表示できるようにするかそれともタスク・レベルのみで表示できるようにするかを指定する必要があります。

  例: BPM
• commentStr(required): string
  コメント文字列

  例: comment test
• displayNameLanguage: string
  displayName言語

  例: US
• participant: string

{
    "type":"object",
    "required":[
        "commentStr"
    ],
    "properties":{
        "commentStr":{
            "type":"string",
            "example":"comment test",
            "description":"comment string"
        },
        "commentScope":{
            "type":"string",
            "example":"BPM",
            "description":"comment scope - When you post a comment through REST API, you need  to give SCOPE as either BPM or TASK in order for it to be visible at process instance level or only task level.",
            "enum":[
                "BPM",
                "TASK"
            ]
        },
        "displayNameLanguage":{
            "type":"string",
            "example":"US",
            "description":"displayName language "
        },
        "participant":{
            "type":"string"
        }
    },
    "description":"The representation of a CommentRequest",
    "xml":{
        "name":"commentRequest",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、RESTリソースに対するPOSTリクエストを発行することによって、コメントを追加する方法を示しています。

リクエストの送信

https://example.com/ic/api/process/v1/processes/{processId}/comments

説明

• example.comは、Oracle Integrationが実行されているホストです。

• <version>はREST APIバージョンです。

• <Process ID>は、コメントを追加するプロセスのIDです。

  たとえば、 1 「プロセス・インスタンス・リストの取得」を使用して<Process ID>を取得できます。

リクエスト本文の例

{
"commentStr": "This is my comment."
}

レスポンス・ヘッダーの例

Status Code: 200 OK

レスポンス本文の例

{
  "hasMore": false,
  "items": [
    {
      "commentStr": "This is my comment.",
      "updatedDate": "2016-12-19T06:10:21.000Z"
    },
    {
      "commentStr": "This is my comment.",
      "updatedDate": "2016-12-21T08:53:07.000Z"
    }
  ],
  "links": [
    {
      "href": "http://host:port/ic/api/process/v1/processes/{processId}/comments",
      "length": 0,
      "rel": "self"
    },
    {
      "href": "http://host:port/ic/api/process/v1/processes/2",
      "length": 0,
      "rel": "parent"
    }
  ],
  "totalResults": false
}

先頭に戻る