Création d'une requête
Ajoutez une nouvelle requête et, le cas échéant, commencez son traitement.
Un processus est uniquement démarré si les paramètres ACTION et FLOW sont complétés.
POST /connectr/api/units/{unité}/requests
Exemple d'URL de requête http://connectr.exemple.org:8080/connectr/api/units/4.1/requests
Paramètre de template | Valeur | Description |
---|---|---|
unité (obligatoire) | Chaîne | Code d'unité défini dans les paramètres Publish store. |
Entité de requête | Type de contenu | Description |
---|---|---|
Requête XML | Chaîne | Requête de génération XML. Reportez-vous à l'annexe « Schéma XML pour une requête de génération » pour voir le format. |
Code de statut de réponse | Type de contenu | Description |
---|---|---|
200 OK | application/xml | Requête créée avec succès. Voir ci-dessous pour le format. |
400 Bad request | text/plain | La syntaxe XML est incorrecte, les champs METADATA sont peut-être incorrects ou le fichier n'a pas pu être enregistré. L'entité de réponse propose plus de détails. |
404 Not found | text/plain | Unité introuvable. |
Format de la réponse
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0">
<xs:element name="RequestInfo" type="RequestInfoResponse"/>
<xs:complexType name="RequestInfoResponse">
<xs:sequence>
<xs:element name="ext" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:any processContents="lax" namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="requestGuid" type="xs:string"/>
<xs:element name="processStarted" type="xs:boolean"/>
<xs:element name="creationDate" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
Exemple
Supposons que nous envoyons le corps de requête suivant :
<LETTERGEN>
<METADATA>
<REQID>Test_Template_7.3</REQID>
<GUID/>
<!-- Following fields are necessary for ConnectR. -->
<STAGE>4</STAGE>
<UNIT>4.1</UNIT>
<FLOW>PDF</FLOW>
<MODEL>Template_7.3_3.3.0</MODEL>
<LANGUAGE>en-US</LANGUAGE>
<ACTION>GENERATE</ACTION>
<DESCRIPTION>Test_Template_7.3</DESCRIPTION>
<!-- Must be true for a package generation. -->
<ISPACKAGE>true</ISPACKAGE>
<ISBATCH>false</ISBATCH>
</METADATA>
<DATA>
<Connective>
<L_Datablock_A>
<Repeating_DB_A>Repeat 1</Repeating_DB_A>
<Repeating_DB_A>Repeat 2</Repeating_DB_A>
<Repeating_DB_A>Repeat 3</Repeating_DB_A>
</L_Datablock_A>
<Datablock_B>
<StringField>StringField</StringField>
<DateTimeField>2001-12-31T12:00:00</DateTimeField>
<DateField>2014-10-01</DateField>
<NumberField1>0.0</NumberField1>
<NumberField2>0.0</NumberField2>
<NumberField3>0.0</NumberField3>
<NumberField4>0.0</NumberField4>
<BooleanField1>1</BooleanField1>
<BooleanField2>true</BooleanField2>
<IntegerField>0</IntegerField>
<DoubleField>0.0</DoubleField>
</Datablock_B>
</Connective>
</DATA>
</LETTERGEN>
Voici un exemple possible de réponse si le statut de réponse est « 200 OK » :
<RequestInfo>
<ext/>
<requestGuid>5037a3b5-7ec5-4281-89a7-1b352c9bfb95</requestGuid>
<processStarted>true</processStarted>
<creationDate>2015-10-22T14:21:40.495Z</creationDate>
</RequestInfo>