Boundaries - Create Cascade Delete Job

Service:: Azure Data Manager for Agriculture

Version d'API:: 2023-06-01-preview

Créez un travail de suppression en cascade pour la limite spécifiée.

PUT /boundaries/cascade-delete/{jobId}?partyId={partyId}&boundaryId={boundaryId}&api-version=2023-06-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
jobId	path	True	string	ID de travail fourni par l’utilisateur final.
api-version	query	True	string	Version de l’API demandée
boundaryId	query	True	string	ID de la limite à supprimer.
partyId	query	True	string	ID de la partie associée.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez essayé des appels non authentifiés avant.

Réponses

Nom	Type	Description
202 Accepted	CascadeDeleteJob	Accepté
Other Status Codes	ErrorResponse	Erreur En-têtes x-ms-error-code: string

Nom

Type

Description

202 Accepted

CascadeDeleteJob

Accepté

Other Status Codes

ErrorResponse

Erreur

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez essayé des appels non authentifiés avant.

Type: apiKey
Dans: header

Exemples

Boundaries_CreateCascadeDeleteJob

Exemple de requête

HTTP

PUT /boundaries/cascade-delete/JOB123?partyId=PARTY123&boundaryId=BOUNDARY123&api-version=2023-06-01-preview

Exemple de réponse

Code d’état:: 202

{
  "id": "JOB123",
  "status": "Succeeded",
  "message": "Job completed successfully.",
  "durationInSeconds": 14.7977857,
  "createdDateTime": "2021-04-19T11:31:20Z",
  "lastActionDateTime": "2021-04-19T11:31:34Z",
  "startTime": "2021-04-19T11:31:19Z",
  "endTime": "2021-04-19T11:31:34Z",
  "partyId": "PARTY123",
  "resourceId": "BOUNDARY123",
  "resourceType": "boundary"
}

Définitions

Nom	Description
CascadeDeleteJob	Schéma du travail de suppression en cascade.
Error	Erreur du service Azure AgPlatform.
ErrorResponse	Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses pour le document de référence ErrorResponse.
InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.
JobStatus	État du travail. Valeurs possibles : « En attente », « En cours d’exécution », « Réussi », « Échec », « Annulé ».

CascadeDeleteJob

Object

Schéma du travail de suppression en cascade.

Nom	Type	Description
createdDateTime	string (date-time)	Tâche créée à dateTime. Exemple de format : aaaa-MM-ddTHH :mm :ssZ.
durationInSeconds	number (double)	Durée du travail en secondes.
endTime	string (date-time)	Heure de fin du travail quand elle est disponible. Exemple de format : aaaa-MM-ddTHH :mm :ssZ.
errorCode	string	Code d’erreur lors de l’échec du travail.
id	string	ID de travail unique.
lastActionDateTime	string (date-time)	Le travail a été agi pour la dernière fois à dateTime. Exemple de format : aaaa-MM-ddTHH :mm :ssZ.
message	string	Message d’état pour capturer plus de détails du travail.
partyId	string minLength: 1	ID de partie.
resourceId	string minLength: 1	ID de la ressource.
resourceType	string minLength: 1	Type de la ressource.
startTime	string (date-time)	Heure de début du travail quand elle est disponible. Exemple de format : aaaa-MM-ddTHH :mm :ssZ.
status	JobStatus	État du travail. Valeurs possibles : « En attente », « En cours d’exécution », « Réussi », « Échec », « Annulé ».

Error

Object

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string minLength: 1	Ensemble défini par le serveur de codes d’erreur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.
message	string minLength: 1	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Object

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses pour le document de référence ErrorResponse.

Nom	Type	Description
error	Error	Erreur du service Azure AgPlatform.
traceId	string	ID de trace unique.

InnerError

Object

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.

Nom	Type	Description
code	string	Code d’erreur spécifique que fourni par l’erreur contenante.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.

JobStatus

Énumération

État du travail. Valeurs possibles : « En attente », « En cours d’exécution », « Réussi », « Échec », « Annulé ».

Valeur	Description
Waiting
Running
Succeeded
Failed
Cancelled