sdk.lusid.api.relationship_definitions_api.RelationshipDefinitionsApi
- class RelationshipDefinitionsApi(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] CreateRelationshipDefinition: Create Relationship Definition # noqa: E501
[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition # noqa: E501
[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition # noqa: E501
[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition # noqa: E501
[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition # noqa: E501
[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition # noqa: E501
[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions # noqa: E501
[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions # noqa: E501
[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition # noqa: E501
[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition # noqa: E501
- create_relationship_definition(create_relationship_definition_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition # noqa: E501
Create a new relationship definition to be used for creating relationships between entities. # 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_relationship_definition(create_relationship_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_relationship_definition_request (CreateRelationshipDefinitionRequest) – The definition of the new relationship. (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:
- create_relationship_definition_with_http_info(create_relationship_definition_request, **kwargs)[source]
[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition # noqa: E501
Create a new relationship definition to be used for creating relationships between entities. # 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_relationship_definition_with_http_info(create_relationship_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_relationship_definition_request (CreateRelationshipDefinitionRequest) – The definition of the new relationship. (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(RelationshipDefinition, status_code(int), headers(HTTPHeaderDict))
- delete_relationship_definition(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition # noqa: E501
Delete the definition of the specified relationship. # 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_relationship_definition(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship definition to be deleted. (required)
code (str) – The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship. (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_relationship_definition_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition # noqa: E501
Delete the definition of the specified relationship. # 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_relationship_definition_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship definition to be deleted. (required)
code (str) – The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship. (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_relationship_definition(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition # noqa: E501
Retrieve the specified relationship 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.get_relationship_definition(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified relationship definition. (required)
code (str) – The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition 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_relationship_definition_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition # noqa: E501
Retrieve the specified relationship 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.get_relationship_definition_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified relationship definition. (required)
code (str) – The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition 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(RelationshipDefinition, status_code(int), headers(HTTPHeaderDict))
- list_relationship_definitions(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions # noqa: E501
Retrieve one or more specified relationship definitions. # 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_relationship_definitions(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.
page (str) – The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “scope eq ‘ExampleScope’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
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_relationship_definitions_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions # noqa: E501
Retrieve one or more specified relationship definitions. # 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_relationship_definitions_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified.
page (str) – The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “scope eq ‘ExampleScope’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
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(PagedResourceListOfRelationshipDefinition, status_code(int), headers(HTTPHeaderDict))
- update_relationship_definition(scope, code, update_relationship_definition_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition # noqa: E501
Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. # 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_relationship_definition(scope, code, update_relationship_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship definition being updated. (required)
code (str) – The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition. (required)
update_relationship_definition_request (UpdateRelationshipDefinitionRequest) – The details of relationship definition to update. (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:
- update_relationship_definition_with_http_info(scope, code, update_relationship_definition_request, **kwargs)[source]
[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition # noqa: E501
Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship. # 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_relationship_definition_with_http_info(scope, code, update_relationship_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship definition being updated. (required)
code (str) – The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition. (required)
update_relationship_definition_request (UpdateRelationshipDefinitionRequest) – The details of relationship definition to update. (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(RelationshipDefinition, status_code(int), headers(HTTPHeaderDict))