Discard an inactive authoring conversation with exact confirmation

curl --request POST \
  --url https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "expectedVersion": 0,
  "confirm": "<string>"
}
'

import requests

url = "https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard"

payload = {
    "expectedVersion": 0,
    "confirm": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expectedVersion: 0, confirm: '<string>'})
};

fetch('https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard', 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.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard",
  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([
    'expectedVersion' => 0,
    'confirm' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard"

	payload := strings.NewReader("{\n  \"expectedVersion\": 0,\n  \"confirm\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedVersion\": 0,\n  \"confirm\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expectedVersion\": 0,\n  \"confirm\": \"<string>\"\n}"

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

{
  "session": {
    "schemaVersion": 1,
    "authoringSessionId": "<string>",
    "organizationId": "<string>",
    "projectId": "<string>",
    "repositoryBindingId": "<string>",
    "createdBy": "<string>",
    "branch": "<string>",
    "baseRevision": "<string>",
    "state": "active",
    "version": 0,
    "createdAtMs": 0,
    "updatedAtMs": 0,
    "activeTurnId": "<string>",
    "currentProposalId": "<string>",
    "closedAtMs": 0
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "source": "platform",
  "retryAfterMs": 123,
  "operationId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "details": {},
  "evidence": {
    "sessionId": "<string>",
    "runId": "<string>",
    "journalSeq": 4503599627370495,
    "buildHash": "<string>"
  }
}

Discard an inactive authoring conversation with exact confirmation

curl --request POST \
  --url https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "expectedVersion": 0,
  "confirm": "<string>"
}
'

import requests

url = "https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard"

payload = {
    "expectedVersion": 0,
    "confirm": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expectedVersion: 0, confirm: '<string>'})
};

fetch('https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard', 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.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard",
  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([
    'expectedVersion' => 0,
    'confirm' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard"

	payload := strings.NewReader("{\n  \"expectedVersion\": 0,\n  \"confirm\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedVersion\": 0,\n  \"confirm\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firedrill.run/v1/projects/{projectId}/authoring-sessions/{authoringSessionId}/discard")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expectedVersion\": 0,\n  \"confirm\": \"<string>\"\n}"

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

{
  "session": {
    "schemaVersion": 1,
    "authoringSessionId": "<string>",
    "organizationId": "<string>",
    "projectId": "<string>",
    "repositoryBindingId": "<string>",
    "createdBy": "<string>",
    "branch": "<string>",
    "baseRevision": "<string>",
    "state": "active",
    "version": 0,
    "createdAtMs": 0,
    "updatedAtMs": 0,
    "activeTurnId": "<string>",
    "currentProposalId": "<string>",
    "closedAtMs": 0
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "source": "platform",
  "retryAfterMs": 123,
  "operationId": "<string>",
  "issues": [
    {
      "path": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "details": {},
  "evidence": {
    "sessionId": "<string>",
    "runId": "<string>",
    "journalSeq": 4503599627370495,
    "buildHash": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Opaque control credential

Headers

Idempotency-Key

string

required

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

projectId

string

required

Pattern: ^prj_[0-9a-z]{12,32}$

authoringSessionId

string

required

Pattern: ^authsess_[0-9a-z]{12,32}$

Body

application/json

expectedVersion

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

confirm

string

required

Pattern: ^authsess_[0-9a-z]{12,32}$

Response

Discard an inactive authoring conversation with exact confirmation

session

object

required

Show child attributes

Overview

Control API

Discard an inactive authoring conversation with exact confirmation

Authorizations

Headers

Path Parameters

Body

Response