Previous Next

Add a Case Comment

post

/cases/{id}/comments

Adds a comment to a case.

Request

Supported Media Types
  • application/json
  • application/xml
Body Parameter
Root Schema : /paths/~1cases~1{id}~1comments/post/parameters/0/schema
Example application/json

{
    "commentStr":"Testing Comments Post REST API"
}

Response

Supported Media Types
  • application/json
  • application/xml
200 Response
Success
Body
Root Schema : /paths/~1cases~1{id}~1comments/post/responses/200/schema
Example application/json

{
    "type":"comments",
    "levels":0,
    "links":[
        {
            "rel":"back",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
        },
        {
            "rel":"self",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/comments"
        }
    ],
    "comment":{
        "comment":[
            {
                "commentStr":"Testing Comments Post REST API",
                "updatedBy":"jstein",
                "updatedDate":"2015-06-08 14:43:08"
            },
            {
                "commentStr":"Creating a case link",
                "updatedBy":"wfaulk",
                "updatedDate":"2015-06-05 17:42:51"
            }
        ]
    }
}

Examples

The following example shows a response body when adding a comment to a case.

  {
                        "type": "comments",
                        "levels": 0,
                        "links": [{
                        "rel": "back",
                        "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
                            },
                            {
                        "rel": "self",
                        "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/comments"
                         }],
                        "comment": {
                        "comment": [{
                        "commentStr": "Testing Comments Post REST API",
                        "updatedBy": "jstein",
                        "updatedDate": "2015-06-08 14:43:08"
                         },
                             {
                        "commentStr": "Creating a case link",
                        "updatedBy": "wfaulk",
                        "updatedDate": "2015-06-05 17:42:51"
                        }]
                         }
                            }

For more information about cURL, see Use cURL