IBM Business Process Manager, Version 8.5.5

REST interface for BPD-related resources - Instances Mentions Resource - GET Method

Retrieves the current list of items which mention the currently logged in user.

Sample method invocation

GET /rest/bpm/wle/v1/social/instances/mentions[?page={integer}][&pageSize={integer}][&since={string}][&sort={string}]

Parameters

Optional parameters
NameValue TypeDescription
page integer
The page of items to return. The default is no paging. Pages start at 1. Using 0 disables paging.
pageSize integer
The number of items to return on a page. The default is 10.
since string
A filter for returning items only available since this date/time. The format is in the form of "2010-10-10T00:00:00"
sort string
The sort order.
ValueDescription
asc
Sort the list in ascending order.
desc
Sort the list in descending order

Request content

None

Response content

An Activity Stream, as described by the specifications available at http://activitystrea.ms

The default content type is application/json.

MIME type: application/json

+ View example content
{
    items:[
        {
            actor:{
                displayName:"Internal TW Admin user",
                id:"tw_admin",
                objectType:"PERSON"
            },
            content:"Internal TW Admin user requested collaboration.",
            object:{
                id:"2078.92",
                objectType:"ibm.bpm.collaboration"
            },
            published:"2012-01-09T16:19:05.546-05:00",
            target:{
                displayName:"Internal TW Admin user",
                id:"tw_admin",
                objectType:"PERSON"
            },
            verb:"INVITE",
            ibmbpmext:{
                content:"help me",
                processName:"Employee Requisition for (3)",
                processId:"2072.3",
                taskName:"Submit job requisition",
                taskId:"2078.3"
            }
        },
        {
            actor:{
                displayName:"Internal TW Admin user",
                id:"tw_admin",
                objectType:"PERSON"
            },
            content:"Internal TW Admin user mentioned you in a post in Employee Requisition for (3). tagging Internal TW Admin user user",
            object:{
                id:"2078.90",
                objectType:"ibm.bpm.tagged"
            },
            published:"2012-01-09T16:18:44.779-05:00",
            target:{
                displayName:"Internal TW Admin user",
                id:"tw_admin",
                objectType:"PERSON"
            },
            verb:"POST",
            ibmbpmext:{
                content:"tagging Internal TW Admin user user",
                processName:"Employee Requisition for (3)",
                processId:"2072.3",
                taskId:"2078.89"
            }
        }
    ],
    totalItems:2,
    more:false
}

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:StreamActivityCollection>
	<items>
		<actor>
			<displayName>Internal TW Admin user</displayName>
			<id>tw_admin</id>
			<objectType>PERSON</objectType>
		</actor>
		<content>
			<span class=bpm-user-tag>Internal TW Admin user</span> requested collaboration.
		</content>
		<object>
			<id>2078.92</id>
			<objectType>ibm.bpm.collaboration</objectType>
		</object>
		<published>2012-01-09-05:00</published>
		<target>
			<displayName>Internal TW Admin user</displayName>
			<id>tw_admin</id>
			<objectType>PERSON</objectType>
		</target>
		<verb>INVITE</verb>
		<ibmbpmext>
			<content>help me</content>
			<processName>Employee Requisition for (3)</processName>
			<processId>2072.3</processId>
			<taskName>Submit job requisition</taskName>
			<taskId>2078.3</taskId>
		</ibmbpmext>
	</items>
	<items>
		<actor>
			<displayName>Internal TW Admin user</displayName>
			<id>tw_admin</id>
			<objectType>PERSON</objectType>
		</actor>
		<content>
			<span class="user">Internal TW Admin user</span> mentioned you in a post in
			<span class="process">Employee Requisition for (3)</span>.
			<span class="post"> tagging <span class="bpm-user-tag">Internal TW Admin user</span> user</span>
		</content>
		<object>
			<id>2078.90</id>
			<objectType>ibm.bpm.tagged</objectType>
		</object>
		<published>2012-01-09-05:00</published>
		<target>
			<displayName>Internal TW Admin user</displayName>
			<id>tw_admin</id>
			<objectType>PERSON</objectType>
		</target>
		<verb>POST</verb>
		<ibmbpmext>
			<content>tagging<span class="bpm-user-tag">Internal TW Admin user</span>user</content>
			<processName>Employee Requisition for (3)</processName>
			<processId>2072.3</processId>
			<taskId>2078.89</taskId>
		</ibmbpmext>
	</items>
	<totalItems>2</totalItems>
	<more>false</more>
</soc:StreamActivityCollection>

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:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
406 Not AcceptableThe requested content type or content encoding is not supported.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available since

8.0.0

Parent Topic: Instances Mentions Resource



Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)