sdk.lusid.api.conventions_api.ConventionsApi

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

`delete_cds_flow_conventions`	[BETA] DeleteCdsFlowConventions: Delete the CDS Flow Conventions of given scope and code, assuming that it is present.
`delete_cds_flow_conventions_with_http_info`	[BETA] DeleteCdsFlowConventions: Delete the CDS Flow Conventions of given scope and code, assuming that it is present.
`delete_flow_conventions`	[BETA] DeleteFlowConventions: Delete the Flow Conventions of given scope and code, assuming that it is present.
`delete_flow_conventions_with_http_info`	[BETA] DeleteFlowConventions: Delete the Flow Conventions of given scope and code, assuming that it is present.
`delete_index_convention`	[BETA] DeleteIndexConvention: Delete the Index Convention of given scope and code, assuming that it is present.
`delete_index_convention_with_http_info`	[BETA] DeleteIndexConvention: Delete the Index Convention of given scope and code, assuming that it is present.
`get_cds_flow_conventions`	[BETA] GetCdsFlowConventions: Get CDS Flow Conventions # noqa: E501
`get_cds_flow_conventions_with_http_info`	[BETA] GetCdsFlowConventions: Get CDS Flow Conventions # noqa: E501
`get_flow_conventions`	[BETA] GetFlowConventions: Get Flow Conventions # noqa: E501
`get_flow_conventions_with_http_info`	[BETA] GetFlowConventions: Get Flow Conventions # noqa: E501
`get_index_convention`	[BETA] GetIndexConvention: Get Index Convention # noqa: E501
`get_index_convention_with_http_info`	[BETA] GetIndexConvention: Get Index Convention # noqa: E501
`list_cds_flow_conventions`	[BETA] ListCdsFlowConventions: List the set of CDS Flow Conventions # noqa: E501
`list_cds_flow_conventions_with_http_info`	[BETA] ListCdsFlowConventions: List the set of CDS Flow Conventions # noqa: E501
`list_flow_conventions`	[BETA] ListFlowConventions: List the set of Flow Conventions # noqa: E501
`list_flow_conventions_with_http_info`	[BETA] ListFlowConventions: List the set of Flow Conventions # noqa: E501
`list_index_convention`	[BETA] ListIndexConvention: List the set of Index Conventions # noqa: E501
`list_index_convention_with_http_info`	[BETA] ListIndexConvention: List the set of Index Conventions # noqa: E501
`upsert_cds_flow_conventions`	[BETA] UpsertCdsFlowConventions: Upsert a set of CDS Flow Conventions.
`upsert_cds_flow_conventions_with_http_info`	[BETA] UpsertCdsFlowConventions: Upsert a set of CDS Flow Conventions.
`upsert_flow_conventions`	[BETA] UpsertFlowConventions: Upsert Flow Conventions.
`upsert_flow_conventions_with_http_info`	[BETA] UpsertFlowConventions: Upsert Flow Conventions.
`upsert_index_convention`	[BETA] UpsertIndexConvention: Upsert a set of Index Convention.
`upsert_index_convention_with_http_info`	[BETA] UpsertIndexConvention: Upsert a set of Index Convention.

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

[BETA] DeleteCdsFlowConventions: Delete the CDS Flow Conventions of given scope and code, assuming that it is present. # noqa: E501

Delete the specified CDS Flow Conventions from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # 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_cds_flow_conventions(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the CDS Flow Conventions to delete. (required)
code (str) – The CDS Flow Conventions 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:

AnnulSingleStructuredDataResponse

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

[BETA] DeleteCdsFlowConventions: Delete the CDS Flow Conventions of given scope and code, assuming that it is present. # noqa: E501

