Get My Use Cases

GET

/api/v1/use-cases/project/{project_id}/me

Get the list of use-cases created by the logged user in the given project.

Args: project_id: the project (=team) for which to retrieve use-cases. credential: The auth info used to check permissions. paginated_params: arguments provided by the client to control pagination. status: If provided, return only use-cases having that status search: If provided, return only use-cases containing that term

Returns: QueryResults: The matching use-cases found in DB.

Parameters

Path Parameters

project_id

required

Project Id

string format: uuid

Query Parameters

status

ValidationStatus

An enumeration.

string

Allowed values: DRAFT UNDER_REVIEW REVIEWER_DRAFT REQUIRING_UPDATE UPDATED REJECTED APPROVED

search

Search

string

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

Responses

200

Successful Response

HeaderPaginatedResponse[PreviewUseCaseSchema]

A list of responses with pagination information.

For backwards compatibility, this also exposes pagination using the following header format:

Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE

object

status

string

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

PreviewUseCaseSchema

Schema to display all the information contained in a UseCase

object

user_id

required

User Id

string

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

last_reviewed_at

Last Reviewed At

string format: date-time

id

required

Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

user_name

User Name

string

project_name

Project Name

string

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string