unreal.WebAPIOperation

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

Bases: Object

Web APIOperation

C++ Source:

  • Plugin: WebAPI

  • Module: WebAPIEditor

  • File: WebAPIOperation.h

Editor Properties: (see get_editor_property/set_editor_property)

  • description (str): [Read-Write] Describes this operation.

  • errors (Array[WebAPIOperationError]): [Read-Write] Array of errors that can be returned.

  • generate (bool): [Read-Write] Can be disabled to skip generation of this Operation.

  • is_deprecated (bool): [Read-Write] Flags an operation previously available as deprecated.

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

  • path (str): [Read-Write] The operation path, relative to the base url. This can contain named template args.

  • request (WebAPIOperationRequest): [Read-Write] Request model.

  • request_content_types (Array[str]): [Read-Write] List of possible content types for requests, ie. application/json

  • response_content_types (Array[str]): [Read-Write] List of possible content types for responses, ie. application/json

  • responses (Array[WebAPIOperationResponse]): [Read-Write] Array of responses.

  • service (WebAPIService): [Read-Write] Parent service for this operation.

  • verb (str): [Read-Write] The Http verb, ie. Get, Post, etc.