unreal.WebAPIOperationRequest

class unreal.WebAPIOperationRequest(outer: Object | None = None, name: Name | str = 'None')

Bases: WebAPIModel

Web APIOperation Request

C++ Source:

  • Plugin: WebAPI

  • Module: WebAPIEditor

  • File: WebAPIOperation.h

Editor Properties: (see get_editor_property/set_editor_property)

  • default_value (str): [Read-Write] Default value (optional) as a string.

  • description (str): [Read-Only] Describes this model.

  • generate (bool): [Read-Only] Will be set based on dependent operations.

  • is_read_only (bool): [Read-Only] By default all properties are read & write.

  • is_required (bool): [Read-Only] By default all properties are optional.

  • maximum_value (double): [Read-Only] Maximum value. Can also indicate maximum string length.

  • minimum_value (double): [Read-Only] Minimum value. Can also indicate minimum string length.

  • name (WebAPITypeNameVariant): [Read-Write] Name of the Model.

  • parameters (Array[WebAPIOperationParameter]): [Read-Write] Array of parameters contained in this request.

  • pattern (str): [Read-Only] Regex Pattern to validate against.

  • properties (Array[WebAPIProperty]): [Read-Write] Array of properties contained in this model.

  • type (WebAPITypeNameVariant): [Read-Write] The corresponding TypeInfo for this Model.

  • use_maximum_value (bool): [Read-Only] Whether to use Maximum value.

  • use_minimum_value (bool): [Read-Only] Whether to use Minimum value.

  • use_pattern (bool): [Read-Only] Whether to use a Regex Pattern for validation.