REST API for Oracle Integration

機械翻訳について

タスク・コメントの追加

post

/ic/api/process/v1/tasks/{id}/comments

タスクにコメントを追加します。

リクエスト

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

application/json

パス・パラメータ

id(required): string

Task Number

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レスポンス

コメントは正常に追加された

ルート・スキーマ : コメント

型: object

ソースを表示

comment: array comment
levels: integer(int32)
links: array links
title: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "comment":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Comment"
            }
        }
    },
    "xml":{
        "name":"comments",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

ネストされたスキーマ: comment

型: array

ソースを表示

Array of: object comment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Comment"
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ: comment

型: object

ソースを表示

commentScope: string
commentStr: string
updatedBy: string
updateddDate: string
userId: string

{
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "updateddDate":{
            "type":"string"
        },
        "commentScope":{
            "type":"string"
        }
    },
    "xml":{
        "name":"comment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

ネストされたスキーマ: Link

型: object

ソースを表示

href: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400レスポンス

不正リクエスト

404レスポンス

タスクが見つからない

409レスポンス

失効したタスク・オブジェクトが見つかった

500レスポンス

内部サーバー・エラー

トップに戻る

例

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

リクエストの送信

次の例では、送信リクエストのコンテンツを示しています。

https://example.com/ic/api/process/v1/tasks/<taskId>/comments

説明

example.com は、Oracle Integrationが実行されているホストです。
<taskId > は、「タスク・リストを取得」を使用して取得するタスクIDです。

リクエスト本文の例

{
  "commentStr":"This is my comment.",
  "commentScope":"BPM"
  }

commentScope属性に指定できる値は次のとおりです:

BPM : コメントを特定のプロセス・インスタンスのすべてのタスクで使用できるようにするには、BPMオプションを使用します。
TASK: タスク・レベルのコメントにはTASKオプションを使用します。

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

Status Code: 200 OK
Date: Wed, 27 Apr 2016 00:53:16 GMT
Content-Type: application/json

レスポンス本文の例

{
 "levels": 0,
 "links": [
{
 "href": "http://example.com/ic/api/process/v1/tasks/200002",
 "length": 0,
 "rel": "parent"
},
{
 "href": "http://example.com/ic/api/process/v1/tasks/200002/comments",
 "length": 0,
 "rel": "self"
},
{
 "href": "http://example.com/ic/api/process/v1/tasks/200002/comments",
 "length": 0,
 "rel": "canonical"
}
],
"comment": [
{
 "commentStr": "This is my comment",
 "updatedBy": "jsmith",
 "userId": "jsmith",
 "updateddDate": "2016-12-19T06:10:21.000Z",
 "commentScope": "BPM"
}
]
}

先頭に戻る