REST API for Common Features in Oracle Fusion Cloud Applications

Add a Task Comment

post

/bpm/api/4.0/tasks/{id}/comments

Adds a comment to a task.

Request

Path Parameters

id(required): string

Task Id

Supported Media Types

application/json

Root Schema : schema

Type: object

The representation of a CommentRequest

Show Source

commentStr(required): string

comment string

Example: comment test
displayNameLanguage: string

displayName language

Example: US

{
    "required":[
        "commentStr"
    ],
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string",
            "description":"comment string",
            "example":"comment test"
        },
        "displayNameLanguage":{
            "type":"string",
            "description":"displayName language ",
            "example":"US"
        }
    },
    "description":"The representation of a CommentRequest",
    "xml":{
        "name":"commentRequest",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Response

Supported Media Types

application/json

200 Response

Comment successfully added

Root Schema : comments

Type: object

Show Source

comment: array comment

{
    "type":"object",
    "properties":{
        "comment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Comment"
            }
        }
    },
    "xml":{
        "name":"comments",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : comment

Type: array

Show Source

Array of: object comment

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

Nested Schema : comment

Type: object

Show Source

commentStr: string

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

400 Response

Bad request

404 Response

Task not found

409 Response

Stale task object found

500 Response

Internal Server Error