Create Use Case
POST
/api/v1/use-cases
Create a use-case.
Args: use_case: The use-case to create. user_session: The auth info used to check permissions.
Returns: QueryResults: The created use-case.
Request Body required
CreateUseCaseSchema
Schema to parse request for the creation of a use-case.
object
project_id
Project Id
string format: uuid
title
required
Title
string
validation_status
required
Validation Status
string
summary
Summary
string
questionnaire_id
Questionnaire Id
integer
answers
Answers
object
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>
BaseModelobject
BaseModel
object
422
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string