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>'
{
  "_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>"
    ],
    "businessImpact": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "scenarios": [
    "<string>"
  ],
  "desiredOutcomes": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
scenarios
string[] | null

Scenarios

​
desiredOutcomes
string[] | null

Desired Outcomes