Valide un fichier dans l'environnement de développement du système d'ordonnancement pour générer une tâche. Cette opération API traite votre requête de manière asynchrone. Appelez l'opération GetDeployment pour vérifier si le fichier a été validé.
Débogage
Paramètres de requête
|
Parameter |
Type |
Required |
Example |
Description |
|
Action |
String |
Yes |
SubmitFile |
Opération à effectuer. Définissez la valeur sur SubmitFile. |
|
ProjectId |
Long |
No |
10000 |
ID de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Work space pour obtenir l'ID de l'espace de travail. Configurez ce paramètre ou le paramètre ProjectIdentifier pour déterminer l'espace de travail DataWorks auquel l'opération s'applique. |
|
ProjectIdentifier |
String |
No |
dw_project |
Nom de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Work space pour obtenir le nom de l'espace de travail. Configurez ce paramètre ou le paramètre ProjectId pour déterminer l'espace de travail DataWorks auquel l'opération s'applique. |
|
FileId |
Long |
Yes |
1000000 |
ID du fichier. Appelez l'opération ListFiles pour interroger l'ID. |
|
Comment |
String |
No |
Commit for the first time |
Description de l'opération de validation. |
|
SkipAllDeployFileExtensions |
Boolean |
No |
false |
Indique s'il faut ignorer la vérification préalable au déploiement après la validation du fichier. Valeurs possibles :
|
Paramètres de réponse
|
Parameter |
Type |
Example |
Description |
|
HttpStatusCode |
Integer |
200 |
Code d'état HTTP. |
|
Data |
Long |
3000001 |
ID du package de déploiement. Cet ID sert de valeur à un paramètre de requête spécifique lorsque vous appelez l'opération GetDeployment pour interroger les détails du package de déploiement. |
|
RequestId |
String |
0000-ABCD-EFG**** |
ID de la requête. |
|
ErrorMessage |
String |
The connection does not exist. |
Message d'erreur. |
|
Success |
Boolean |
true |
Indique si la requête a abouti. |
|
ErrorCode |
String |
Invalid.Tenant.ConnectionNotExists |
Code d'erreur. |
Exemples
Exemple de requête
http(s)://[Endpoint]/?Action=SubmitFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=1000000
&Comment=Commit for the first time
&SkipAllDeployFileExtensions=false
&<Common request parameters>
Exemple de réponse en cas de réussite
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<SubmitFileResponse>
<HttpStatusCode>200</HttpStatusCode>
<Data>3000001</Data>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</SubmitFileResponse>
JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Data" : 3000001,
"RequestId" : "0000-ABCD-EFG****",
"ErrorMessage" : "The connection does not exist.",
"Success" : true,
"ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}
Codes d'erreur
|
HTTP status code |
Error message |
Description |
|
|
403 |
Forbidden.Access |
Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. |
Aucune autorisation. |
|
429 |
Throttling.Api |
The request for this resource has exceeded your available limit. |
Le nombre de requêtes pour la ressource a dépassé la limite supérieure. |
|
429 |
Throttling.System |
The DataWorks system is busy. Try again later. |
Le système DataWorks est occupé. Réessayez ultérieurement. |
|
429 |
Throttling.User |
Your request is too frequent. Try again later. |
Un nombre excessif de requêtes a été soumis sur une courte période. Réessayez ultérieurement. |
|
500 |
InternalError.System |
An internal system error occurred. Try again later. |
Une erreur interne s'est produite. Réessayez ultérieurement. |
|
500 |
InternalError.UserId.Missing |
An internal system error occurred. Try again later. |
Une erreur interne s'est produite. Réessayez ultérieurement. |
Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.