Interface REST pour les ressources liées à BPD-Ressource du service d'intégration avancé-Méthode GET [ obsolète ]

Cette fonction a été dépréciée. Utilisez cette méthode pour extraire le service d'intégration avancé.

Exemple d'appel de méthode

GET /rest/bpm/wle/v1/SCAServiceModel/{serviceId}[?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é au service d'intégration avancé. Vous devez définir l'un des paramètres snapshotId ou branchId .
branchId chaîne
Identificateur de la branche associée au service d'intégration avancé. Vous devez définir l'un des paramètres snapshotId ou branchId .

Contenu de la demande

Aucun

Contenu de la réponse

Détails du service d'intégration avancé.

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

Type de MIME : application/json


Schema
{
    "status": "200",
    "données": {
        "id":{"type": "string", "description": "The ID of the advanced integration service."},
        "name":{"type": "string", "description": "The name of the advanced integration service."},
        "desc":{"type": "string", "description": "The description of the advanced integration service."},
        "poId":{"type": "string", "description": "The persistent object ID of the advanced integration service."},
        "poVersionId":{"type": "string", "description": "The persistent object version ID of the advanced integration service."},
        "élément":
	{
            "exportName": {"type": "string", "description": "The export name."},
            "moduleName": {"type": "string", "description": "The module name."},
            "operationName": {"type": "string", "description": "The operation name."},
            "moduleVersion": {"type": "string", "description": "The module version."},
            "isAsyncInvocation": {"type": "boolean"},
            "guid":{"type": "string"},
            "versionId":{"type": "string"},
        },
        "variables":
	[
            {
                "poId":{"type": "string", "description": "The ID of the parameter type."},
                "poName":{"type": "string", "description": "The name of the parameter type."},
                "snapshotId":"2064.e1d396eb-8e73-4bb6-bd35-a84c6e8527fb",
                "branchId" :null,
                "isList":{"type": "boolean", "description": "Specifies whether this parameter is a list."},
                "type": { "type": "string", "description": "Indique si ce paramètre est une entrée ou une sortie.",
                     enum ":
                	[
                		"entrée",
                		"sortie"
                	]
                },
                "name":{"type": "string", "description": "The name of the parameter."}
            }
        ]
    }
}
Exemple de contenu
{
    "status": "200",
    "données": {
        "name": "AIS",
        "desc": "Documentation AIS",
        "poId":"1.daa71e26-f8ef-4438-9c00-3dcfc2948f28",
        "IDpoVersion": "a2c07628-3e78-4c91-b335-3b1918cdc5ac",
        "id": "1.daa71e26-f8ef-4438-9c00-3dcfc2948f28",
        "élément": {
            "isAsyncInvocation" :false,
            "guid": "guid:4d136293f40cc951:-157548c5:1328766f77f:-7f55",
            "versionId":"7ecc26d0-969f-4a07-9b42-7c5c2482f2f5"
        },
        "variables": [ {
                "poName": "Chaîne",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :true,
                "type": "entrée",
                "name": "input1"
            },
            {
                "poId":"12.f3a52cf9-83c9-4900-9730-1229d8b37b43",
                "poName": "Personne",
                "snapshotId":"2064.e1d396eb-8e73-4bb6-bd35-a84c6e8527fb",
                "branchId" :null,
                "isList" :false,
                "type": "entrée",
                "name": "input2"
            },
            {
                "poName": "Chaîne",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :false,
                "type": "sortie",
                "name": "output1"
            },
            {
                "poName": "Booléen",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :false,
                "type": "privé",
                "name": "isImplemented"
            },
            {
                "poName": "Booléen",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :false,
                "type": "privé",
                "name": "isInSync"
            },
            {
                "poName": "Booléen",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :false,
                "type": "privé",
                "name": "isDeployed"
            },
            {
                "poName": "Booléen",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :false,
                "type": "privé",
                "name": "isProcessCenter"
            },
            {
                "poName": "Booléen",
                "snapshotId" :null,
                "branchId" :null,
                "isList" :false,
                "type": "privé",
                "name": "modifedExecutionSaveState"
            }
        ]
    }
}

Type MIME: application / xml


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

    < 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" />
    < import schemaLocation= "ILOGVisualModel.xsd" namespace= "http://rest.bpm.ibm.com/v1/data/bpd/visual" />
	    
    <complexType name= "SCAConnectorItem">
        <annotation>
        	< documentation> Pour le service < /documentation>
        </annotation>
        <complexContent>
    		< extension base= " pref :Data">
   				<sequence>
			    	< element name= "exportName" type="string " />		
			    	< element name= "moduleName" type="string " />		
			    	< element name= "operationName" type="string " />		
			    	< element name= "isAsyncInvocation" type= "boolean" />		
			    	< element name= "moduleVersion" type="string " />		
			    	< element name = "guid "type="chaîne" />		
			    	< element name= "versionId" type="string " />		
				</sequence>
			</extension>
    	</complexContent>
    </complexType>
    
    <complexType name="AISType">
    	<complexContent>
    		< extension base= " pref :Data">
    			<sequence>
				    <element name="name" type="string"/>
				    < element name = "desc "type="chaîne" />
				    < element name= "richDesc" type="string " />
				    < element name= "poId" type="chaîne " />
				    < element name= "IDpoVersion" type="string " />				    
				    < element name = "id "type="chaîne" />
				    < element name= "serviceType" type="string " />
    				< element name = "item "type="tns:SCAConnectorItem" />
					< element name="variables "type="model :Variable" minOccurs= "0 " maxOccurs= "unbounded" />
    			</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 OKRéussite.
400 Demande incorrecteLes paramètres ne sont pas valides ou ils sont manquants.
401 Non autoriséL'appelant n'est pas autorisé pour cette demande.
404 Not Found (Introuvable)
Le modèle de service 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 du service d'intégration avancé



Commentaires