sdk.lusid.api.application_metadata_api.ApplicationMetadataApi
- class ApplicationMetadataApi(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
GetExcelAddin: Download Excel Addin # noqa: E501
GetExcelAddin: Download Excel Addin # noqa: E501
GetLusidVersions: Get LUSID versions # noqa: E501
GetLusidVersions: Get LUSID versions # noqa: E501
ListAccessControlledResources: Get resources available for access control # noqa: E501
ListAccessControlledResources: Get resources available for access control # noqa: E501
- get_excel_addin(version=None, async_req=None, **kwargs)[source]
GetExcelAddin: Download Excel Addin # noqa: E501
Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned # 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_excel_addin(version, async_req=True) >>> result = thread.get()
- Parameters:
version (str) – The requested version of the Excel plugin
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_excel_addin_with_http_info(version=None, **kwargs)[source]
GetExcelAddin: Download Excel Addin # noqa: E501
Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned # 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_excel_addin_with_http_info(version, async_req=True) >>> result = thread.get()
- Parameters:
version (str) – The requested version of the Excel plugin
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(FileResponse, status_code(int), headers(HTTPHeaderDict))
- get_lusid_versions(async_req=None, **kwargs)[source]
GetLusidVersions: Get LUSID versions # noqa: E501
Get the semantic versions associated with LUSID and its ecosystem # 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_lusid_versions(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:
- get_lusid_versions_with_http_info(**kwargs)[source]
GetLusidVersions: Get LUSID versions # noqa: E501
Get the semantic versions associated with LUSID and its ecosystem # 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_lusid_versions_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(VersionSummaryDto, status_code(int), headers(HTTPHeaderDict))
- list_access_controlled_resources(filter=None, async_req=None, **kwargs)[source]
ListAccessControlledResources: Get resources available for access control # noqa: E501
Get the comprehensive set of resources that are available for access control # 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_access_controlled_resources(filter, async_req=True) >>> result = thread.get()
- Parameters:
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Application, use “application eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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_access_controlled_resources_with_http_info(filter=None, **kwargs)[source]
ListAccessControlledResources: Get resources available for access control # noqa: E501
Get the comprehensive set of resources that are available for access control # 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_access_controlled_resources_with_http_info(filter, async_req=True) >>> result = thread.get()
- Parameters:
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Application, use “application eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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(ResourceListOfAccessControlledResource, status_code(int), headers(HTTPHeaderDict))