Interfejs usług REST dla zasobów związanych z definicją procesu biznesowego-metoda POST-metoda POST-zasób komentarza

Umożliwia opublikowanie komentarza w wątku do istniejącego komentarza. Należy określić identyfikator zadania komentarza, dla którego ma być przeznaczona odpowiedź.

Przykładowe wywołanie metody

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

Użycie notatek

Użytkownik może oznaczyć użytkownika w komentarzach, włączając w to nazwę tego użytkownika, w otoczeniu znacznika w treści komentarza. Na przykład:

                  <taggedUser> tw_admin <taggedUser/>

Parametry

Parametry opcjonalne

Nazwa	Typ wartości	Opis
komunikat	łańcuch	Łańcuch zawierający parametr JSON w celu ustawienia komunikatu w komentarzu. Ze względu na możliwe długość komunikatów komentarza zaleca się dołączenie łańcucha w treści zamiast jako parametru. Przykład: {"message":"This is my threaded comment."}

Treść żądania

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

Łańcuch zawierający parametr JSON, który określa komunikat dla komentarza.

Przykład:

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

                      Nagłówki HTTP:
                      Content-Type: application/x-www-form-urlencoded
                      Akceptuj: application/json

                      Treść żądania HTTP:
                      {"orderNumber":"This is my threaded comment."}

Treść odpowiedzi

Wysłany wynik (PostedResult complexType).

Domyślny typ treści toapplication/json.

Typ MIME: application/json

Schemat

{"description": "Zanapisana treść", 
   "type":"object",
   "właściwości":
   {  
      "message": {"typ": "łańcuch",
         "description": "The comment message being posted"
      }   
   }
}

Przykładowa treść

{
    wysłana: true
}

Typ MIME: application/xml

Schemat

<?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" />

 
    
    <! -- Początek strony społecznościowej -- >
    
   <simpleType name= "StreamObjectType">
      <restriction base="string">
         < enumeration value="działanie " />
         < enumeration value="artykuł " />
         < enumeration value= "odznaka" />
         < enumeration value= "zakładka" />
         < enumeration value="kolekcja " />
         < enumeration value="komentarz " />
         < enumeration value="zdarzenie " />
         < enumeration value="plik " />
         < enumeration value="grupa " />
         < enumeration value="obraz " />         
         < enumeration value="uwaga " />
         < enumeration value="osoba " />
         < enumeration value="miejsce " />
         < enumeration value="produkt " />
         < enumeration value="pytanie " />
         < enumeration value="przegląd " />
         < enumeration value="usługa " />
         < enumeration value="wideo " />
      </restriction>
   </simpleType>
   
   
   <simpleType name= "StreamVerb">
      <restriction base="string">
         < enumeration value="post " />
         < enumeration value="add " />
         < enumeration value="anuluj " />
         < enumeration value="checkin " />
         < enumeration value="delete " />
         < enumeration value="ulubiony " />
         < enumeration value="follow " />
         < enumeration value="daj " />
         < enumeration value="ignore " />
         < enumeration value="zaproszenie " />         
         < enumeration value="łączenie " />
         < enumeration value="leave " />
         < enumeration value="like " />
         < enumeration value="make-przyjaciel " />
         < enumeration value="play " />
         < enumeration value="receive " />
         < enumeration value="remove " />
         < enumeration value="remove-friend " /> 
         < enumeration value="request-friend " />  
         < enumeration value="rsvp-może " />  
         < enumeration value="rsvp-no " />  
         < enumeration value="rsvp-yes " />  
         < enumeration value="zapisz " />  
         < enumeration value="share " />  
         < enumeration value="stop-następujący " />  
         < enumeration value="znacznik " />  
         < enumeration value="unulubionych " />  
         < enumeration value="inaczej niż " />  
         < enumeration value="unsave " />  
         < enumeration value="aktualizacja " />                                                                                                                                              
      </restriction>
   </simpleType> 
   
    <complexType name= "PostedContent">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "message "type="string" />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name= "PostedResult">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "posted "type=" boolean " />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>    

    <complexType name= "FollowedResult">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "przestrzegany "type=" boolean " />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>   

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

    <complexType name= "ToolbarCollapsed">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "scalony "type=" boolean " />
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "method "type="string" />
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name= "RequestValid">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "valid "type=" boolean " />
		    	<! -- MUSI ZAWIERAĆ -- >
		    	< element name = "method "type="string" />
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>                
   
    <complexType name= "StreamMediaLink">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
	    		<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "duration "type="integer" />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "height "type="integer" />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "width "type="integer" />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "url "type="string" />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    

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

    <complexType name= "StreamObjectCollection">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
	    		<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "items "type="tns:StreamObject" minOccurs= "0 " maxOccurs= "unbounded" />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name= "totalItems" type="integer " />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "url "type="string" />		    			    			    			    			    			    			    			    	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name= "StreamActivityCollection">
	<complexContent>
	    < extension base="data :Data">
	    	<sequence>
	    		<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "items "type="tns:StreamActivity" minOccurs= "0 " maxOccurs= "unbounded" />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name= "totalItems" type="integer " />
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< element name = "url "type="string" />		    			    			    			    			    			    			    			    	
		    	<! -- MOŻE ZAWIERAĆ -- >
		    	< 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>

