sdk.lusid.api.schemas_api.SchemasApi
- class SchemasApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
[EARLY ACCESS] GetEntitySchema: Get schema # noqa: E501
[EARLY ACCESS] GetEntitySchema: Get schema # noqa: E501
[EARLY ACCESS] GetPropertySchema: Get property schema # noqa: E501
[EARLY ACCESS] GetPropertySchema: Get property schema # noqa: E501
[EARLY ACCESS] GetValueTypes: Get value types # noqa: E501
[EARLY ACCESS] GetValueTypes: Get value types # noqa: E501
[EARLY ACCESS] ListEntities: List entities # noqa: E501
[EARLY ACCESS] ListEntities: List entities # noqa: E501
- get_entity_schema(entity, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetEntitySchema: Get schema # noqa: E501
Gets the schema and meta-data for a given entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_entity_schema(entity, async_req=True) >>> result = thread.get()
- Parameters:
entity (str) – The name of a valid entity (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_entity_schema_with_http_info(entity, **kwargs)[source]
[EARLY ACCESS] GetEntitySchema: Get schema # noqa: E501
Gets the schema and meta-data for a given entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_entity_schema_with_http_info(entity, async_req=True) >>> result = thread.get()
- Parameters:
entity (str) – The name of a valid entity (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ModelSchema, status_code(int), headers(HTTPHeaderDict))
- get_property_schema(property_keys=None, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetPropertySchema: Get property schema # noqa: E501
Get the schemas for the provided list of property keys. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_property_schema(property_keys, as_at, async_req=True) >>> result = thread.get()
- Parameters:
property_keys (List[str]) – One or more property keys for which the schema is requested
as_at (datetime) – Optional. The AsAt date of the data
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_property_schema_with_http_info(property_keys=None, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetPropertySchema: Get property schema # noqa: E501
Get the schemas for the provided list of property keys. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_property_schema_with_http_info(property_keys, as_at, async_req=True) >>> result = thread.get()
- Parameters:
property_keys (List[str]) – One or more property keys for which the schema is requested
as_at (datetime) – Optional. The AsAt date of the data
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(PropertySchema, status_code(int), headers(HTTPHeaderDict))
- get_value_types(sort_by=None, limit=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetValueTypes: Get value types # noqa: E501
Gets the available value types for which a schema is available. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_value_types(sort_by, limit, async_req=True) >>> result = thread.get()
- Parameters:
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_value_types_with_http_info(sort_by=None, limit=None, **kwargs)[source]
[EARLY ACCESS] GetValueTypes: Get value types # noqa: E501
Gets the available value types for which a schema is available. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_value_types_with_http_info(sort_by, limit, async_req=True) >>> result = thread.get()
- Parameters:
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfValueType, status_code(int), headers(HTTPHeaderDict))
- list_entities(async_req=None, **kwargs)[source]
[EARLY ACCESS] ListEntities: List entities # noqa: E501
List all available entities for which schema information is available. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_entities(async_req=True) >>> result = thread.get()
- Parameters:
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_entities_with_http_info(**kwargs)[source]
[EARLY ACCESS] ListEntities: List entities # noqa: E501
List all available entities for which schema information is available. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_entities_with_http_info(async_req=True) >>> result = thread.get()
- Parameters:
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfString, status_code(int), headers(HTTPHeaderDict))