Jump to

• Request
• Response
• Examples

Add Comments to a Process

post

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

Adds comments to a process

Request

Supported Media Types

• application/json

Path Parameters

• processId: string
  Value of process ID

Body ()

CommentRequest

Root Schema : commentRequest

Type: object

The representation of a CommentRequest

Show Source

• commentScope(optional): string
  Allowed Values: [ "BPM", "TASK" ]

  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.

  Example: BPM
• commentStr: string
  comment string

  Example: comment test
• displayNameLanguage(optional): string
  displayName language

  Example: US
• participant(optional): 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

500 Response

Internal server error

Back to Top

Examples

The following example shows how to add a comment by submitting a POST request on the REST resource:

Send Request

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

Where,

• example.com is the host where Oracle Integration is running.

• <version> is the REST API version.

• <Process ID> is the ID of the process for which you want to add a comment.

  For example, 1. You can get the <Process ID> using Retrieves Process Instance List.

Example of Request Body

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

Example of Response Header

Status Code: 200 OK

Example of Response Body

{
  "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
}

Back to Top