sdk.lusid.api.relational_dataset_definition_api.RelationalDatasetDefinitionApi

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

`create_relational_dataset_definition`	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition # noqa: E501
`create_relational_dataset_definition_with_http_info`	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition # noqa: E501
`delete_relational_dataset_definition`	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition # noqa: E501
`delete_relational_dataset_definition_with_http_info`	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition # noqa: E501
`get_relational_dataset_definition`	GetRelationalDatasetDefinition: Get a Relational Dataset Definition # noqa: E501
`get_relational_dataset_definition_with_http_info`	GetRelationalDatasetDefinition: Get a Relational Dataset Definition # noqa: E501
`list_relational_dataset_definitions`	ListRelationalDatasetDefinitions: List Relational Dataset Definitions # noqa: E501
`list_relational_dataset_definitions_with_http_info`	ListRelationalDatasetDefinitions: List Relational Dataset Definitions # noqa: E501
`update_relational_dataset_definition`	UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition # noqa: E501
`update_relational_dataset_definition_with_http_info`	UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition # noqa: E501
`update_relational_dataset_details`	UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes # noqa: E501
`update_relational_dataset_details_with_http_info`	UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes # noqa: E501
`update_relational_dataset_field_schema`	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema # noqa: E501
`update_relational_dataset_field_schema_with_http_info`	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema # noqa: E501

create_relational_dataset_definition(create_relational_dataset_definition_request, async_req=None, **kwargs)[source]

CreateRelationalDatasetDefinition: Create a Relational Dataset Definition # noqa: E501

Create a new 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.create_relational_dataset_definition(create_relational_dataset_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_relational_dataset_definition_request (CreateRelationalDatasetDefinitionRequest) – The relational dataset definition to create. (required)
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:

RelationalDatasetDefinition

create_relational_dataset_definition_with_http_info(create_relational_dataset_definition_request, **kwargs)[source]

CreateRelationalDatasetDefinition: Create a Relational Dataset Definition # noqa: E501

Create a new 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.create_relational_dataset_definition_with_http_info(create_relational_dataset_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_relational_dataset_definition_request (CreateRelationalDatasetDefinitionRequest) – The relational dataset definition to create. (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. 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(RelationalDatasetDefinition, status_code(int), headers(HTTPHeaderDict))

delete_relational_dataset_definition(scope, code, async_req=None, **kwargs)[source]

DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition # noqa: E501

Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. # 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_relational_dataset_definition(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
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:

DeletedEntityResponse

delete_relational_dataset_definition_with_http_info(scope, code, **kwargs)[source]

DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition # noqa: E501

Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. # 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_relational_dataset_definition_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (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. 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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

get_relational_dataset_definition(scope, code, as_at=None, async_req=None, **kwargs)[source]

GetRelationalDatasetDefinition: Get a Relational Dataset Definition # noqa: E501

Retrieve a relational dataset definition by its 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_relational_dataset_definition(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version if not specified.
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:

RelationalDatasetDefinition

get_relational_dataset_definition_with_http_info(scope, code, as_at=None, **kwargs)[source]

GetRelationalDatasetDefinition: Get a Relational Dataset Definition # noqa: E501

Retrieve a relational dataset definition by its 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_relational_dataset_definition_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version 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. 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(RelationalDatasetDefinition, status_code(int), headers(HTTPHeaderDict))

list_relational_dataset_definitions(as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

ListRelationalDatasetDefinitions: List Relational Dataset Definitions # noqa: E501

List all relational dataset definitions 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_relational_dataset_definitions(as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified.
page (str) – The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions.
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.
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:

PagedResourceListOfRelationalDatasetDefinition

list_relational_dataset_definitions_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

ListRelationalDatasetDefinitions: List Relational Dataset Definitions # noqa: E501

List all relational dataset definitions 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_relational_dataset_definitions_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified.
page (str) – The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions.
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.
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(PagedResourceListOfRelationalDatasetDefinition, status_code(int), headers(HTTPHeaderDict))

update_relational_dataset_definition(scope, code, update_relational_dataset_definition_request=None, async_req=None, **kwargs)[source]

UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition # noqa: E501

Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this 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.update_relational_dataset_definition(scope, code, update_relational_dataset_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
update_relational_dataset_definition_request (UpdateRelationalDatasetDefinitionRequest) – The updated relational dataset definition.
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:

RelationalDatasetDefinition

update_relational_dataset_definition_with_http_info(scope, code, update_relational_dataset_definition_request=None, **kwargs)[source]

UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition # noqa: E501

Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this 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.update_relational_dataset_definition_with_http_info(scope, code, update_relational_dataset_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
update_relational_dataset_definition_request (UpdateRelationalDatasetDefinitionRequest) – The updated relational dataset definition.
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(RelationalDatasetDefinition, status_code(int), headers(HTTPHeaderDict))

update_relational_dataset_details(scope, code, update_relational_dataset_details=None, async_req=None, **kwargs)[source]

UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes # noqa: E501

Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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.update_relational_dataset_details(scope, code, update_relational_dataset_details, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
update_relational_dataset_details (UpdateRelationalDatasetDetails) – The updated details of the relational dataset.
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:

RelationalDatasetDefinition

update_relational_dataset_details_with_http_info(scope, code, update_relational_dataset_details=None, **kwargs)[source]

UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes # noqa: E501

Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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.update_relational_dataset_details_with_http_info(scope, code, update_relational_dataset_details, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
update_relational_dataset_details (UpdateRelationalDatasetDetails) – The updated details of the relational dataset.
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(RelationalDatasetDefinition, status_code(int), headers(HTTPHeaderDict))

update_relational_dataset_field_schema(scope, code, update_relational_dataset_field_schema=None, async_req=None, **kwargs)[source]

UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema # noqa: E501

Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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.update_relational_dataset_field_schema(scope, code, update_relational_dataset_field_schema, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
update_relational_dataset_field_schema (UpdateRelationalDatasetFieldSchema) – Relational dataset fields to add, update or remove.
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:

RelationalDatasetDefinition

update_relational_dataset_field_schema_with_http_info(scope, code, update_relational_dataset_field_schema=None, **kwargs)[source]

UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema # noqa: E501

Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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.update_relational_dataset_field_schema_with_http_info(scope, code, update_relational_dataset_field_schema, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relational dataset definition. (required)
code (str) – The code of the relational dataset definition. (required)
update_relational_dataset_field_schema (UpdateRelationalDatasetFieldSchema) – Relational dataset fields to add, update or remove.
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(RelationalDatasetDefinition, status_code(int), headers(HTTPHeaderDict))