IBM Business Process Manager, Version 8.5.5

REST interface for BPD-related resources - Post Threaded Comment Resource - POST Method

Allows posting a threaded comment to an existing comment. The task ID passed in is the task ID of the comment for which the response is intended.

Sample method invocation

POST /rest/bpm/wle/v1/social/task/{taskId}/comment[?message={string}]

Usage Notes

It is possible to tag a user via comments, by including their username surrounded by a tag in the comment body. For example:

<taggedUser>tw_admin<taggedUser/>

Parameters

Optional parameters

Name	Value Type	Description
message	string	A string containing a JSON parameter for setting the message in the comment. Because of the possible length of comment messages, it is recommended to include this in the body, rather than as a parameter. Example: {"message":"This is my threaded comment"}

Request content

MIME type: application/x-www-form-urlencoded

A string containing the JSON parameter, setting the message for the comment.

Example:

   POST  http://myhost.mycompany.com:9080/rest/bpm/wle/v1/social/taskId/3/comment

   HTTP Headers:
      Content-Type: application/x-www-form-urlencoded
      Accept: application/json

   HTTP Request Body:
      {"orderNumber":"This is my threaded comment"}

Response content

Posted result (PostedResult complexType).

The default content type is application/json.

MIME type: application/json

+ View schema

{  "description": "Posted Content", 
   "type": "object",
   "properties":
   {  
      "message": {"type": "string",
         "description": "The comment message being posted"
      }   
   }
}

+ View example content

{
    posted:true
}

MIME type: application/xml

