Interface REST pour les ressources liées à BPD-Ressource d'agent UCA-Méthode GET [ obsolète ]

Cette fonction a été dépréciée. Utilisez cette méthode pour extraire les informations détaillées relatives à un agent UCA.

Exemple d'appel de méthode

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

Paramètres

Remarque: Pour identifier l'instantané correct à utiliser, vous devez spécifier l'un des paramètres snapshotId ou branchId .
Les règles de priorité suivantes s'appliquent:
1) Si le paramètre snapshotId est spécifié, cet instantané spécifique est utilisé et le paramètre branchId est ignoré.
2) Si le paramètre branchId est spécifié, l'instantané tip (en cours) de la branche (piste) spécifiée est utilisé.
Paramètres facultatifs
NomType de valeurDescriptif
snapshotId chaîne
Identificateur de l'instantané associé à l'agent UCA. Vous devez définir l'un des paramètres snapshotId ou branchId .
branchId chaîne
Identificateur de la branche associée à l'agent UCA. Vous devez définir l'un des paramètres snapshotId ou branchId .

Contenu de la demande

Aucun

Contenu de la réponse

Informations détaillées relatives à l'agent UCAType complexType.

Le type de contenu par défaut estapplication/json.

Type de MIME : application/json


Schema
{
    "status": "200",
    "données": {
        "ucaId":{"type": "string", "description": "The ID of the undercover agent."},
        "name":{"type": "string", "description": "The name of the undercover agent."},
        "desc":{"type": "string", "description": "The description of the undercover agent."},
        "schedType": { "type": "string", "description": "Type de planification.", 
        	enum ":
        	   [
        		"TimeElapsed",
        		"OnEvent"
        	   ]
        },
        "queue":{"type": "string", "description": "The name of the queue."},
        "enabled":{"type": "boolean"},
        "serviceId":{"type": "string", "description": "The ID of the attached service."},
        "serviceName":{"type": "string", "description": "The name of the attached service."},
	"serviceSnapshotId": { "type": "string", "description": " ID de l'instantané associé au service associé.
		'snapshotId'ou'branchId'doit être spécifié. " },
	"serviceBranchId": { "type": "string", "description": " ID de la branche associée au service associé.
		'snapshotId'ou'branchId'doit être spécifié. " }               
        "eventMessage":{"type": "string", "description": "The event message, which only applies when schedType is 'OnEvent'."},
        "timeSchedule":
	{
	   "type": "object", "description": "Les détails de la planification horaire, qui s'applique uniquement lorsque schedType est'TimeElapsed'." },              
	        {
	            "mois": [{"type": "integer"}],
	            "freqType": { "type": "string", "description": "Type de fréquence.", 
        	        "enum":
	       		   [
		   		"Chaque",
		   		"Premier",
		   		"Dernier"
	       		   ]
                    },
	            "weekDay":
	            [
	            	{ "type": "chaîne",  
        		     "enum":
			        [
					"JOUR",
				        "MARDI",
				        "MERCREDI",
				        "JEUDI",
				        "VENDREDI",
				        "SAMEDI",
				        "DIMANCHE"
				]
                        },
	            ],
	            "hours": [{"type": "integer"}],
	            "minutes": [{"type": "integer"}]
	        }
	}
    }
}
Exemple de contenu
{
    "status": "200",
    "données": {
        "ucaId":"4.1c1e0762-aac8-4759-ab36-2fa06de6aa11",
        "name": "UCA1",
        "desc": "UCA1 description",
        "schedType":"TimeElapsed",
        "queue": "File d'attente asynchrone",
        "enabled" :true,
        "serviceId":"1.254a0925-652c-4e75-a377-3b6528c69fb2",
        "serviceName": "Service système par défaut",
        "serviceSnapshotId": "2064.74f9ea10-a351-4c42-ada5-b3dce7145330",
        "IDserviceBranch" :null,
        "eventMessage" :null,
        "timeSchedule":{
            "mois": [ 1
            ],
            "freqType": "Premier",
            "weekDay": [ "TUESDAY"
            ],
            "heures": [ 3
            ],
            "minutes": [ 5
            ]
        }
    }
}

Type MIME: application / xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
< schema targetNamespace= "http://rest.bpm.ibm.com/v1/data/uca"
	elementFormPar défaut = "unqualified" xmlns= "http://www.w3.org/2001/XMLSchema"
	xmlns:tns = "http://rest.bpm.ibm.com/v1/data/uca" 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" namespace= "http://rest.bpm.ibm.com/v1/data/root" />
	
	<simpleType name= "ScheduleType">
		<restriction base="string">
			< enumeration value= "OnEvent" />
			< enumeration value= "TimeElapsed" />
		</restriction>
	</simpleType>	

	<simpleType name= "EventType">
		<restriction base="string">
			< enumeration value="Message " />
			< enumeration value="Contenu " />
			< enumeration value="Temporisateur " />
		</restriction>
	</simpleType>

	<simpleType name= "TimeScheduleFreqType">
		<restriction base="string">
			< enumeration value="Chaque " />
			< enumeration value="Première " />
			< enumeration value="Dernier " />
		</restriction>
	</simpleType>	

	<complexType name= "TimeSchedule">
		<sequence>
			< element name = "month "type="int" maxOccurs= "unbounded " />
			< element name= "freqType" type="tns:TimeScheduleFreqType" />
			< element name= "weekDay" type="string " maxOccurs= "unbounded" />
			< element name = "hours "type="int" maxOccurs= "unbounded " />
			< element name = "minutes "type="int" maxOccurs= "unbounded " />
		</sequence>
	</complexType>


	<complexType name="UCAType">
		<complexContent>
			< extension base= " pref :Data">
				<sequence>
					< element name= "ucaId" type = "string " />
					< element name = "name "type = "chaîne" />
					< element name = "desc "type = "string" />
					< element name= "richDesc" type = "string " />
					< element name= "schedType" type="tns:ScheduleType" />
					< element name= "eventType" type="tns:EventType" />
					< element name = "queue "type = "chaîne" />
					< element name = "enabled "type =" booléen " />
					< element name= "serviceId" type="string " />
					< element name= "serviceName" type="chaîne " />
					<choice>
						< element name= "IDserviceSnapshot" type="string " />
						< element name= "IDserviceBranch" type="string " />
					</choice>					
					<choice>
						< element name= "eventMessage" type="string " />
						< element name= "timeSchedule" type="tns:TimeSchedule" />
					</choice>
				</sequence>
			</extension>
		</complexContent>
	</complexType>

</schema>

Contenu de la réponse d'erreur

Informations détaillées sur l'erreur.

Le type de contenu par défaut estapplication/json.

Type de MIME : application/json


Schema
{ "description": "Réponse d'erreur WLE", 
   "type":"object",
   "propriétés":
   { "status": { "type": "chaîne",
         "description": "Statut de l'appel API précédent."
      },
      "exceptionType": { "type": "chaîne",
         "description": "Nom de classe associé à l'exception."
      },
      "errorNumber": { "type": "chaîne",
         "description": "ID de message de l'exception."
      },
      "errorMessage": { "type": "string",
         "description": "Texte de message de l'exception."
      },
      "errorMessageParameters": { "type": [ "string" ], "optional": true,
         "description": "Paramètres de texte de message de l'exception."
      },
      "programmersDetails": { "type": "object", "optional": true,
         "description": "Détails de l'exception supplémentaires, par exemple, une trace de pile."
      }
   }
}

Codes d'état

La méthode renvoie l'un des codes de statut suivants:
CoderDescriptif
200 OK
Achèvement réussi-rapport détaillé renvoyé.
400 Demande incorrecteLes paramètres ne sont pas valides ou ils sont manquants.
404 Not Found (Introuvable)La ressource n'existe pas.
406 Not Acceptable (Non acceptable)Le type de contenu ou le codage du contenu demandé n'est pas pris en charge.
500 Erreur de serveur interneUn problème grave s'est produit, les détails du programmeur sont fournis.

Disponible depuis

7.5.1

Rubrique parent: Ressource d'agent UCA



Commentaires