sdk.lusid.api.custom_entities_api.CustomEntitiesApi

class CustomEntitiesApi(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_custom_entity`	[EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance.
`delete_custom_entity_access_metadata`	[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501
`delete_custom_entity_access_metadata_with_http_info`	[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501
`delete_custom_entity_with_http_info`	[EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance.
`get_all_custom_entity_access_metadata`	[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity # noqa: E501
`get_all_custom_entity_access_metadata_with_http_info`	[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity # noqa: E501
`get_custom_entity`	[EARLY ACCESS] GetCustomEntity: Get a Custom Entity instance.
`get_custom_entity_access_metadata_by_key`	[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity # noqa: E501
`get_custom_entity_access_metadata_by_key_with_http_info`	[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity # noqa: E501
`get_custom_entity_relationships`	[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501
`get_custom_entity_relationships_with_http_info`	[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501
`get_custom_entity_with_http_info`	[EARLY ACCESS] GetCustomEntity: Get a Custom Entity instance.
`list_custom_entities`	[EARLY ACCESS] ListCustomEntities: List Custom Entities of the specified entityType.
`list_custom_entities_with_http_info`	[EARLY ACCESS] ListCustomEntities: List Custom Entities of the specified entityType.
`patch_custom_entity_access_metadata`	[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity.
`patch_custom_entity_access_metadata_with_http_info`	[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity.
`upsert_custom_entities`	[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities # noqa: E501
`upsert_custom_entities_with_http_info`	[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities # noqa: E501
`upsert_custom_entity`	[EARLY ACCESS] UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501
`upsert_custom_entity_access_metadata`	[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey.
`upsert_custom_entity_access_metadata_with_http_info`	[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey.
`upsert_custom_entity_with_http_info`	[EARLY ACCESS] UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501

delete_custom_entity(entity_type, identifier_type, identifier_value, identifier_scope, async_req=None, **kwargs)[source]

[EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. # noqa: E501

Delete a Custom Entity instance by a specific entity type. # 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_custom_entity(entity_type, identifier_type, identifier_value, identifier_scope, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of Custom Entity to remove. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (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_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501

Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. 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.delete_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
metadata_key (str) – Key of the metadata entry to delete. (required)
identifier_scope (str) – The identifier scope. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata.
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata.
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_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at=None, effective_until=None, **kwargs)[source]

[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501

Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. 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.delete_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
metadata_key (str) – Key of the metadata entry to delete. (required)
identifier_scope (str) – The identifier scope. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata.
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata.
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))

delete_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, **kwargs)[source]

[EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. # noqa: E501

Delete a Custom Entity instance by a specific entity type. # 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_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of Custom Entity to remove. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (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_all_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, effective_at=None, as_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity # noqa: E501

Get all the Custom Entity access metadata for the specified identifier scope, code and value # 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_all_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (required)
effective_at (str) – The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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:

Dict[str, List[AccessMetadataValue]]

get_all_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, effective_at=None, as_at=None, **kwargs)[source]

[EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity # noqa: E501

Get all the Custom Entity access metadata for the specified identifier scope, code and value # 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_all_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (required)
effective_at (str) – The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))

get_custom_entity(entity_type, identifier_type, identifier_value, identifier_scope, as_at=None, effective_at=None, related_entity_property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetCustomEntity: Get a Custom Entity instance. # noqa: E501

Retrieve a Custom Entity instance by a specific entity type at a point in AsAt 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.get_custom_entity(entity_type, identifier_type, identifier_value, identifier_scope, as_at, effective_at, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of Custom Entity to retrieve. An entityType can be created using the “CreateCustomEntityDefinition” endpoint for CustomEntityDefinitions. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (required)
as_at (datetime) – The AsAt datetime at which to retrieve the Custom Entity instance.
effective_at (str) – The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.
related_entity_property_keys (List[str]) – A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
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:

CustomEntityResponse

get_custom_entity_access_metadata_by_key(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at=None, as_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity # noqa: E501

Get Custom Entity access metadata for the specified metadata key # 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_custom_entity_access_metadata_by_key(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
identifier_scope (str) – The identifier scope. (required)
effective_at (str) – The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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:

List[AccessMetadataValue]

get_custom_entity_access_metadata_by_key_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at=None, as_at=None, **kwargs)[source]

[EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity # noqa: E501

Get Custom Entity access metadata for the specified metadata key # 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_custom_entity_access_metadata_by_key_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
identifier_scope (str) – The identifier scope. (required)
effective_at (str) – The effective datetime or cut label at which to get the entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata. Defaults to returning the latest version of the metadata 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(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))

get_custom_entity_relationships(entity_type, identifier_scope, identifier_type, identifier_value, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501

Get relationships for the specified Custom Entity. # 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_custom_entity_relationships(entity_type, identifier_scope, identifier_type, identifier_value, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of entity get relationships for. (required)
identifier_scope (str) – The identifier scope. (required)
identifier_type (str) – An identifier type attached to the Custom Entity. (required)
identifier_value (str) – The identifier value. (required)
effective_at (str) – The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter relationships. Users should provide null or empty string for this field until further notice.
identifier_types (List[str]) – Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. They must be from the “Person” or “LegalEntity” domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
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:

ResourceListOfRelationship

get_custom_entity_relationships_with_http_info(entity_type, identifier_scope, identifier_type, identifier_value, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)[source]

[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501

Get relationships for the specified Custom Entity. # 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_custom_entity_relationships_with_http_info(entity_type, identifier_scope, identifier_type, identifier_value, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of entity get relationships for. (required)
identifier_scope (str) – The identifier scope. (required)
identifier_type (str) – An identifier type attached to the Custom Entity. (required)
identifier_value (str) – The identifier value. (required)
effective_at (str) – The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter relationships. Users should provide null or empty string for this field until further notice.
identifier_types (List[str]) – Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. They must be from the “Person” or “LegalEntity” domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
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(ResourceListOfRelationship, status_code(int), headers(HTTPHeaderDict))

get_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, as_at=None, effective_at=None, related_entity_property_keys=None, relationship_definition_ids=None, **kwargs)[source]

[EARLY ACCESS] GetCustomEntity: Get a Custom Entity instance. # noqa: E501

Retrieve a Custom Entity instance by a specific entity type at a point in AsAt 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.get_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, as_at, effective_at, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of Custom Entity to retrieve. An entityType can be created using the “CreateCustomEntityDefinition” endpoint for CustomEntityDefinitions. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (required)
as_at (datetime) – The AsAt datetime at which to retrieve the Custom Entity instance.
effective_at (str) – The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.
related_entity_property_keys (List[str]) – A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
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(CustomEntityResponse, status_code(int), headers(HTTPHeaderDict))

list_custom_entities(entity_type, effective_at=None, as_at=None, limit=None, filter=None, sort_by=None, page=None, related_entity_property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501

List all the Custom Entities 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_custom_entities(entity_type, effective_at, as_at, limit, filter, sort_by, page, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of Custom Entity to list. (required)
effective_at (str) – The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
page (str) – The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
related_entity_property_keys (List[str]) – A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
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:

PagedResourceListOfCustomEntityResponse

list_custom_entities_with_http_info(entity_type, effective_at=None, as_at=None, limit=None, filter=None, sort_by=None, page=None, related_entity_property_keys=None, relationship_definition_ids=None, **kwargs)[source]

[EARLY ACCESS] ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501

List all the Custom Entities 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_custom_entities_with_http_info(entity_type, effective_at, as_at, limit, filter, sort_by, page, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of Custom Entity to list. (required)
effective_at (str) – The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
page (str) – The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
related_entity_property_keys (List[str]) – A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example ‘Portfolio/Manager/Id’.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
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(PagedResourceListOfCustomEntityResponse, status_code(int), headers(HTTPHeaderDict))

patch_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. # noqa: E501

Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only ‘add’ is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (required)
access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)
effective_at (str) – The effectiveAt datetime at which the Access Metadata will be effective from
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
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:

Dict[str, List[AccessMetadataValue]]

patch_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at=None, effective_until=None, **kwargs)[source]

[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. # noqa: E501

Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only ‘add’ is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
identifier_scope (str) – The identifier scope. (required)
access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)
effective_at (str) – The effectiveAt datetime at which the Access Metadata will be effective from
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
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(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))

upsert_custom_entities(entity_type, success_mode, request_body, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities # noqa: E501

Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # 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_custom_entities(entity_type, success_mode, request_body, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity to be created. An entityType can be created using the “CreateCustomEntityDefinition” endpoint for CustomEntityDefinitions. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
request_body (Dict[str, CustomEntityRequest]) – The payload describing the Custom Entity instances (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:

UpsertCustomEntitiesResponse

upsert_custom_entities_with_http_info(entity_type, success_mode, request_body, **kwargs)[source]

[EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities # noqa: E501

Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code # 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_custom_entities_with_http_info(entity_type, success_mode, request_body, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity to be created. An entityType can be created using the “CreateCustomEntityDefinition” endpoint for CustomEntityDefinitions. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial (required)
request_body (Dict[str, CustomEntityRequest]) – The payload describing the Custom Entity instances (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(UpsertCustomEntitiesResponse, status_code(int), headers(HTTPHeaderDict))

upsert_custom_entity(entity_type, custom_entity_request, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501

Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist. # 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_custom_entity(entity_type, custom_entity_request, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity to be created. An entityType can be created using the “CreateCustomEntityDefinition” endpoint for CustomEntityDefinitions. (required)
custom_entity_request (CustomEntityRequest) – The payload describing the Custom Entity instance. (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:

CustomEntityResponse

upsert_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501

Update or insert one Custom Entity Access Metadata entry 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 Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # 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_custom_entity_access_metadata(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
identifier_scope (str) – The identifier scope. (required)
upsert_custom_entity_access_metadata_request (UpsertCustomEntityAccessMetadataRequest) – The Custom Entity Access Metadata entry to upsert (required)
effective_at (str) – The effectiveAt datetime at which the Access Metadata will be effective from
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
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[AccessMetadataValue]

upsert_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at=None, effective_until=None, **kwargs)[source]

[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501

Update or insert one Custom Entity Access Metadata entry 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 Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # 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_custom_entity_access_metadata_with_http_info(entity_type, identifier_type, identifier_value, metadata_key, identifier_scope, upsert_custom_entity_access_metadata_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity. (required)
identifier_type (str) – An identifier type attached to the Custom Entity instance. (required)
identifier_value (str) – The identifier value. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
identifier_scope (str) – The identifier scope. (required)
upsert_custom_entity_access_metadata_request (UpsertCustomEntityAccessMetadataRequest) – The Custom Entity Access Metadata entry to upsert (required)
effective_at (str) – The effectiveAt datetime at which the Access Metadata will be effective from
effective_until (datetime) – The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ datetime of the Access Metadata
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(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))

upsert_custom_entity_with_http_info(entity_type, custom_entity_request, **kwargs)[source]

[EARLY ACCESS] UpsertCustomEntity: Upsert a Custom Entity instance # noqa: E501

Insert the Custom Entity if it does not exist or update the Custom Entity with the supplied state if it does exist. # 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_custom_entity_with_http_info(entity_type, custom_entity_request, async_req=True)
>>> result = thread.get()

Parameters:

entity_type (str) – The type of the Custom Entity to be created. An entityType can be created using the “CreateCustomEntityDefinition” endpoint for CustomEntityDefinitions. (required)
custom_entity_request (CustomEntityRequest) – The payload describing the Custom Entity instance. (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(CustomEntityResponse, status_code(int), headers(HTTPHeaderDict))