+ View schema

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/social"
        elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:tns="http://rest.bpm.ibm.com/v1/data/social"
        xmlns:data="http://rest.bpm.ibm.com/v1/data/root"
        xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common">

    <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
    <import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>

 
    
    <!--  Start of Social  -->
    
   <simpleType name="StreamObjectType">
      <restriction base="string">
         <enumeration value="activity"/>
         <enumeration value="article"/>
         <enumeration value="badge"/>
         <enumeration value="bookmark"/>
         <enumeration value="collection"/>
         <enumeration value="comment"/>
         <enumeration value="event"/>
         <enumeration value="file"/>
         <enumeration value="group"/>
         <enumeration value="image"/>         
         <enumeration value="note"/>
         <enumeration value="person"/>
         <enumeration value="place"/>
         <enumeration value="product"/>
         <enumeration value="question"/>
         <enumeration value="review"/>
         <enumeration value="service"/>
         <enumeration value="video"/>
      </restriction>
   </simpleType>
   
   
   <simpleType name="StreamVerb">
      <restriction base="string">
         <enumeration value="post"/>
         <enumeration value="add"/>
         <enumeration value="cancel"/>
         <enumeration value="checkin"/>
         <enumeration value="delete"/>
         <enumeration value="favorite"/>
         <enumeration value="follow"/>
         <enumeration value="give"/>
         <enumeration value="ignore"/>
         <enumeration value="invite"/>         
         <enumeration value="join"/>
         <enumeration value="leave"/>
         <enumeration value="like"/>
         <enumeration value="make-friend"/>
         <enumeration value="play"/>
         <enumeration value="receive"/>
         <enumeration value="remove"/>
         <enumeration value="remove-friend"/> 
         <enumeration value="request-friend"/>  
         <enumeration value="rsvp-maybe"/>  
         <enumeration value="rsvp-no"/>  
         <enumeration value="rsvp-yes"/>  
         <enumeration value="save"/>  
         <enumeration value="share"/>  
         <enumeration value="stop-following"/>  
         <enumeration value="tag"/>  
         <enumeration value="unfavorite"/>  
         <enumeration value="unlike"/>  
         <enumeration value="unsave"/>  
         <enumeration value="update"/>                                                                                                                                              
      </restriction>
   </simpleType> 
   
    <complexType name="PostedContent">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="message" type="string"/>
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name="PostedResult">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="posted" type="boolean"/>
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>    

    <complexType name="FollowedResult">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="followed" type="boolean"/>
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>   

    <complexType name="HelpRequest">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="instanceId" type="integer"/>
		    	<!-- MUST CONTAIN  -->
		    	<element name="sendTo" type="string"/>
		    	<!-- MUST CONTAIN  -->
		    	<element name="description" type="string"/>
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType> 
    
    <complexType name="HelpResult">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="valid" type="boolean"/>
		    	<!-- MUST CONTAIN  -->
		    	<element name="method" type="string"/>
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>

    <complexType name="ToolbarCollapsed">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="collapsed" type="boolean"/>
		    	<!-- MUST CONTAIN  -->
		    	<element name="method" type="string"/>
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name="RequestValid">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
		    	<!-- MUST CONTAIN  -->
		    	<element name="valid" type="boolean"/>
		    	<!-- MUST CONTAIN  -->
		    	<element name="method" type="string"/>
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>                
   
    <complexType name="StreamMediaLink">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
	    		<!-- MAY CONTAIN  -->
		    	<element name="duration" type="integer"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="height" type="integer"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="width" type="integer"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="url" type="string"/>
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    

    <complexType name="StreamObject">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
	    		<!-- MAY CONTAIN  -->
		    	<element name="attachments" type="tns:StreamObject"  minOccurs="1" maxOccurs="unbounded"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="author" type="tns:StreamObject"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="content" type="string"/>
		    	<!-- MAY/SHOULD CONTAIN  -->
		    	<element name="displayName" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="fileName" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="downstreamDuplicates" type="string"  minOccurs="1" maxOccurs="unbounded"/>
		    	<!-- SHOULD CONTAIN  -->
		    	<element name="id" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="parent" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="image" type="tns:StreamMediaLink"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="objectType" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="published" type="date"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="summary" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="updated" type="date"/>		    			    	
		    	<!-- MAY CONTAIN  -->
		    	<element name="upstreamDuplicates" type="string"  minOccurs="1" maxOccurs="unbounded"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="url" type="string"/>		    	   			    			    			    			    			    			    			    			    	
		    	<!-- MAY CONTAIN  -->
		    	<element name="processName" type="string"/>		    	   			    			    			    			    			    			    			    			    	
		    	<!-- MAY CONTAIN  -->
		    	<element name="processId" type="string"/>	
		    	<!-- MAY CONTAIN  -->
		    	<element name="taskName" type="string"/>	
		    	<!-- MAY CONTAIN  -->
		    	<element name="taskId" type="string"/>	
		    	<!-- MAY CONTAIN  -->
		    	<element name="taskText" type="string"/>	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType> 
    
    
    <complexType name="StreamActivity">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
	    		<!-- MUST CONTAIN  -->
		    	<element name="actor" type="tns:StreamObject"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="content" type="string"/>
	    		<!-- MAY CONTAIN  -->
		    	<element name="generator" type="tns:StreamObject"/>
	    		<!-- MAY CONTAIN  -->
		    	<element name="icon" type="tns:StreamMediaLink"/>	
		    	<!-- SHOULD CONTAIN  -->
		    	<element name="id" type="string"/>		    	
	    		<!-- SHOULD CONTAIN  -->
		    	<element name="object" type="tns:StreamObject"/>		    	
		    	<!-- MUST CONTAIN  -->
		    	<element name="published" type="date"/>		    	
	    		<!-- MAY CONTAIN  -->
		    	<element name="provider" type="tns:StreamObject"/>			    	
	    		<!-- MAY CONTAIN  -->
		    	<element name="target" type="tns:StreamObject"/>		    	
		    	<!-- MAY CONTAIN  -->
		    	<element name="title" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="updated" type="date"/>		    			    	
		    	<!-- MAY CONTAIN  -->
		    	<element name="url" type="string"/>
		    	<!-- SHOULD CONTAIN  -->
		    	<element name="verb" type="string"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="replies" type="tns:StreamObjectCollection"/>		    	
	    		<!-- MAY CONTAIN  -->
		    	<element name="ibmbpmext" type="tns:StreamObject"/>		    			    	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>

    <complexType name="StreamObjectCollection">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
	    		<!-- MAY CONTAIN  -->
		    	<element name="items" type="tns:StreamObject"  minOccurs="0" maxOccurs="unbounded"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="totalItems" type="integer"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="url" type="string"/>		    			    			    			    			    			    			    			    	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name="StreamActivityCollection">
	<complexContent>
	    <extension base="data:Data">
	    	<sequence>
	    		<!-- MAY CONTAIN  -->
		    	<element name="items" type="tns:StreamActivity"  minOccurs="0" maxOccurs="unbounded"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="totalItems" type="integer"/>
		    	<!-- MAY CONTAIN  -->
		    	<element name="url" type="string"/>		    			    			    			    			    			    			    			    	
		    	<!-- MAY CONTAIN  -->
		    	<element name="more" type="boolean"/>		    			    			    			    			    			    			    			    	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>	
    
    
   	<element name="PostedContent" type="tns:PostedContent" />
   	<element name="HelpRequest" type="tns:HelpRequest" />    	
   	<element name="PostedResult" type="tns:PostedResult" />
   	<element name="FollowedResult" type="tns:FollowedResult" />
   	<element name="HelpResult" type="tns:HelpResult" />
   	<element name="ToolbarCollapsed" type="tns:ToolbarCollapsed" />
   	<element name="RequestValid" type="tns:RequestValid" />
   	<element name="StreamMediaLink" type="tns:StreamMediaLink" />    	    	    	    	
   	<element name="StreamObject" type="tns:StreamObject" />
   	<element name="StreamActivity" type="tns:StreamActivity" />
   	<element name="StreamObjectCollection" type="tns:StreamObjectCollection" />
	<element name="StreamActivityCollection" type="tns:StreamActivityCollection" />
    	    	    	    	    	

