sdk.lusid.api.identifier_definitions_api.IdentifierDefinitionsApi
- class IdentifierDefinitionsApi(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
[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition # noqa: E501
[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition # noqa: E501
[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition # noqa: E501
[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition # noqa: E501
[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition # noqa: E501
[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition # noqa: E501
[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions # noqa: E501
[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions # noqa: E501
[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType # noqa: E501
[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType # noqa: E501
- create_identifier_definition(create_identifier_definition_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition # noqa: E501
Define a new Identifier 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.create_identifier_definition(create_identifier_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_identifier_definition_request (CreateIdentifierDefinitionRequest) – The request defining the new definition
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:
- create_identifier_definition_with_http_info(create_identifier_definition_request=None, **kwargs)[source]
[EXPERIMENTAL] CreateIdentifierDefinition: Create an Identifier Definition # noqa: E501
Define a new Identifier 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.create_identifier_definition_with_http_info(create_identifier_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_identifier_definition_request (CreateIdentifierDefinitionRequest) – The request defining the new definition
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(IdentifierDefinition, status_code(int), headers(HTTPHeaderDict))
- delete_identifier_definition(domain, identifier_scope, identifier_type, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition # noqa: E501
The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # 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_identifier_definition(domain, identifier_scope, identifier_type, async_req=True) >>> result = thread.get()
- Parameters:
domain (str) – The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required)
identifier_scope (str) – The scope that the identifier exists in (required)
identifier_type (str) – What the identifier represents. Together with “domain” and “identifierScope” this uniquely identifies the identifier definition (required)
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:
- delete_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, **kwargs)[source]
[EXPERIMENTAL] DeleteIdentifierDefinition: Delete a particular Identifier Definition # noqa: E501
The deletion will take effect from the Identifier Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # 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_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, async_req=True) >>> result = thread.get()
- Parameters:
domain (str) – The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required)
identifier_scope (str) – The scope that the identifier exists in (required)
identifier_type (str) – What the identifier represents. Together with “domain” and “identifierScope” this uniquely identifies the identifier definition (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. 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))
- get_identifier_definition(domain, identifier_scope, identifier_type, as_at=None, effective_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition # noqa: E501
Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified # 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_identifier_definition(domain, identifier_scope, identifier_type, as_at, effective_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
domain (str) – The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required)
identifier_scope (str) – The scope that the identifier exists in (required)
identifier_type (str) – What the identifier represents. Together with “domain” and “identifierScope” this uniquely identifies the identifier definition (required)
as_at (datetime) – The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.
effective_at (str) – The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
property_keys (List[str]) – A list of property keys from the ‘IdentifierDefinition’ domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.
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:
- get_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, as_at=None, effective_at=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] GetIdentifierDefinition: Get a single Identifier Definition # noqa: E501
Get a single Identifier Definition using domain, identifierScope, identifierType, and an optional asAt - defaulting to latest if not specified # 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_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, as_at, effective_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
domain (str) – The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required)
identifier_scope (str) – The scope that the identifier exists in (required)
identifier_type (str) – What the identifier represents. Together with “domain” and “identifierScope” this uniquely identifies the identifier definition (required)
as_at (datetime) – The asAt datetime at which to retrieve the Identifier Definition. Defaults to return the latest version of the definition if not specified.
effective_at (str) – The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
property_keys (List[str]) – A list of property keys from the ‘IdentifierDefinition’ domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}. If no properties are specified, then no properties will be returned.
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(IdentifierDefinition, status_code(int), headers(HTTPHeaderDict))
- list_identifier_definitions(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions # noqa: E501
Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination # 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_identifier_definitions(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
as_at (datetime) – The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.
page (str) – The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many per page.
filter (str) – Expression to filter the result set. 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”
property_keys (List[str]) – A list of property keys from the ‘IdentifierDefinition’ domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.
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:
- list_identifier_definitions_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] ListIdentifierDefinitions: List Identifier Definitions # noqa: E501
Retrieves all Identifier Definitions that fit the filter, in a specific order if sortBy is provided Supports pagination # 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_identifier_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effectiveAt datetime at which to retrieve the Identifier Definitions. Since Identifier Definitions exist for all effective time, this will only apply to properties (if requested) on the Identifier Definition.
as_at (datetime) – The asAt datetime at which to retrieve the Identifier Definitions. Defaults to return the latest version of the Identifier Definitions if not specified.
page (str) – The pagination token to use to continue listing Identifier Definitions from a previous call to list Identifier Definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many per page.
filter (str) – Expression to filter the result set. 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”
property_keys (List[str]) – A list of property keys from the ‘IdentifierDefinition’ domain to decorate onto the Identifier Definition. These must take the format {domain}/{scope}/{code}.
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(PagedResourceListOfIdentifierDefinition, status_code(int), headers(HTTPHeaderDict))
- update_identifier_definition(domain, identifier_scope, identifier_type, update_identifier_definition_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType # noqa: E501
Overwrites an existing Identifier 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.update_identifier_definition(domain, identifier_scope, identifier_type, update_identifier_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
domain (str) – The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required)
identifier_scope (str) – The scope that the identifier exists in (required)
identifier_type (str) – What the identifier represents. Together with “domain” and “identifierScope” this uniquely identifies the Identifier Definition (required)
update_identifier_definition_request (UpdateIdentifierDefinitionRequest) – The request containing the updated details of the Identifier Definition.
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:
- update_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, update_identifier_definition_request=None, **kwargs)[source]
[EXPERIMENTAL] UpdateIdentifierDefinition: Update Identifier Definition defined by domain, identifierScope, and identifierType # noqa: E501
Overwrites an existing Identifier 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.update_identifier_definition_with_http_info(domain, identifier_scope, identifier_type, update_identifier_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
domain (str) – The type of entity to which the identifier relates. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required)
identifier_scope (str) – The scope that the identifier exists in (required)
identifier_type (str) – What the identifier represents. Together with “domain” and “identifierScope” this uniquely identifies the Identifier Definition (required)
update_identifier_definition_request (UpdateIdentifierDefinitionRequest) – The request containing the updated details of the Identifier Definition.
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(IdentifierDefinition, status_code(int), headers(HTTPHeaderDict))