sdk.lusid.api.relation_definitions_api.RelationDefinitionsApi

class RelationDefinitionsApi(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_definition`	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition # noqa: E501
`create_relation_definition_with_http_info`	[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition # noqa: E501
`delete_relation_definition`	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition # noqa: E501
`delete_relation_definition_with_http_info`	[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition # noqa: E501
`get_relation_definition`	[EXPERIMENTAL] GetRelationDefinition: Get relation definition # noqa: E501
`get_relation_definition_with_http_info`	[EXPERIMENTAL] GetRelationDefinition: Get relation definition # noqa: E501

create_relation_definition(create_relation_definition_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition # noqa: E501

Define a new relation. # 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_definition(create_relation_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_relation_definition_request (CreateRelationDefinitionRequest) – The definition of the new relation. (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:

RelationDefinition

create_relation_definition_with_http_info(create_relation_definition_request, **kwargs)[source]

[EXPERIMENTAL] CreateRelationDefinition: Create a relation definition # noqa: E501

Define a new relation. # 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_definition_with_http_info(create_relation_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_relation_definition_request (CreateRelationDefinitionRequest) – The definition of the new relation. (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(RelationDefinition, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition # noqa: E501

Delete the definition of the specified relation. # 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_definition(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relation to be deleted. (required)
code (str) – The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. (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:

DeletedEntityResponse

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

[EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition # noqa: E501

Delete the definition of the specified relation. # 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_definition_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the relation to be deleted. (required)
code (str) – The code of the relation to be deleted. Together with the domain and scope this uniquely identifies the relation. (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_relation_definition(scope, code, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetRelationDefinition: Get relation definition # noqa: E501

Retrieve the definition of a specified relation. # 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_relation_definition(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified relation. (required)
code (str) – The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. (required)
as_at (datetime) – The asAt datetime at which to retrieve the relation 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:

RelationDefinition

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

[EXPERIMENTAL] GetRelationDefinition: Get relation definition # noqa: E501

Retrieve the definition of a specified relation. # 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_relation_definition_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified relation. (required)
code (str) – The code of the specified relation. Together with the domain and scope this uniquely identifies the relation. (required)
as_at (datetime) – The asAt datetime at which to retrieve the relation 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(RelationDefinition, status_code(int), headers(HTTPHeaderDict))