</schema>

+ View example content

<soc:PostedResult
xmlns:bpm="http://rest.bpm.ibm.com/v1/data"
xmlns:ex="http://rest.bpm.ibm.com/v1/data/exception"
xmlns:soc="http://rest.bpm.ibm.com/v1/data/social"
xmlns:sys="http://rest.bpm.ibm.com/v1/data/system"
xmlns:ug="http://rest.bpm.ibm.com/v1/data/usergroup">
	
<posted>
true
</posted>
</soc:PostedResult>

MIME type: application/x-javascript

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

+ View schema

{  "description": "WLE Error Response", 
   "type": "object",
   "properties":
   {  "status": {"type": "string",
         "description": "The status of the previous API call."
      },
      "exceptionType": {"type": "string",
         "description": "The classname associated with the exception."
      },
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional exception details, for example, a stack trace."
      }
   }
}

MIME type: application/xml

+ View schema

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception"
	xmlns:dat="http://rest.bpm.ibm.com/v1/data/root">

    <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
    
    <!--
	This type represents an error response.
    -->    
    <element name="RestRuntimeException">
	<complexType>
	    <sequence>
		<element name="status" type="string"/>
		<element name="Data" type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 This type contains detailed error information associated with an exception.
    -->
    <complexType name="ExceptionData">
	<sequence>
	    <element name="status" type="string"/>

	    <!-- This specifies the java class name of the exception -->
	    <element name="exceptionType" type="string"/>

	    <!-- The message ID of the error message -->
	    <element name="errorNumber" type="string" minOccurs="0"/>

	    <!-- The complete error message -->
	    <element name="errorMessage" type="string"/>

	    <!-- The list of strings inserted into the error message -->
	    <element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/>

	    <!-- 
		 The stacktrace associated with the exception.
		 Note that this will be omitted unless the "server-stacktrace-enabled" property
		 is enabled in the server's 100Custom.xml file.
	    -->     
	    <element name="programmersDetails" type="string"></element>
	    
	    <!-- Prior responses.  Set if a bulk command was used -->
	    <element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element>
	</sequence>
    </complexType>
</schema>

MIME type: application/x-javascript

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
404 Not Found	The task does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred, programmer's details are provided.

Available since

8.0.0

Parent Topic: Post Threaded Comment Resource