unreal.WebAPISchema

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

Bases: Object

Describes the intermediate structure from which to generate code.

C++ Source:

  • Plugin: WebAPI

  • Module: WebAPIEditor

  • File: WebAPISchema.h

Editor Properties: (see get_editor_property/set_editor_property)

  • api_name (str): [Read-Only] Name of the API.

  • base_url (str): [Read-Only] The Url path relative to the host address, ie. “/V1”.

  • date_time_format (str): [Read-Only] The date-time format this API uses to encode/decode from string.

  • host (str): [Read-Only] The default host address to access this API.

  • models (Array[WebAPIModelBase]): [Read-Only] Models can be a combination of classes, structs and enums used by this API.

  • services (Map[str, WebAPIService]): [Read-Only] Each service contains one or more operations.

  • uri_schemes (Array[str]): [Read-Only] Uniform Resource Identifier schemes (ie. https, http).

  • user_agent (str): [Read-Only] The UserAgent to encode in Http request headers.

  • version (str): [Read-Only] The API version can be any arbitrary string that is useful if there are several versions.