URL ContractExport
Cette URL exporte un contrat vers un fichier XML.
Le fichier est généré sous le répertoire WC_instance_name/xml/trading.
Structure de l'adresse URL
- http:// host_name/path/
- Nom entièrement qualifié de votre Transaction server et du chemin de configuration.
Valeurs des paramètres
- contractId
- Obligatoire : ID de contrat pour le contrat que vous souhaitez exporter, comme vous le trouvez dans la table de base de données CONTRACT.
- fileName
- Obligatoire : Nom que vous souhaitez que le fichier XML porte. Si vous ne spécifiez pas le nom complet du chemin d'accès pour le fichier XML, le fichier XML sera écrit dans le répertoire WC_eardir/xml/trading/xml.
- langId
- Obligatoire : Utilisez ce paramètre pour spécifier la langue des descriptions dans le contrat que vous souhaitez exporter. Les descriptions dans des langues autres que la langue spécifiée par ce paramètre ne seront pas exportées vers le fichier XML généré.
- xsdName
- Obligatoire : Nom de fichier XSD à utiliser pour l'élément racine.
- xmlFileEncoding
- Utilisez ce paramètre pour spécifier l'encodage du fichier XML généré. Si vous ne spécifiez pas cette option, le fichier XML généré sera codé à l'aide du codage UTF-8. Pour obtenir une liste de tous les codages internationaux pris en charge qui peuvent être spécifiés avec ce paramètre, voir la rubrique associée ci-dessous.
- tout
- Spécifie s'il faut inclure ou non tous les numéros de référence et horodatages lors de l'exportation du contrat. Les valeurs correctes de ce paramètre sont true et false. Utilisez true pour inclure tous les numéros de référence et horodatages. Utiliser false pour omettre tous les numéros de référence et horodatages
En l'absence de spécification de ce paramètre, une valeur true est adoptée.
- URL
- Obligatoire : Adresse URL à appeler une fois que la commande a abouti.
Exemple
L'exemple suivant exporte l'ID de contrat 260369 vers un fichier XML codé UTF-8 dans le répertoire par défaut appelé contract260369.xml :
https://myhostname/webapp/wcs/stores/servlet/ContractExport?
contractId=260369&fileName=contract260369.xml&langId=-1&xsdName=Package.xsd
&URL=StoreCatalogDisplay?storeId=512&catalogId=512
Comportement
Cette URL crée un fichier XML à partir des informations de la base de données HCL Commerce pour le numéro de contrat spécifié.
Conditions d'exception
- _ERR_CONTRACT_OBJECT_NOT_FOUND se déclenchera si un contrat avec l'ID de contrat spécifié n'est pas trouvé dans la base de données HCL Commerce.
- _ERR_UNSUPPORTED_ENCODING sera déclenché si le paramètre xmlFileEncoding spécifié n'est pas pris en charge.
- _ERR_WRONG_CONTRACT_STATE se déclenchera si le contrat est à l'état DeploymentInProgress ou DeploymentFailed.