Delete the specified CDS Flow Conventions from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # 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_cds_flow_conventions_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the CDS Flow Conventions to delete. (required)
code (str) – The CDS Flow Conventions 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(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

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

[BETA] DeleteFlowConventions: Delete the Flow Conventions of given scope and code, assuming that it is present. # noqa: E501

Delete the specified conventions from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # 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_flow_conventions(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Flow Conventions to delete. (required)
code (str) – The Flow Conventions 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:

AnnulSingleStructuredDataResponse

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

[BETA] DeleteFlowConventions: Delete the Flow Conventions of given scope and code, assuming that it is present. # noqa: E501

Delete the specified conventions from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # 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_flow_conventions_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Flow Conventions to delete. (required)
code (str) – The Flow Conventions 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(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

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

[BETA] DeleteIndexConvention: Delete the Index Convention of given scope and code, assuming that it is present. # noqa: E501

Delete the specified Index Convention from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # 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_index_convention(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Index Convention to delete. (required)
code (str) – The Index Convention 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:

AnnulSingleStructuredDataResponse

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

[BETA] DeleteIndexConvention: Delete the Index Convention of given scope and code, assuming that it is present. # noqa: E501

Delete the specified Index Convention from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # 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_index_convention_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Index Convention to delete. (required)
code (str) – The Index Convention 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(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

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

[BETA] GetCdsFlowConventions: Get CDS Flow Conventions # noqa: E501

Get a CDS Flow Conventions from a single scope. The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_cds_flow_conventions(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the CDS Flow Conventions to retrieve. (required)
code (str) – The name of the CDS Flow Conventions to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the CDS Flow Conventions. Defaults to return the latest version 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:

GetCdsFlowConventionsResponse

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

[BETA] GetCdsFlowConventions: Get CDS Flow Conventions # noqa: E501

Get a CDS Flow Conventions from a single scope. The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_cds_flow_conventions_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the CDS Flow Conventions to retrieve. (required)
code (str) – The name of the CDS Flow Conventions to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the CDS Flow Conventions. 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 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(GetCdsFlowConventionsResponse, status_code(int), headers(HTTPHeaderDict))

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

[BETA] GetFlowConventions: Get Flow Conventions # noqa: E501

Get a Flow Conventions from a single scope. The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_flow_conventions(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Flow Conventions to retrieve. (required)
code (str) – The name of the Flow Conventions to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Flow Conventions. Defaults to return the latest version 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:

GetFlowConventionsResponse

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

[BETA] GetFlowConventions: Get Flow Conventions # noqa: E501

Get a Flow Conventions from a single scope. The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_flow_conventions_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Flow Conventions to retrieve. (required)
code (str) – The name of the Flow Conventions to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Flow Conventions. 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 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(GetFlowConventionsResponse, status_code(int), headers(HTTPHeaderDict))

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

[BETA] GetIndexConvention: Get Index Convention # noqa: E501

Get a Index Convention from a single scope. The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_index_convention(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Index Convention to retrieve. (required)
code (str) – The name of the Index Convention to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Index Convention. Defaults to return the latest version 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:

GetIndexConventionResponse

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

[BETA] GetIndexConvention: Get Index Convention # noqa: E501

Get a Index Convention from a single scope. The response will return either the conventions that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_index_convention_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Index Convention to retrieve. (required)
code (str) – The name of the Index Convention to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Index Convention. 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 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(GetIndexConventionResponse, status_code(int), headers(HTTPHeaderDict))

list_cds_flow_conventions(as_at=None, async_req=None, **kwargs)[source]

[BETA] ListCdsFlowConventions: List the set of CDS Flow Conventions # noqa: E501

List the set of CDS Flow Conventions at the specified date/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.list_cds_flow_conventions(as_at, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the conventions. Defaults to latest 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:

ResourceListOfGetCdsFlowConventionsResponse

list_cds_flow_conventions_with_http_info(as_at=None, **kwargs)[source]

[BETA] ListCdsFlowConventions: List the set of CDS Flow Conventions # noqa: E501

List the set of CDS Flow Conventions at the specified date/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.list_cds_flow_conventions_with_http_info(as_at, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the conventions. Defaults to latest 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(ResourceListOfGetCdsFlowConventionsResponse, status_code(int), headers(HTTPHeaderDict))

list_flow_conventions(as_at=None, async_req=None, **kwargs)[source]

[BETA] ListFlowConventions: List the set of Flow Conventions # noqa: E501

List the set of Flow Conventions at the specified date/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.list_flow_conventions(as_at, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the conventions. Defaults to latest 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:

ResourceListOfGetFlowConventionsResponse

list_flow_conventions_with_http_info(as_at=None, **kwargs)[source]

[BETA] ListFlowConventions: List the set of Flow Conventions # noqa: E501

List the set of Flow Conventions at the specified date/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.list_flow_conventions_with_http_info(as_at, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the conventions. Defaults to latest 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(ResourceListOfGetFlowConventionsResponse, status_code(int), headers(HTTPHeaderDict))

list_index_convention(as_at=None, async_req=None, **kwargs)[source]

[BETA] ListIndexConvention: List the set of Index Conventions # noqa: E501

List the set of Index Conventions at the specified date/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.list_index_convention(as_at, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the conventions. Defaults to latest 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:

ResourceListOfGetIndexConventionResponse

list_index_convention_with_http_info(as_at=None, **kwargs)[source]

[BETA] ListIndexConvention: List the set of Index Conventions # noqa: E501

List the set of Index Conventions at the specified date/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.list_index_convention_with_http_info(as_at, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the conventions. Defaults to latest 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(ResourceListOfGetIndexConventionResponse, status_code(int), headers(HTTPHeaderDict))

upsert_cds_flow_conventions(upsert_cds_flow_conventions_request, async_req=None, **kwargs)[source]

[BETA] UpsertCdsFlowConventions: Upsert a set of CDS Flow Conventions. This creates or updates the data in Lusid. # noqa: E501

Update or insert CDS Flow Conventions in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted CDS Flow Conventions or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_cds_flow_conventions(upsert_cds_flow_conventions_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_cds_flow_conventions_request (UpsertCdsFlowConventionsRequest) – The CDS Flow Conventions to update or insert (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:

UpsertSingleStructuredDataResponse

upsert_cds_flow_conventions_with_http_info(upsert_cds_flow_conventions_request, **kwargs)[source]

[BETA] UpsertCdsFlowConventions: Upsert a set of CDS Flow Conventions. This creates or updates the data in Lusid. # noqa: E501

Update or insert CDS Flow Conventions in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted CDS Flow Conventions or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_cds_flow_conventions_with_http_info(upsert_cds_flow_conventions_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_cds_flow_conventions_request (UpsertCdsFlowConventionsRequest) – The CDS Flow Conventions to update or insert (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(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

upsert_flow_conventions(upsert_flow_conventions_request, async_req=None, **kwargs)[source]

[BETA] UpsertFlowConventions: Upsert Flow Conventions. This creates or updates the data in Lusid. # noqa: E501

Update or insert Flow Conventions in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Flow Conventions or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_flow_conventions(upsert_flow_conventions_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_flow_conventions_request (UpsertFlowConventionsRequest) – The Flow Conventions to update or insert (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:

UpsertSingleStructuredDataResponse

upsert_flow_conventions_with_http_info(upsert_flow_conventions_request, **kwargs)[source]

[BETA] UpsertFlowConventions: Upsert Flow Conventions. This creates or updates the data in Lusid. # noqa: E501

Update or insert Flow Conventions in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Flow Conventions or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_flow_conventions_with_http_info(upsert_flow_conventions_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_flow_conventions_request (UpsertFlowConventionsRequest) – The Flow Conventions to update or insert (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(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

upsert_index_convention(upsert_index_convention_request, async_req=None, **kwargs)[source]

[BETA] UpsertIndexConvention: Upsert a set of Index Convention. This creates or updates the data in Lusid. # noqa: E501

Update or insert Index Convention in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Index Convention or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_index_convention(upsert_index_convention_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_index_convention_request (UpsertIndexConventionRequest) – The Index Conventions to update or insert (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:

UpsertSingleStructuredDataResponse

upsert_index_convention_with_http_info(upsert_index_convention_request, **kwargs)[source]

[BETA] UpsertIndexConvention: Upsert a set of Index Convention. This creates or updates the data in Lusid. # noqa: E501

Update or insert Index Convention in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Index Convention or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_index_convention_with_http_info(upsert_index_convention_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_index_convention_request (UpsertIndexConventionRequest) – The Index Conventions to update or insert (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(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))