sdk.lusid.api.participations_api.ParticipationsApi
- class ParticipationsApi(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] DeleteParticipation: Delete participation # noqa: E501
[EARLY ACCESS] DeleteParticipation: Delete participation # noqa: E501
[EARLY ACCESS] GetParticipation: Get Participation # noqa: E501
[EARLY ACCESS] GetParticipation: Get Participation # noqa: E501
[EARLY ACCESS] ListParticipations: List Participations # noqa: E501
[EARLY ACCESS] ListParticipations: List Participations # noqa: E501
[EARLY ACCESS] UpsertParticipations: Upsert Participation # noqa: E501
[EARLY ACCESS] UpsertParticipations: Upsert Participation # noqa: E501
- delete_participation(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteParticipation: Delete participation # noqa: E501
Delete an participation. Deletion will be valid from the participation’s creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. # 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_participation(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The participation scope. (required)
code (str) – The participation’s code. This, together with the scope uniquely identifies the participation to delete. (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_participation_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteParticipation: Delete participation # noqa: E501
Delete an participation. Deletion will be valid from the participation’s creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. # 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_participation_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The participation scope. (required)
code (str) – The participation’s code. This, together with the scope uniquely identifies the participation to delete. (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_participation(scope, code, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetParticipation: Get Participation # noqa: E501
Fetch a Participation that matches the specified identifier # 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_participation(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the participation belongs. (required)
code (str) – The participation’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
property_keys (List[str]) – A list of property keys from the “Participation” domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. “Participation/system/Name”.
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_participation_with_http_info(scope, code, as_at=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] GetParticipation: Get Participation # noqa: E501
Fetch a Participation that matches the specified identifier # 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_participation_with_http_info(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the participation belongs. (required)
code (str) – The participation’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
property_keys (List[str]) – A list of property keys from the “Participation” domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. “Participation/system/Name”.
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(Participation, status_code(int), headers(HTTPHeaderDict))
- list_participations(as_at=None, page=None, sort_by=None, limit=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListParticipations: List Participations # noqa: E501
Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). # 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_participations(as_at, page, sort_by, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
page (str) – The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Participation” domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. “Participation/system/Name”.
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_participations_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] ListParticipations: List Participations # noqa: E501
Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). # 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_participations_with_http_info(as_at, page, sort_by, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified.
page (str) – The pagination token to use to continue listing participations from a previous call to list participations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Participation” domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. “Participation/system/Name”.
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(PagedResourceListOfParticipation, status_code(int), headers(HTTPHeaderDict))
- upsert_participations(participation_set_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertParticipations: Upsert Participation # noqa: E501
Upsert; update existing participations with given ids, or create new participations otherwise. # 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_participations(participation_set_request, async_req=True) >>> result = thread.get()
- Parameters:
participation_set_request (ParticipationSetRequest) – The collection of participation requests.
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_participations_with_http_info(participation_set_request=None, **kwargs)[source]
[EARLY ACCESS] UpsertParticipations: Upsert Participation # noqa: E501
Upsert; update existing participations with given ids, or create new participations otherwise. # 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_participations_with_http_info(participation_set_request, async_req=True) >>> result = thread.get()
- Parameters:
participation_set_request (ParticipationSetRequest) – The collection of participation requests.
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(ResourceListOfParticipation, status_code(int), headers(HTTPHeaderDict))