Skip to main content
DELETE
/
api
/
v2
/
use-case
/
delete
Delete Use Case
curl --request DELETE \
  --url https://app.octavehq.com/api/v2/use-case/delete \
  --header 'api_key: <api-key>'
import requests

url = "https://app.octavehq.com/api/v2/use-case/delete"

headers = {"api_key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/use-case/delete', 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://app.octavehq.com/api/v2/use-case/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"api_key: <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"
"net/http"
"io"
)

func main() {

url := "https://app.octavehq.com/api/v2/use-case/delete"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("api_key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://app.octavehq.com/api/v2/use-case/delete")
.header("api_key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/use-case/delete")

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

request = Net::HTTP::Delete.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "oId": "uc_1234",
  "createdAt": "2021-01-01",
  "user": {
    "oId": "<string>",
    "firstName": "John",
    "lastName": "Doe"
  },
  "workspace": {
    "oId": "<string>"
  },
  "updatedAt": "2021-01-01",
  "deletedAt": "2021-01-01",
  "archivedAt": "2021-01-01",
  "name": "Use Case Name",
  "internalName": "Use Case Internal Name",
  "description": "Use Case Description",
  "primaryUrl": "https://www.use-case.com",
  "active": true,
  "data": {
    "summary": "<string>",
    "scenarios": [
      "<string>"
    ],
    "desiredOutcomes": [
      "<string>"
    ],
    "businessDrivers": [
      "<string>"
    ],
    "strategicImpact": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "scenarios": [
    "<string>"
  ],
  "desiredOutcomes": [
    "<string>"
  ]
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Use Case OId

Response

Deleted use case data

_metadata
object
required
oId
string
required

The ID of the use case

Minimum string length: 1
Example:

"uc_1234"

createdAt
string
required

The date and time the use case was created

Example:

"2021-01-01"

user
object
required
workspace
object
required
updatedAt
string | null

The date and time the use case was updated

Example:

"2021-01-01"

deletedAt
string | null

The date and time the use case was deleted

Example:

"2021-01-01"

archivedAt
string | null

The date and time the use case was archived

Example:

"2021-01-01"

name
string | null

The name of the use case

Example:

"Use Case Name"

internalName
string | null

The internal name of the use case

Example:

"Use Case Internal Name"

description
string | null

The description of the use case

Example:

"Use Case Description"

primaryUrl
string | null

The primary URL of the use case

Example:

"https://www.use-case.com"

active
boolean
default:true

Whether the use case is active and can be used

Example:

true

data
object | null
scenarios
string[] | null

Scenarios

desiredOutcomes
string[] | null

Desired Outcomes