sdk.lusid.api.relations_api.RelationsApi

class RelationsApi(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_relation`	[EXPERIMENTAL] CreateRelation: Create Relation # noqa: E501
`create_relation_with_http_info`	[EXPERIMENTAL] CreateRelation: Create Relation # noqa: E501
`delete_relation`	[EXPERIMENTAL] DeleteRelation: Delete a relation # noqa: E501
`delete_relation_with_http_info`	[EXPERIMENTAL] DeleteRelation: Delete a relation # noqa: E501

create_relation(scope, code, create_relation_request, effective_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateRelation: Create Relation # noqa: E501

Create a relation between two entity objects by their identifiers # 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_relation(scope, code, create_relation_request, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relation definition (required)
code (str) – The code of the relation definition (required)
create_relation_request (CreateRelationRequest) – The details of the relation to create. (required)
effective_at (str) – The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime 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:

CompleteRelation

create_relation_with_http_info(scope, code, create_relation_request, effective_at=None, **kwargs)[source]

[EXPERIMENTAL] CreateRelation: Create Relation # noqa: E501

Create a relation between two entity objects by their identifiers # 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_relation_with_http_info(scope, code, create_relation_request, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relation definition (required)
code (str) – The code of the relation definition (required)
create_relation_request (CreateRelationRequest) – The details of the relation to create. (required)
effective_at (str) – The effective datetime or cut label at which the relation should be effective from. Defaults to the current LUSID system datetime 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(CompleteRelation, status_code(int), headers(HTTPHeaderDict))

delete_relation(scope, code, delete_relation_request, effective_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteRelation: Delete a relation # noqa: E501

Delete a relation between two entity objects represented by their identifiers # 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_relation(scope, code, delete_relation_request, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relation definition (required)
code (str) – The code of the relation definition (required)
delete_relation_request (DeleteRelationRequest) – The details of the relation to delete. (required)
effective_at (str) – The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime 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:

DeletedEntityResponse

delete_relation_with_http_info(scope, code, delete_relation_request, effective_at=None, **kwargs)[source]

[EXPERIMENTAL] DeleteRelation: Delete a relation # noqa: E501

Delete a relation between two entity objects represented by their identifiers # 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_relation_with_http_info(scope, code, delete_relation_request, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relation definition (required)
code (str) – The code of the relation definition (required)
delete_relation_request (DeleteRelationRequest) – The details of the relation to delete. (required)
effective_at (str) – The effective datetime or cut label at which the relation should the deletion be effective from. Defaults to the current LUSID system datetime 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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))