InvokeRESTAPI@0 — wywoływanie zadania interfejsu API REST w wersji 0

To zadanie służy do wywoływania interfejsu API REST w ramach potoku.

# 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 - Ogólny punkt końcowy
Alias wejściowy: connectedServiceName. string. Wymagane.

Określa ogólne połączenie usługi, które zapewnia baseURL wywołanie i autoryzację do użycia dla zadania.

method - Metoda
string. Wymagane. Dozwolone wartości: OPTIONS, , HEADGET, POSTPUTDELETE, TRACE, . PATCH Wartość domyślna: POST.

Określa metodę HTTP, która wywołuje interfejs API.

headers - Nagłówki
string. Wartość domyślna: {\n"Content-Type":"application/json"\n}.

Definiuje nagłówek w formacie JSON. Nagłówek jest dołączony do żądania wysłanego do interfejsu API.

body - Ciała
string. Opcjonalny. Użyj polecenia , gdy method != GET && method != HEAD. Wartość domyślna: {"JobId": "$(system.jobId)", "PlanId": "$(system.planId)", "TimelineId": "$(system.timelineId)", "ProjectId": "$(system.teamProjectId)", "VstsUrl": "$(system.CollectionUri)","AuthToken": "$(system.AccessToken)"}.

Określa treść żądania dla wywołania funkcji w formacie JSON.

urlSuffix - Ciąg sufiksu adresu URL
string.

Określa parametry, które mają zostać dołączone do elementu baseUrl z ogólnego połączenia usługi podczas wykonywania wywołania HTTP.

Przykład: Jeśli adres URL połączenia usługi to https:...TestProj/_apis/Release/releases , a sufiks adresu URL to /2/environments/1, adres URL połączenia z usługą staje się adresem https:.../TestProj/_apis/Release/releases/2/environments/1. Jeśli sufiks adresu URL to ?definitionId=1&releaseCount=1, adres URL połączenia z usługą zostanie wyświetlony https//...TestProj/_apis/Release/releases?definitionId=1&releaseCount=1jako .

waitForCompletion - Ukończono na podstawie
string. Wymagane. Dozwolone wartości: true (Wywołanie zwrotne), false (ApiResponse). Wartość domyślna: false.

Określa sposób uzupełniania zadań. Dozwolone wartości to:

• false - Odpowiedź interfejsu API: zgłasza ukończenie, gdy funkcja zwraca powodzenie w ciągu 20 sekund, a kryteria powodzenia są obliczane na wartość true.
• true - Wywołanie zwrotne: zgłasza ukończenie, gdy usługa zewnętrzna wykonuje wywołanie zwrotne w celu zaktualizowania rekordu osi czasu.

successCriteria - Kryteria powodzenia
string. Opcjonalny. Użyj polecenia , gdy waitForCompletion = false.

Określa kryteria zadania dla powodzenia. Zawartość odpowiedzi nie ma wpływu na wynik, jeśli nie zdefiniowano żadnych kryteriów. Domyślnie zadanie jest uruchamiane, gdy wywołanie zwraca 200 OKwartość .

Przykład: W przypadku odpowiedzi {"status" : "successful"}wyrażenie może mieć wartość eq(root['status'], 'successful'). Dowiedz się więcej o określaniu warunków.

Brak.