Link a ticket to a test case

POST /flaky-tests/link-ticket-to-test-case

Link a ticket to a test case

cURL

curl --request POST \
  --url https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "test_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_ticket_id": "<string>",
  "repo": {
    "host": "<string>",
    "owner": "<string>",
    "name": "<string>"
  }
}
'

import requests

url = "https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case"

payload = {
    "test_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_ticket_id": "<string>",
    "repo": {
        "host": "<string>",
        "owner": "<string>",
        "name": "<string>"
    }
}
headers = {
    "x-api-token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    test_case_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    external_ticket_id: '<string>',
    repo: {host: '<string>', owner: '<string>', name: '<string>'}
  })
};

fetch('https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case', 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://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'test_case_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'external_ticket_id' => '<string>',
    'repo' => [
        'host' => '<string>',
        'owner' => '<string>',
        'name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-token: <api-key>"
  ],
]);

$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://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case"

	payload := strings.NewReader("{\n  \"test_case_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_ticket_id\": \"<string>\",\n  \"repo\": {\n    \"host\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")

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

	req.Header.Add("x-api-token", "<api-key>")
	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.post("https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case")
  .header("x-api-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"test_case_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_ticket_id\": \"<string>\",\n  \"repo\": {\n    \"host\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case")

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

request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"test_case_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_ticket_id\": \"<string>\",\n  \"repo\": {\n    \"host\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

400

"<string>"

"<string>"

"<string>"

"<string>"

Authorizations

x-api-token · string · header · required

Body

application/json

test_case_id · string<uuid> · required

The id of the test case. Should be a UUID.

Example:

"01234567-0123-0123-0123-0123456789ab"

external_ticket_id · string · required

The external identifier of the ticket. For Jira this is the ticket number prefixed by the Project Key. For Linear this is the ticket number prefixed by the Team Identifier

Examples:

"KAN-123"

"TRUNK-1234"

repo · object · required

The repository to list tests for.

Show child attributes

Response

200

application/json

OK