Chargement de ressources au moyen de HTTP POST vers le servlet UploadFile uploading-assets-by-way-of-http-posts-to-the-uploadfile-servlet
Le téléchargement de ressources dans Dynamic Media Classic implique une ou plusieurs requêtes de POST HTTP qui configurent une tâche pour coordonner toute l’activité de journal associée aux fichiers transférés.
Utilisez l’URL suivante pour accéder au servlet UploadFile :
https://<server>/scene7/UploadFile
URL d’accès pour les régions Dynamic Media
Processus de la tâche de téléchargement section-873625b9512f477c992f5cdd77267094
La tâche de téléchargement se compose d’une ou plusieurs POST HTTP qui utilisent un traitement commun jobHandle pour corréler le traitement dans la même tâche. Chaque requête est multipart/form-data codée et se compose des éléments de formulaire suivants :
authfile paramsuploadPostParams/fileName spécifié.uploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)companyHandlexsd:stringuploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)jobNamexsd:stringjobName ou jobHandle obligatoire. Nom de la tâche de téléchargement.uploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)jobHandlexsd:stringjobName ou jobHandle obligatoire. Gérez une tâche de chargement commencée dans une demande précédente.uploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)localexsd:stringuploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)descriptionxsd:stringuploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)destFolderxsd:stringuploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)fileNamexsd:stringuploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)endJobxsd:booleanuploadParams (Obligatoire. Document XML uploadParams indiquant les paramètres de transfert)uploadParamstypes:UploadPostJobuploadParams elle est ignorée et les paramètres de téléchargement de la tâche existants sont utilisés. Voir UploadPostJobDans le <uploadPostParams> bloc se trouve le <uploadParams> bloc qui désigne le traitement des fichiers inclus.
Voir UploadPostJob.
Bien que vous puissiez supposer que le paramètre peut changer pour des uploadParams fichiers individuels dans le cadre de la même tâche, ce n’est pas le cas. Utilisez les mêmes uploadParams paramètres pour l’ensemble de la tâche.
La demande de POST initiale pour une nouvelle tâche de téléchargement doit spécifier le jobName paramètre, de préférence en utilisant un nom de tâche unique pour simplifier l’interrogation de l’état de la tâche et les requêtes de journal des tâches. Les demandes de POST supplémentaires pour la même tâche de téléchargement doivent spécifier le jobHandle paramètre au lieu de jobName, en utilisant la jobHandle valeur renvoyée par la demande initiale.
La demande de POST finale pour une tâche de téléchargement doit définir le endJob paramètre sur true afin qu’aucun fichier futur ne soit POSTed pour cette tâche. À son tour, cela permet à la tâche de se terminer immédiatement après l’ingestion de tous les fichiers POSTed. Sinon, la tâche expire si aucune demande de POST supplémentaire n’est reçue dans les 30 minutes.
Réponse UploadPOST section-421df5cc04d44e23a464059aad86d64e
Pour une demande de POST réussie, le corps de la réponse est un document XML uploadPostReturn , comme le spécifie le schéma XSD dans ce qui suit :
<element name="uploadPostReturn">
<complexType>
<sequence>
<element name="jobHandle" type="xsd:string"/>
</sequence>
</complexType>
</element>
Le jobHandle paramètre renvoyé est transmis dans le uploadPostParamsparamètre / jobHandle pour toutes les demandes de POST suivantes pour la même tâche. Vous pouvez également l’utiliser pour interroger l’état de la tâche avec l’opération getActiveJobs ou pour interroger les journaux de travail avec l’opération getJobLogDetails .
Si une erreur se produit lors du traitement de la demande POST, le corps de la réponse se compose de l’un des types de défaillances d’API décrits dans Erreurs.
Exemple POST requête section-810fe32abdb9426ba0fea488dffadd1e
POST /scene7/UploadFile HTTP/1.1
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost
Content-Length: 362630
Content-Type: multipart/form-data; boundary=O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
Content-Disposition: form-data; name="auth"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit
<authHeader xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<user>sampleuser@test.com</user>
<password>*</password>
<locale>en-US</locale>
<appName>MyUploadServletTest</appName>
<appVersion>1.0</appVersion>
<faultHttpStatusCode>200</faultHttpStatusCode>
</authHeader>
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
Content-Disposition: form-data; name="uploadParams"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit
<uploadPostParam xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<companyHandle>c|2101</companyHandle>
<jobName>uploadFileServlet-1376682217351</jobName>
<uploadParams>
<overwrite>true</overwrite>
<readyForPublish>true</readyForPublish>
<preservePublishState>true</preservePublishState>
<createMask>true</createMask>
<preserveCrop>true</preserveCrop>
<manualCropOptions>
<left>500</left>
<right>500</right>
<top>500</top>
<bottom>500</bottom>
</manualCropOptions>
<photoshopOptions>
<process>MaintainLayers</process>
<layerOptions>
<layerNaming>AppendNumber</layerNaming>
<anchor>Northwest</anchor>
<createTemplate>true</createTemplate>
<extractText>true</extractText>
<extendLayers>false</extendLayers>
</layerOptions>
</photoshopOptions>
<emailSetting>None</emailSetting>
</uploadParams>
</uploadPostParam>
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Content-Disposition: form-data; name="file1"; filename="ApiTestCo1/UploadFileServlet1376682217351//1376682217351-1.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
<file bytes ... >
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Content-Disposition: form-data; name="file2"; filename="ApiTestCo1/UploadFileServlet1376682217351//1376682217351-2.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
<file bytes ... >
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Exemple POST réponse - réussite section-0d515ba14c454ed0b5196ac8d1bb156e
HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 204
Date: Mon, 25 Jul 2016 19:43:38 GMT
Server: Unknown
'1.0' encoding='UTF-8'?><uploadPostReturn xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
<jobHandle>j|2101||uploadFileServlet-1376682217351|54091</jobHandle>
</uploadPostReturn>
Exemple POST réponse - error section-efc32bb371554982858b8690b05090ec
HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 210
Date: Mon, 25 Jul 2016 19:43:38 GMT
Server: Unknown
<?xml version='1.0' encoding='UTF-8'?><tns:authenticationFault xmlns:tns="http://www.scene7.com/IpsApi/xsd"><tns:code>10001</tns:code><tns:reason>Invalid username/password</tns:reason></tns:authenticationFault>