Interfaccia REST per risorse correlate a BPD - Tracking Group Resource - GET Method [ obsoleto]

Questa funzione è obsoleta. Utilizzare questo metodo per recuperare le informazioni dettagliate relative ad un gruppo di traccia.

Richiamo del metodo di esempio

GET /rest/bpm/wle/v1/trackinggroup/{tgId}[?snapshotId={string}][&branchId={string}]

Note di utilizzo

Parametri

Nota: per identificare l'istantanea corretta da utilizzare, è necessario specificare uno dei parametri snapshotId o branchId .
Si applicano le seguenti regole di precedenza:
1) Se viene specificato il parametro snapshotId , viene utilizzata quella specifica istantanea e il parametro branchId viene ignorato.
2) Se viene specificato il parametro branchId , viene utilizzata l'istantanea di suggerimento (corrente) del ramo specificato (traccia).
Parametri facoltativi
NomeTipo valoreDescrizione
snapshotId stringa
L'identificativo dell'istantanea associato al gruppo di traccia. È necessario impostare uno dei parametri snapshotId o branchId .
branchId stringa
L'identificativo del ramo associato al gruppo di traccia. È necessario impostare uno dei parametri snapshotId o branchId .

Contenuto richiesta

Nessuna

Contenuto della risposta

Le informazioni dettagliate relative al gruppo di traccia (TrackingGroupType complexType).

Il tipo di contenuto predefinito èapplication/json.

Tipo MIME: application / json


Schema
{
    "stato": "200",
    "dati": {
        "tgId":{"type": "string", "description": "The ID of the tracking group."},
        "name":{"type": "string", "description": "The name of the tracking group."},
        "abilitato":{"type": "boolean"},
        "desc":{"type": "string", "description": "The description of the tracking group."},
				"externalUniqueID":{"type": "string", "description": "The external unique ID of the tracking group."},                
        "variabili": [ {
                "name":{"type": "string", "description": "The name of the variable."},
                "variableId":{"type": "string", "description": "The ID of the variable."},
                "type": {"type": "string", "description": "Il tipo della variabile.",
                	"enumerazione":
                	[
                		"stringa",
                		"data/ora",
                		"numero"
                	]
                },
				        "externalUniqueID":{"type": "string", "description": "The external unique ID of the variable."},                
                "desc":{"type": "string", "description": "The description of the variable."}
            }
        ]
    }
}
Contenuto di esempio
{
    "stato": "200",
    "dati": {
        "tgId":"14.298c3209-1637-4f1f-a729-ec7529729592",
        "nome": "TG1",
        "abilitato" :true,
        "desc": "Gruppo di traccia test personale",
        "externalUniqueexternalUnique": "P36e567388231",
        "variabili": [ {
                "nome": "nome",
                "variableId":"17.a725c00b-0e5f-40ae-aa5f-d9dfd8eadb55",
                "externalUniqueId": "a40cb77388231",
                "type": "stringa",
                "desc": "nome documentazione"
            },
            {
                "name": "creationDate",
                "variableId":"17.79e1f666-3593-4ff7-860a-c3a9e0bdd553",
                "externalUniqueexternalUnique": "q57dacd6c8231",
                "type": "data/ora",
                "desc": "DocumentazionecreationDate "
            }
        ]
    }
}

Tipo MIME: application / xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/trackinggroup"
	elementFormDefault= "non qualificato" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/trackinggroup" 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= "VariableType">
		< sequenza>
			< nome elemento = "nome" tipo = "stringa " />
			< element name= "variableId" type = "string " />
			< element name= "externalUniqueId" type="stringa " />
			< element name = "type "type="string" />
			< nome elemento = "desc "tipo = "stringa" />
			< nome elemento= "richDesc" type = "string " />
		< /sequenza>
	</complexType>

	<complexType nome= "TrackingGroupTipo">
		<complexContent>
			< estensione base= " pref :Data">
				< sequenza>
					< nome elemento= "tgId" type = "string " />
					< nome elemento = "nome" tipo = "stringa " />
					< nome elemento = "enabled "type =" booleano " />
					< nome elemento = "desc "tipo = "stringa" />
					< nome elemento= "richDesc" type = "string " />
					< element name= "externalUniqueId" type="stringa " />
					< element name = "variables "type="tns:VariableType" maxOccurs= "unbounded " />
				< /sequenza>
			< /estensione>
		</complexContent>
	</complexType>

< /schema>

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:
CodiceDescrizione
200 OK
Completamento riuscito - restituito un report dettagliato.
400 Richiesta non validaI parametri non sono validi o mancano.
404 Non trovatoLa risorsa non esiste.
406 Non accettabileIl tipo di contenuto o la codifica del contenuto richiesti non sono supportati.
Errore interno del server 500Si è verificato un grave problema, vengono forniti i dettagli del programmatore.

Disponibile da

7.5.1

Argomento principale: Risorsa gruppo di traccia



Feedback