Skip to main content
GET
Get Use Case

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Use Case OId

Response

Use Case data

_metadata
object
required
oId
string
required

The ID of the use case

Minimum string length: 1
Example:

"uc_1234"

createdAt
string<date-time>
required

The date and time the use case was created

Example:

"2021-01-01"

user
object
required
workspace
object
required
updatedAt
string<date-time> | null

The date and time the use case was updated

Example:

"2021-01-01"

deletedAt
string<date-time> | null

The date and time the use case was deleted

Example:

"2021-01-01"

archivedAt
string<date-time> | 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