Interface REST para recursos relacionados à BPD – Recurso Seguindo Instância – Método DELETE

Use este método para parar de seguir uma instância de processo específica.

Chamada de método de amostra

DELETE /rest/bpm/wle/v1/social/instance/{instanceId}/following

Parâmetros

Nenhum

Conteúdo da solicitação

Nenhum

Conteúdo de resposta

Seguindo resultado (FollowedResult complexType).

O tipo de conteúdo padrão éapplication/json.

Tipo MIME: application / json


SCHEMA
{  "description": "Seguindo Resposta", 
   "type": "object",
   "properties":
   {  
      "followed": {"type": "boolean",
         "description": "Se o usuário está seguindo a tarefa ou instância de processo fornecida"
      }   
   }
}
Exemplo de conteúdo
{
    followed:false
}

Tipo MIME: application / xml


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

 
    
    <! -- Início do Social -->
    
   <simpleType name= "StreamObjectType">
      <restriction
base="string">
         < enumeration value="atividade " />
         < enumeration value="artigo " />
         < 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="nota " />
         < enumeration value="person " />
         < enumeration value="place " />
         < enumeration value="produto " />
         < enumeration value="questionar " />
         < 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="cancelar " />
         < enumeration value="checkin " />
         < enumeration value="delete " />
         < enumeration value="favorito " />
         < enumeration value="follow " />
         < enumeration value="dão " />
         < enumeration value="ignore " />
         < enumeration value="convidar " />         
         < enumeration value="join " />
         < enumeration value="leave " />
         < enumeration value="like " />
         < enumeration value="make-friend " />
         < enumeration value="play " />
         < enumeration value="receba " />
         < enumeration value="remover " />
         < enumeration value="remove-friend " /> 
         < enumeration value="request-friend " />  
         < enumeration value="rsvp-talvez " />  
         < enumeration value="rsvp-no " />  
         < enumeration value="rsvp-yes " />  
         < enumeration value="save " />  
         < enumeration value="share " />  
         < enumeration value="stop-seguindo " />  
         < enumeration value="tag " />  
         < enumeration value="unfavorito " />  
         < enumeration value="diferentemente de " />  
         < enumeration value="unsave " />  
         < enumeration value="update " />                                                                                                                                              
      </restriction>
   </simpleType> 
   
    <complexType name= "PostedContent">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "mensagem "type="string" />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name= "PostedResult">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "postado "type=" boolean " />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>    

    <complexType name= "FollowedResult">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "seguido "type=" boolean " />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>   

    <complexType name= "HelpRequest">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< element name= "instanceId" type="integer " />
		    	<! -- DEVE CONTER -->
		    	< element name= "sendTo" type="string " />
		    	<! -- DEVE CONTER -->
		    	<element name="description" type="string"/>
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType> 
    
    <complexType name= "HelpResult">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "válido "type=" boolean " />
		    	<! -- DEVE CONTER -->
		    	< elemento name = "method "type="string" />
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>

    <complexType name= "ToolbarCollapsed">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "colapsado "type=" boolean " />
		    	<! -- DEVE CONTER -->
		    	< elemento name = "method "type="string" />
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name= "RequestValid">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "válido "type=" boolean " />
		    	<! -- DEVE CONTER -->
		    	< elemento name = "method "type="string" />
		    </sequence>		    		    
	    </extension>
	</complexContent>
    </complexType>                
   
    <complexType name= "StreamMediaLink">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
	    		<! -- PODE CONTER -->
		    	< nome do elemento = "duração "type="integer" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "altura "type="integer" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "largura "type="integer" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "url "type="string" />
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    

    <complexType name= "StreamObject">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
	    		<! -- PODE CONTER -->
		    	< element name = "attachments "type="tns:StreamObject" minOccurs= "1 " maxOccurs= "unbounded" />
		    	<! -- PODE CONTER -->
		    	< element name = "author "type="tns:StreamObject" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "content "type="string" />
		    	<! -- MAY/DEVERIA CONTER -->
		    	< element name= "displayName" type="string " />
		    	<! -- PODE CONTER -->
		    	< element name= "fileName" type="string " />
		    	<! -- PODE CONTER -->
		    	< element name= "downstreamDuplicates" type="string " minOccurs= "1" maxOccurs= "unbounded " />
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "id "type="string" />
		    	<! -- PODE CONTER -->
		    	< elemento name = "parent "type="string" />
		    	<! -- PODE CONTER -->
		    	< element name = "image "type="tns:StreamMediaLink" />
		    	<! -- PODE CONTER -->
		    	< element name= "objectType" type="string " />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "publicado "type="date" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "resumo "type="string" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "atualizado "type="date" />		    			    	
		    	<! -- PODE CONTER -->
		    	< element name= "upstreamDuplicates" type="string " minOccurs= "1" maxOccurs= "unbounded " />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "url "type="string" />		    	   			    			    			    			    			    			    			    			    	
		    	<! -- PODE CONTER -->
		    	< element name= "processName" type="string " />		    	   			    			    			    			    			    			    			    			    	
		    	<! -- PODE CONTER -->
		    	< element name= "processId" type="string " />	
		    	<! -- PODE CONTER -->
		    	< element name= "taskName" type="string " />	
		    	<! -- PODE CONTER -->
		    	< element name= "taskId" type="string " />	
		    	<! -- PODE CONTER -->
		    	< element name= "taskText" type="string " />	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType> 
    
    
    <complexType name= "StreamActivity">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
	    		<! -- DEVE CONTER -->
		    	< element name = "actor "type="tns:StreamObject" />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "content "type="string" />
	    		<! -- PODE CONTER -->
		    	< element name = "generator "type="tns:StreamObject" />
	    		<! -- PODE CONTER -->
		    	< element name = "icon "type="tns:StreamMediaLink" />	
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "id "type="string" />		    	
	    		<! -- DEVE CONTER -->
		    	< element name = "object "type="tns:StreamObject" />		    	
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "publicado "type="date" />		    	
	    		<! -- PODE CONTER -->
		    	< element name = "provider "type="tns:StreamObject" />			    	
	    		<! -- PODE CONTER -->
		    	< element name = "target "type="tns:StreamObject" />		    	
		    	<! -- PODE CONTER -->
		    	<element name="title" type="string"/>
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "atualizado "type="date" />		    			    	
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "url "type="string" />
		    	<! -- DEVE CONTER -->
		    	< nome do elemento = "verbo "type="string" />
		    	<! -- PODE CONTER -->
		    	< element name = "respostas "type="tns:StreamObjectColeção" />		    	
	    		<! -- PODE CONTER -->
		    	< element name = "ibmbpmext "type="tns:StreamObject" />		    			    	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>

    <complexType name= "StreamObjectCollection">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
	    		<! -- PODE CONTER -->
		    	< element name = "items "type="tns:StreamObject" minOccurs= "0" maxOccurs= "unbounded " />
		    	<! -- PODE CONTER -->
		    	< element name= "totalItems" type="integer " />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "url "type="string" />		    			    			    			    			    			    			    			    	
		    </sequence>
	    </extension>
	</complexContent>
    </complexType>
    
    <complexType name= "StreamActivityCollection">
	<complexContent>
	    < extensão base="data :Data">
	    	<sequence>
	    		<! -- PODE CONTER -->
		    	< element name = "items "type="tns:StreamActivity" minOccurs= "0 " maxOccurs=" sem limites " />
		    	<! -- PODE CONTER -->
		    	< element name= "totalItems" type="integer " />
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "url "type="string" />		    			    			    			    			    			    			    			    	
		    	<! -- PODE CONTER -->
		    	< nome do elemento = "mais "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>
