InvokeRESTAPI@0 - Appeler une tâche API REST v0

Utilisez cette tâche pour appeler une API REST dans le cadre de votre pipeline.

# Invoke REST API v0
# Invoke REST API as a part of your process.
- task: InvokeRESTAPI@0
  inputs:
    serviceConnection: # string. Alias: connectedServiceName. Required. Generic endpoint. 
    method: 'POST' # 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'PATCH'. Required. Method. Default: POST.
    #headers: # string. Headers. 
    #body: '{"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}' # string. Optional. Use when method != GET && method != HEAD. Body. Default: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.
    #urlSuffix: # string. Url suffix string. 
  # Completion Options
    waitForCompletion: 'false' # 'true' | 'false'. Required. Complete based on. Default: false.
    #successCriteria: # string. Optional. Use when waitForCompletion = false. Success criteria.

serviceConnection - de point de terminaison générique
Alias d’entrée : connectedServiceName. string. Obligatoire.

Spécifie la connexion de service générique qui fournit les baseURL pour l’appel et l’autorisation à utiliser pour la tâche.

méthode method -
string. Obligatoire. Valeurs autorisées : OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH. Valeur par défaut : POST.

Spécifie la méthode HTTP qui appelle l’API.

headers - en-têtes
string. Valeur par défaut : {\n"Content-Type":"application/json"\n}.

Définit l’en-tête au format JSON. L’en-tête est attaché à la requête envoyée à l’API.

body - corps
string. Optionnel. Utilisez quand method != GET && method != HEAD. Valeur par défaut : {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Spécifie le corps de la requête pour l’appel de fonction au format JSON.

chaîne de suffixe url urlSuffix -
string.

Spécifie la chaîne à ajouter à la baseUrl à partir de la connexion de service générique lors de l’appel HTTP.

Exemple : si l’URL de connexion de service est https:...TestProj/_apis/Release/releases et que le suffixe d’URL est /2/environments/1, l’URL de connexion de service devient https:.../TestProj/_apis/Release/releases/2/environments/1. Si le suffixe d’URL est ?definitionId=1&releaseCount=1, l’URL de connexion de service devient https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1.

waitForCompletion - Terminé en fonction de
string. Obligatoire. Valeurs autorisées : true (rappel), false (ApiResponse). Valeur par défaut : false.

Spécifie la façon dont la tâche signale l’achèvement. Les valeurs autorisées sont les suivantes :

• false - réponse de l’API: signale l’achèvement lorsque la fonction retourne la réussite dans les 20 secondes, et les critères de réussite sont évalués à true.
• true - rappel: l’achèvement des rapports lorsque le service externe effectue un rappel pour mettre à jour l’enregistrement de chronologie.

critères de réussite successCriteria -
string. Optionnel. Utilisez quand waitForCompletion = false.

Spécifie les critères de réussite de la tâche. Le contenu de la réponse n’influence pas le résultat si aucun critère n’est défini. Par défaut, la tâche passe lorsque l’appel retourne 200 OK.

Exemple : Pour la {"status" : "successful"}de réponse, l’expression peut être eq(root['status'], 'successful'). En savoir plus sur spécification de conditions.

Aucun.