sdk.lusid.api.reference_lists_api.ReferenceListsApi
- class ReferenceListsApi(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] DeleteReferenceList: Delete Reference List # noqa: E501
[EARLY ACCESS] DeleteReferenceList: Delete Reference List # noqa: E501
[EARLY ACCESS] GetReferenceList: Get Reference List # noqa: E501
[EARLY ACCESS] GetReferenceList: Get Reference List # noqa: E501
[EARLY ACCESS] ListReferenceLists: List Reference Lists # noqa: E501
[EARLY ACCESS] ListReferenceLists: List Reference Lists # noqa: E501
[EARLY ACCESS] UpsertReferenceList: Upsert Reference List # noqa: E501
[EARLY ACCESS] UpsertReferenceList: Upsert Reference List # noqa: E501
- delete_reference_list(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteReferenceList: Delete Reference List # noqa: E501
Delete a Reference List instance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reference_list(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the Reference List belongs. (required)
code (str) – The Reference List’s unique identifier. (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:
- delete_reference_list_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteReferenceList: Delete Reference List # noqa: E501
Delete a Reference List instance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_reference_list_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the Reference List belongs. (required)
code (str) – The Reference List’s unique identifier. (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- get_reference_list(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetReferenceList: Get Reference List # noqa: E501
Retrieve a Reference List instance at a point in AsAt time. # 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_reference_list(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the Reference List belongs. (required)
code (str) – The Reference List’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified.
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_reference_list_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetReferenceList: Get Reference List # noqa: E501
Retrieve a Reference List instance at a point in AsAt time. # 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_reference_list_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the Reference List belongs. (required)
code (str) – The Reference List’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified.
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(ReferenceListResponse, status_code(int), headers(HTTPHeaderDict))
- list_reference_lists(as_at=None, page=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListReferenceLists: List Reference Lists # noqa: E501
List all the Reference Lists matching particular criteria. # 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_reference_lists(as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified.
page (str) – The pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists. This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. 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_reference_lists_with_http_info(as_at=None, page=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] ListReferenceLists: List Reference Lists # noqa: E501
List all the Reference Lists matching particular criteria. # 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_reference_lists_with_http_info(as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified.
page (str) – The pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists. This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. 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(PagedResourceListOfReferenceListResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_reference_list(reference_list_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertReferenceList: Upsert Reference List # noqa: E501
Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_reference_list(reference_list_request, async_req=True) >>> result = thread.get()
- Parameters:
reference_list_request (ReferenceListRequest) – The payload describing the Reference List instance.
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:
- upsert_reference_list_with_http_info(reference_list_request=None, **kwargs)[source]
[EARLY ACCESS] UpsertReferenceList: Upsert Reference List # noqa: E501
Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_reference_list_with_http_info(reference_list_request, async_req=True) >>> result = thread.get()
- Parameters:
reference_list_request (ReferenceListRequest) – The payload describing the Reference List instance.
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(ReferenceListResponse, status_code(int), headers(HTTPHeaderDict))