Przykładowa treść

< 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>
Prawda
< /posted>
< /soc:PostedResult>

Typ MIME: application/x-javascript

Treść odpowiedzi o błędzie

Szczegółowe informacje o błędzie.

Domyślny typ treści toapplication/json.

Typ MIME: application/json

Schemat

{"description": "Odpowiedź na błąd WLE", 
   "type":"object",
   "właściwości":
   {"status": {"typ": "łańcuch",
         "description": "Status poprzedniego wywołania funkcji API."
      },
      "exceptionType": {"typ": "łańcuch",
         "description": "Nazwa klasy powiązana z wyjątkiem."
      },
      "errorNumber": {"typ": "łańcuch",
         "description": "Identyfikator komunikatu wyjątku."
      },
      "errorMessage": {"type": "string",
         "description": "Tekst komunikatu wyjątku."
      },
      "errorMessageParametry": {"type": [ "string"], "optional": true,
         "description": "Parametry tekstu komunikatu wyjątku."
      },
      "programmersDetails": {"type": "obiekt", "opcjonalny": true,
         "description": "Dodatkowe szczegóły wyjątku, na przykład stos wywołań."
      }
   }
}

Typ MIME: application/xml

Schemat

<?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" />
    
    <!--
	Ten typ reprezentuje odpowiedź na błąd.
    -->    
    < element name= "RestRuntimeException">
	<complexType>
	    <sequence>
		< element name = "status "type="string" />
		< element name="Data " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 Ten typ zawiera szczegółowe informacje o błędach powiązane z wyjątkiem.
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < element name = "status "type="string" />

	    <! -- Ta opcja określa nazwę klasy języka Java dla wyjątku -- >
	    < element name= "exceptionType" type="string " />

	    <! -- Identyfikator komunikatu o błędzie -- >
	    < element name= "errorNumber" type="string " minOccurs= "0" />

	    <! -- kompletny komunikat o błędzie -- >
	    < element name= "errorMessage" type="string " />

	    <! -- Lista łańcuchów wstawionych do komunikatu o błędzie -- >
	    < element name= "errorMessageParameters" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 Stos wywołań powiązany z wyjątkiem.
		 Należy pamiętać, że zostanie pominięta, chyba że właściwość "server-stacktrace-enabled"
		 jest włączona w pliku 100Custom.xml serwera.
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- Wcześniejsze odpowiedzi.  Ustaw, jeśli użyto komendy masowej -- >
	    < element name = "responses "type="dat:BulkCommandOdpowiedzi" minOccurs= "0"> < /element>

            < element name= "errorData" type="tns:ErrorData" minOccurs= "0" />
	</sequence>
    </complexType>

    <complexType name= "ErrorData">
        <sequence>
            < element name = "code "type = "string" />
            < element name = "data "type="string" minOccurs= "0 " />
        </sequence>
    </complexType>
    
</schema>

Typ MIME: application/x-javascript

Kody statusu

Metoda zwraca jeden z następujących kodów statusu:

Kod	Opis
200 OK	Zakończenie powiodło się.
400 Błędne żądanie	Parametry są niepoprawne lub nie są one poprawne.
404 Nie znaleziono	Zadanie nie istnieje.
406 Nieakceptowalne	Żądany typ treści lub kodowanie treści nie jest obsługiwane.
500 Wewnętrzny błąd serwera	Wystąpił poważny problem. Szczegółowe informacje o programiście są dostępne.

Dostępne od

8.0.0

Temat Nadrzędny: Zasób Komentarza Po Zagrożonym Użyciu