Exemplo de conteúdo
<soc:FollowedResult 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">

	< followed>
		false
	< /followed>
< /soc:FollowedResult>

Tipo MIME: aplicação / x-javascript

Conteúdo de Resposta de Erro

Informações detalhadas de erro.

O tipo de conteúdo padrão éapplication/json.

Tipo MIME: application / json


SCHEMA
{"descrição": "WLE Error Response", 
   "type": "object",
   "properties":
   {"status": {"type": "string",
         "descrição": "O status da chamada API anterior."
      },
      "exceptionType": {"type": "string",
         "descrição": "O nome de classe associado à exceção."
      },
      "errorNumber": {"type": "string",
         "description": "ID de mensagem da exceção."
      },
      "errorMessage": {"type": "string",
         "description": "Texto da mensagem da exceção."
      },
      "errorMessageParâmetros": {"type": ["string"], "optional": true,
         "descrição": "Parâmetros de texto de mensagem de exceção."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Detalhes de exceção adicionais, por exemplo, um rastreio de pilha."
      }
   }
} 

Tipo MIME: application / xml


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" />
    
    <!--
	Este tipo representa uma resposta de erro.
    -->    
    < element name= "RestRuntimeException">
	<complexType>
	    <sequence>
		< nome do elemento = "status "type="string" />
		< element name="Dados " type="tns:ExceptionData">
    		</element>
	    </sequence>
	</complexType>
    </element>

    <!-- 
	 Este tipo contém informações detalhadas de erro associadas a uma exceção.
    -->
    <complexType name= "ExceptionData">
	<sequence>
	    < nome do elemento = "status "type="string" />

	    <! -- Isto especifica o nome da classe java da exceção -->
	    < element name= "exceptionType" type="string " />

	    <! -- O ID da mensagem da mensagem de erro -->
	    < element name= "errorNumber" type="string " minOccurs= "0" />

	    <! -- A mensagem de erro completa -->
	    < element name= "errorMessage" type="string " />

	    <! -- A lista de strings inseridas na mensagem de erro -->
	    < element name= "errorMessageParâmetros" type="string " minOccurs= "0" maxOccurs= "unbounded " />

	    <!-- 
		 O stacktrace associado à exceção.
		 Note que isso será omitido a menos que a propriedade "server-stacktrace-enabled"
		 é ativado no arquivo 100Custom.xml do servidor
	    -->     
	    < element name= "programmersDetails" type="string"> < /element>
	    
	    <! -- Respostas anteriores.  Configure se um comando a granel foi usado -->
	    < element name = "responses "type="dat:BulkCommandRespostas" minOccurs= "0"> < /element>

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

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

Tipo MIME: aplicação / x-javascript

Códigos de status

O método retorna um dos seguintes códigos de status:
CódigoDescrição
200 OKConclusão de sucesso.
400 Solicitação inválidaOs parâmetros não são válidos ou estão ausentes.
404 Não Localizado
A instância do processo não existe.
406 Not AcceptableO tipo ou a codificação de conteúdo solicitado não é suportado.
500 Erro interno do servidorOcorreu um problema grave, os detalhes do programador são fornecidos.

Disponível desde

8.0.0

Tópico Pai: Instância Seguindo Recurso