sdk.lusid.api.relational_datasets_api.RelationalDatasetsApi

class RelationalDatasetsApi(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

`batch_delete_relational_data`	BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition.
`batch_delete_relational_data_with_http_info`	BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition.
`batch_upsert_relational_data`	BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition.
`batch_upsert_relational_data_with_http_info`	BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition.
`query_relational_data`	QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition.
`query_relational_data_with_http_info`	QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition.

batch_delete_relational_data(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode=None, async_req=None, **kwargs)[source]

BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition. # noqa: E501

Batch Delete Relational Data Points for a given Relational Dataset Definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.batch_delete_relational_data(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode, async_req=True)
>>> result = thread.get()

Parameters:

relational_dataset_definition_scope (str) – The Scope of the relational dataset definition. (required)
relational_dataset_definition_code (str) – The Code of the relational dataset definition. (required)
request_body (Dict[str, DeleteRelationalDataPointRequest]) – The Delete Request. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

BatchDeleteRelationalDataResponse

batch_delete_relational_data_with_http_info(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode=None, **kwargs)[source]

BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition. # noqa: E501

Batch Delete Relational Data Points for a given Relational Dataset Definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.batch_delete_relational_data_with_http_info(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode, async_req=True)
>>> result = thread.get()

Parameters:

relational_dataset_definition_scope (str) – The Scope of the relational dataset definition. (required)
relational_dataset_definition_code (str) – The Code of the relational dataset definition. (required)
request_body (Dict[str, DeleteRelationalDataPointRequest]) – The Delete Request. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(BatchDeleteRelationalDataResponse, status_code(int), headers(HTTPHeaderDict))

batch_upsert_relational_data(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode=None, async_req=None, **kwargs)[source]

BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition. # noqa: E501

Batch Upsert Relational Data Points for a given Relational Dataset Definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.batch_upsert_relational_data(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode, async_req=True)
>>> result = thread.get()

Parameters:

relational_dataset_definition_scope (str) – The Scope of the relational dataset definition. (required)
relational_dataset_definition_code (str) – The Code of the relational dataset definition. (required)
request_body (Dict[str, UpsertRelationalDataPointRequest]) – The DataPoints to upsert. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

BatchUpsertRelationalDatasetsResponse

batch_upsert_relational_data_with_http_info(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode=None, **kwargs)[source]

BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition. # noqa: E501

Batch Upsert Relational Data Points for a given Relational Dataset Definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.batch_upsert_relational_data_with_http_info(relational_dataset_definition_scope, relational_dataset_definition_code, request_body, success_mode, async_req=True)
>>> result = thread.get()

Parameters:

relational_dataset_definition_scope (str) – The Scope of the relational dataset definition. (required)
relational_dataset_definition_code (str) – The Code of the relational dataset definition. (required)
request_body (Dict[str, UpsertRelationalDataPointRequest]) – The DataPoints to upsert. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(BatchUpsertRelationalDatasetsResponse, status_code(int), headers(HTTPHeaderDict))

query_relational_data(relational_dataset_definition_scope, relational_dataset_definition_code, as_at=None, effective_at=None, page=None, limit=None, query_relational_dataset_request=None, async_req=None, **kwargs)[source]

QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition. # noqa: E501

Query Relational Data Points for a given Relational Dataset Definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_relational_data(relational_dataset_definition_scope, relational_dataset_definition_code, as_at, effective_at, page, limit, query_relational_dataset_request, async_req=True)
>>> result = thread.get()

Parameters:

relational_dataset_definition_scope (str) – The Scope of the relational dataset definition. (required)
relational_dataset_definition_code (str) – The Code of the relational dataset definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the dataset(s). Defaults to returning the latest version of each dataset if not specified.
effective_at (str) – The effective datetime or cut label at which to query the datasets. Defaults to the current LUSID system datetime if not specified.
page (str) – The pagination token to use to continue query datasets. This value is returned from the previous call. If a pagination token is provided, the filter, customSortBy, effectiveAt and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
query_relational_dataset_request (QueryRelationalDatasetRequest) – The query request.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfRelationalDataPointResponse

query_relational_data_with_http_info(relational_dataset_definition_scope, relational_dataset_definition_code, as_at=None, effective_at=None, page=None, limit=None, query_relational_dataset_request=None, **kwargs)[source]

QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition. # noqa: E501

Query Relational Data Points for a given Relational Dataset Definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_relational_data_with_http_info(relational_dataset_definition_scope, relational_dataset_definition_code, as_at, effective_at, page, limit, query_relational_dataset_request, async_req=True)
>>> result = thread.get()

Parameters:

relational_dataset_definition_scope (str) – The Scope of the relational dataset definition. (required)
relational_dataset_definition_code (str) – The Code of the relational dataset definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the dataset(s). Defaults to returning the latest version of each dataset if not specified.
effective_at (str) – The effective datetime or cut label at which to query the datasets. Defaults to the current LUSID system datetime if not specified.
page (str) – The pagination token to use to continue query datasets. This value is returned from the previous call. If a pagination token is provided, the filter, customSortBy, effectiveAt and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
query_relational_dataset_request (QueryRelationalDatasetRequest) – The query request.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(PagedResourceListOfRelationalDataPointResponse, status_code(int), headers(HTTPHeaderDict))