Get Team Use Cases

GET

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

curl --request GET \
  --url 'https://example.com/api/v1/use-cases/project/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Parameters

Path Parameters

project_id

required

Project Id

string format: uuid

Query Parameters

status

Any of:

Array<string>

Array<string>

Allowed values: DRAFT UNDER_REVIEW REVIEWER_DRAFT REQUIRING_UPDATE UPDATED REJECTED APPROVED

null

null

search

Any of:

string

string

null

null

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

0

Responses

200

Successful Response

Media typeapplication/json

HeaderPaginatedResponse[PreviewUseCaseSchema]

object

status

JSendStatus

string

default: success

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

PreviewUseCaseSchema

Same as FullUseCaseSchema but without the (potentially large) answers.

object

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_id

required

User Id

string

project_id

Any of:

string

string format: uuid

null

null

title

required

Title

string

validation_status

required

Validation Status

string

summary

Any of:

string

string

null

null

questionnaire_id

Any of:

integer

integer

null

null

last_reviewed_at

Any of:

string

string format: date-time

null

null

user_name

Any of:

string

string

null

null

project_name

Any of:

string

string

null

null

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

Example

{
  "status": "success",
  "message": "OK.",
  "code": "200"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}