UseCaseCreateRequest

Request wrapper for UseCaseCreate with validation and JSON:API support. Combines the UseCaseCreate data model with client request functionality, providing automatic validation and JSON:API format conversion for API requests.

Fields

Field	Type	Required	Default	Description
name	str	✓	PydanticUndefined	-
description	ForwardRef('Optional[str]')	✗	``	Example: ''
questionnaire_ids	ForwardRef('Optional[List[str]]')	✗	None	-
custom_fields	ForwardRef("Optional['List[UseCaseCustomField]']")	✗	None	-
questions	ForwardRef("Optional['List[QuestionEvidenceCreate]']")	✗	None	-
source	ForwardRef('Optional[Any]')	✗	None	-
user	ForwardRef('Optional[str]')	✗	``	Example: ''
owner	ForwardRef('Optional[Any]')	✗	None	-

Usage Example

from credoai.models import UseCaseCreateRequest

# Create a new instance
model = UseCaseCreateRequest(
    name="example_value",  # Required field
)

# Convert to dictionary
model_dict = model.model_dump()
print(model_dict)

# Create from dictionary
data = {
    "name": "example_value",
}
model_from_dict = UseCaseCreateRequest(**data)

JSON Schema

{
  "type": "object",
  "title": "UseCaseCreateRequest",
  "description": "Request wrapper for UseCaseCreate with validation and JSON:API support.
Combines the UseCaseCreate data model with client request functionality,
providing automatic validation and JSON:API format conversion for API requests.",
  "properties": {
    "name": {
      "type": "str"
    },
    "description": {
      "type": "forwardref('optional[str]')",
      "description": "Example: ''"
    },
    "questionnaire_ids": {
      "type": "forwardref('optional[list[str]]')"
    },
    "custom_fields": {
      "type": "forwardref("optional['list[usecasecustomfield]']")"
    },
    "questions": {
      "type": "forwardref("optional['list[questionevidencecreate]']")"
    },
    "source": {
      "type": "forwardref('optional[any]')"
    },
    "user": {
      "type": "forwardref('optional[str]')",
      "description": "Example: ''"
    },
    "owner": {
      "type": "forwardref('optional[any]')"
    }
  },
  "required": ["name", ]
}