Skip to content
Pasqal Documentation

Get Use Case By Id

GET
/api/v1/use-cases/{use_case_id}

Get all the data of the requested use-case, including answers.

Args: user_session: The auth info used to check permissions.

Returns: QueryResults: The matching use-case, if found in DB and allowed for user.

Parameters

Path Parameters

use_case_id
required
Use Case Id
string format: uuid

Responses

200

Successful Response

NonPaginatedResponse

Represents a response with either a list of items or a single item in a single page.

Generic Parameters: - A (TypeVar): The type bound to this class, which can be a single BaseModel, a list of BaseModels, or None.

Usage: - To respond with an unpaginated list of FooResponse items from an API endpoint, ensure that your function returns NonPaginatedResponse[List[FooResponse]].

- To respond with a single `FooResponse` item from an API endpoint,
  make sure that your function returns `NonPaginatedResponse[FooResponse]`
  and that Python recognizes it.
object
data
Any of:
Array<object>
BaseModel
object

422

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string