Interfaccia REST per risorse correlate a BPD - Risorsa elenco rami progetto - Metodo GET [ obsoleto]

Questa funzione è obsoleta. Utilizzare questo metodo per elencare i rami in un progetto.

Richiamo del metodo di esempio

GET /rest/bpm/wle/v1/project/{projectId}/branches

Parametri

Nessuna

Contenuto richiesta

Nessuna

Contenuto della risposta

L'elenco dei rami nel progetto.

Il tipo di contenuto predefinito èapplication/json.

Tipo MIME: application / json

Schema

{
    "stato": "200",
    "dati":
    {
    	"rami":
    	[
    	   {
    	       "branchId":{"type": "string", "description": "The ID of the branch."},
               "name":{"type": "string", "description": "The name of the branch."},
          }
       ]
   }
}

Contenuto di esempio

{
	"stato": "200",
	"dati": {
			"rami": [
				{
					"branchId":"2063.6203723f-cc8e-4351-953b-9cbb3cd8432b",
					"nome": "Principale"
				},
				{
					"branchId":"2063.9d9fa202-8cce-4a77-937a-ae26c4fbb46e",
					"name": "Traccia alt1"
				},
				{
					"branchId":"2063.1d269f2a-dcc5-4bec-ad70-2a469384e126",
					"name": "Traccia alt2"
				}
			]
		}
}

Tipo MIME: application / xml

Schema

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

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

    <complexType name= "SnapshotType">
		<complexContent>
		    < estensione base= " pref :Data">
				< sequenza>
				    < nome elemento= "snapshotId" type="string " />
				    < nome elemento = "num_seq "type="decimal" />
				    < element name = "name "type="string" />
				    < element name = "desc "type="string" />
				    < nome elemento= "richDesc" type="string " />
				    < element name="createdBy_userId"type="long" />
				    < element name="createdBy_userName"type="string" />
				    < nome elemento = "created_on "type="long" />
				< /sequenza>
		    < /estensione>
		</complexContent>
    </complexType>
    
    <complexType name= "tBranchSnapshots">
		<complexContent>
		    < estensione base= " pref :Data">
				< sequenza>
				    < nome elemento= "branchId" type="string " />
				    < element name = "name "type="string" />
				    < element name = "snapshots "type="tns:SnapshotType" maxOccurs= "unbounded " />
				< /sequenza>
		    < /estensione>
		</complexContent>
    </complexType>
    
    <complexType name= "tProjectSnapshots">
		<complexContent>
		    < estensione base= " pref :Data">
				< sequenza>
				    < element name = "branch" type="tns:tBranchSnapshots " maxOccurs= "unbounded" />
				< /sequenza>
		    < /estensione>
		</complexContent>
    </complexType>
    
    <complexType nome= "tBranch">
		<complexContent>
		    < estensione base= " pref :Data">
				< sequenza>
				    < nome elemento= "branchId" type="string " />
				    < element name = "name "type="string" />
				< /sequenza>
		    < /estensione>
		</complexContent>
    </complexType>
          
    
    <complexType name= "tProjectBranches">
		<complexContent>
		    < estensione base= " pref :Data">
				< sequenza>
				    < element name = "branch" type="tns:tBranch" maxOccurs= "unbounded" />
				< /sequenza>
		    < /estensione>
		</complexContent>
    </complexType>
            
	<complexType name="POHistory">
        < annotazione>
        	L'attributo < documentation>poName verrà impostato sull'ultimo in tutte le modifiche. < /documentazione>
        < /annotazione>
		<complexContent>
		    < estensione base="pref:NamedElement">        
		        < sequenza>
					< nome elemento= "poId" type = "string " />
					< element name= "poSubType" type="string " />
					< nome elemento= "iconType" type="int " />
					< element name = "changes "type="tns:ChangeItem"
						maxOccurs= "unbounded " />
				< /sequenza>
		    < /estensione>
		</complexContent>		
	</complexType>

	<complexType nome= "ChangeItem">
        < annotazione>
        	< documentation>branchId verrà impostato solo quando si confrontano due rami. poName verrà impostato se non è uguale all'ultimo. < /documentation>
        < /annotazione>
		<complexContent>
		    < estensione base="pref:NamedElement">        
		        < sequenza>
				    < nome elemento = "modified_on "type="long" />
				    < element name= "userName" type="string " />
				    < element name= "actionType" type="string " />		
				< /sequenza>
				< attribute name= "branchId" type = "string "use = "facoltativo" />
				< attribute name= "branchName" type = "string "use = "facoltativo" />
				< attribute name= "branchAcronym" type = "string "use = "facoltativo" />
		    < /estensione>
		</complexContent>		
    </complexType>     
    
    <complexType name= "tSnapshotDelta">
		<complexContent>
		    < estensione base= " pref :Data">
				< sequenza>
				    < element name= "snapshotIds" type="string " maxOccurs= "2" minOccurs= "1 " />
				    < element name= "baseSnapshotId" type="string " />
				    < element name="histories "type="cmn :Map" />				    
				< /sequenza>
		    < /estensione>
		</complexContent>
    </complexType>           
                
< /schema>

Contenuto di esempio

< ?xml version= "1.0" encoding= "UTF-8" standalone="yes " ?>
< bpm:ResponseData xmlns:bpm = "http://rest.bpm.ibm.com/v1/data"
	xmlns:ex = "http://rest.bpm.ibm.com/v1/data/exception">
	<status>200</status>
	< data xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
		xmlns:snap = "http://rest.bpm.ibm.com/v1/data/snapshot" xsi:type = "snap:tProjectBranches">
		< diramazioni>
			<branchId>2063.6203723f-cc8e-4351-953b-9cbb3cd8432b</branchId>
			< nome> Principale < /nome>
		< /branches>
		< diramazioni>
			<branchId>2063.9d9fa202-8cce-4a77-937a-ae26c4fbb46e</branchId>
			< name> Traccia alt1</name>
		< /branches>
		< diramazioni>
			<branchId>2063.1d269f2a-dcc5-4bec-ad70-2a469384e126</branchId>
			< name> Traccia alt2</name>
		< /branches>
	< /dati>
< /bpm:ResponseData>

Contenuto risposta errore

Informazioni dettagliate sull'errore.

Il tipo di contenuto predefinito èapplication/json.

Tipo MIME: application / json

Schema

{"description": "Risposta errore WLE", 
   "type": "oggetto",
   "proprietà":
   {"stato": {"tipo": "stringa",
         "description": "Lo stato della chiamata API precedente."
      },
      "exceptionType": {"tipo": "stringa",
         "description": "Il nome classe associato all'eccezione."
      },
      "errorNumber": {"tipo": "stringa",
         "description": "ID messaggio dell'eccezione."
      },
      "errorMessage": {"tipo": "stringa",
         "description": "Testo del messaggio dell'eccezione."
      },
      "errorMessageParametri": {"type": [ "string"], "optional": true,
         "description": "Parametri di testo del messaggio dell'eccezione."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Ulteriori dettagli dell'eccezione, ad esempio, una traccia di stack."
      }
   }
}

Codici di stato

Il metodo restituisce uno dei seguenti codici di stato:

Codice	Descrizione
200 OK	Completamento riuscito.
400 Richiesta non valida	I parametri non sono validi o mancano.
401 Non autorizzato	Il chiamante non è autorizzato per questa richiesta.
406 Non accettabile	Il tipo di contenuto o la codifica del contenuto richiesti non sono supportati.
Errore interno del server 500	Si è verificato un grave problema, vengono forniti i dettagli del programmatore.

Disponibile da

8.0.0

Argomento principale: Risorsa elenco rami progetto