Skip to main content
PATCH
/
v1
/
projects
/
{projectId}
/
test-executions
/
{testExecutionId}
Cancel Test Execution
curl --request PATCH \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "forceUpdate": true,
  "status": "CANCELLED"
}
'
import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId}"

payload = {
"forceUpdate": True,
"status": "CANCELLED"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({forceUpdate: true, status: 'CANCELLED'})
};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'forceUpdate' => true,
'status' => 'CANCELLED'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId}"

payload := strings.NewReader("{\n \"forceUpdate\": true,\n \"status\": \"CANCELLED\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"forceUpdate\": true,\n \"status\": \"CANCELLED\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/test-executions/{testExecutionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"forceUpdate\": true,\n \"status\": \"CANCELLED\"\n}"

response = http.request(request)
puts response.read_body
{
  "testExecutionId": "1398aa31-af57-4a6a-9752-27c2e8556c3f"
}
{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"violations": [
"<string>"
]
}
{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"violations": [
"<string>"
]
}
{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"violations": [
"<string>"
]
}
{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"violations": [
"<string>"
]
}
{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"violations": [
"<string>"
]
}
{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"violations": [
"<string>"
]
}

Authorizations

Authorization
string
header
required

a valid bearer token

Path Parameters

projectId
string
required

The UUID of the test execution's project

testExecutionId
string<uuid>
required

ID of the test execution, as returned when executing a test

Body

application/json
forceUpdate
boolean
required

If true, the execution will be forcefully terminated

status
enum<string>
required

Cancel pipeline execution by updating status to CANCELLED

Available options:
CANCELLED
Example:

"CANCELLED"

Response

Test execution cancelled successfully

testExecutionId
string<uuid>

Server-generated identifier for the cancelled test execution

Example:

"1398aa31-af57-4a6a-9752-27c2e8556c3f"