sdk.lusid.api.persons_api.PersonsApi
- class PersonsApi(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] DeletePerson: Delete person # noqa: E501
[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry # noqa: E501
[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry # noqa: E501
[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers # noqa: E501
[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers # noqa: E501
[EARLY ACCESS] DeletePersonProperties: Delete Person Properties # noqa: E501
[EARLY ACCESS] DeletePersonProperties: Delete Person Properties # noqa: E501
[EARLY ACCESS] DeletePerson: Delete person # noqa: E501
[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person # noqa: E501
[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person # noqa: E501
[EARLY ACCESS] GetPerson: Get Person # noqa: E501
[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person # noqa: E501
[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person # noqa: E501
[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series # noqa: E501
[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series # noqa: E501
[EARLY ACCESS] GetPersonRelations: Get Relations for Person # noqa: E501
[EARLY ACCESS] GetPersonRelations: Get Relations for Person # noqa: E501
[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person # noqa: E501
[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person # noqa: E501
[EARLY ACCESS] GetPerson: Get Person # noqa: E501
[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
[EARLY ACCESS] ListPersons: List Persons # noqa: E501
[EARLY ACCESS] ListPersons: List Persons # noqa: E501
[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person.
[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person.
[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers # noqa: E501
[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers # noqa: E501
[EARLY ACCESS] SetPersonProperties: Set Person Properties # noqa: E501
[EARLY ACCESS] SetPersonProperties: Set Person Properties # noqa: E501
[EARLY ACCESS] UpsertPerson: Upsert Person # noqa: E501
[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey.
[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey.
[EARLY ACCESS] UpsertPerson: Upsert Person # noqa: E501
- delete_person(id_type_scope, id_type_code, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeletePerson: Delete person # noqa: E501
Delete a person. Deletion will be valid from the person’s creation datetime. This means that the person will no longer exist at any effective datetime from 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_person(id_type_scope, id_type_code, code, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – The scope of the person identifier type. (required)
id_type_code (str) – The code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. (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_person_access_metadata(id_type_scope, id_type_code, code, metadata_key, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry # noqa: E501
Deletes the Person 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_person_access_metadata(id_type_scope, id_type_code, code, metadata_key, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found
effective_until (datetime) – The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date 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:
- delete_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at=None, effective_until=None, **kwargs)[source]
[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry # noqa: E501
Deletes the Person 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_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found
effective_until (datetime) – The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next ‘effectiveAt’ date 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_person_identifiers(id_type_scope, id_type_code, code, property_keys, effective_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers # noqa: E501
Delete identifiers that belong to the given property keys of the person. # 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_person_identifiers(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_keys (List[str]) – The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. Each property must be from the “Person” domain. Identifiers or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
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_person_identifiers_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at=None, **kwargs)[source]
[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers # noqa: E501
Delete identifiers that belong to the given property keys of the person. # 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_person_identifiers_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_keys (List[str]) – The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. Each property must be from the “Person” domain. Identifiers or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
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_person_properties(id_type_scope, id_type_code, code, property_keys, effective_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeletePersonProperties: Delete Person Properties # noqa: E501
Delete all properties that belong to the given property keys of the person. # 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_person_properties(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_keys (List[str]) – The property keys of the person’s properties to delete. These take the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. Each property must be from the “Person” domain. Properties or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified ‘effectiveAt’ datetime. If the ‘effectiveAt’ is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
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_person_properties_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at=None, **kwargs)[source]
[EARLY ACCESS] DeletePersonProperties: Delete Person Properties # noqa: E501
Delete all properties that belong to the given property keys of the person. # 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_person_properties_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_keys (List[str]) – The property keys of the person’s properties to delete. These take the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. Each property must be from the “Person” domain. Properties or identifiers not specified in request will not be changed. (required)
effective_at (str) – The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified ‘effectiveAt’ datetime. If the ‘effectiveAt’ is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
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_person_with_http_info(id_type_scope, id_type_code, code, **kwargs)[source]
[EARLY ACCESS] DeletePerson: Delete person # noqa: E501
Delete a person. Deletion will be valid from the person’s creation datetime. This means that the person will no longer exist at any effective datetime from 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_person_with_http_info(id_type_scope, id_type_code, code, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – The scope of the person identifier type. (required)
id_type_code (str) – The code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. (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_person_access_metadata(id_type_scope, id_type_code, code, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person # noqa: E501
Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata # 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_person_access_metadata(id_type_scope, id_type_code, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve 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]]
- get_all_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, effective_at=None, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person # noqa: E501
Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata # 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_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve 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))
- get_person(id_type_scope, id_type_code, code, property_keys=None, effective_at=None, as_at=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetPerson: Get Person # noqa: E501
Retrieve the definition of a person. # 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_person(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_keys (List[str]) – A list of property keys from the “Person” domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “Person/ContactDetails/Address”.
effective_at (str) – The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the person 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:
- get_person_access_metadata_by_key(id_type_scope, id_type_code, code, metadata_key, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person # noqa: E501
Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # 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_person_access_metadata_by_key(id_type_scope, id_type_code, code, metadata_key, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve 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]
- get_person_access_metadata_by_key_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at=None, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person # noqa: E501
Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # 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_person_access_metadata_by_key_with_http_info(id_type_scope, id_type_code, code, metadata_key, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata
as_at (datetime) – The asAt datetime at which to retrieve 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))
- get_person_property_time_series(id_type_scope, id_type_code, code, property_key, as_at=None, filter=None, page=None, limit=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series # noqa: E501
List the complete time series of a person property. # 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_person_property_time_series(id_type_scope, id_type_code, code, property_key, as_at, filter, page, limit, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_key (str) – The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. Each property must be from the “Person” domain. (required)
as_at (datetime) – The asAt datetime at which to list the person’s property history. Defaults to return the current datetime if not supplied.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many.
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_person_property_time_series_with_http_info(id_type_scope, id_type_code, code, property_key, as_at=None, filter=None, page=None, limit=None, **kwargs)[source]
[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series # noqa: E501
List the complete time series of a person property. # 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_person_property_time_series_with_http_info(id_type_scope, id_type_code, code, property_key, as_at, filter, page, limit, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_key (str) – The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. “Person/CompanyDetails/Role”. Each property must be from the “Person” domain. (required)
as_at (datetime) – The asAt datetime at which to list the person’s property history. Defaults to return the current datetime if not supplied.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many.
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(ResourceListOfPropertyInterval, status_code(int), headers(HTTPHeaderDict))
- get_person_relations(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetPersonRelations: Get Relations for Person # noqa: E501
Get relations for the specified person. # 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_person_relations(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
effective_at (str) – The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the person’s relations. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter the relations. 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 relations. 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:
- get_person_relations_with_http_info(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)[source]
[EARLY ACCESS] GetPersonRelations: Get Relations for Person # noqa: E501
Get relations for the specified person. # 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_person_relations_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
effective_at (str) – The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the person’s relations. Defaults to return the latest LUSID AsAt time if not specified.
filter (str) – Expression to filter the relations. 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 relations. 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(ResourceListOfRelation, status_code(int), headers(HTTPHeaderDict))
- get_person_relationships(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person # noqa: E501
Get relationships for the specified person. # 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_person_relationships(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person’s identifier type. (required)
id_type_code (str) – Code of the person’s identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (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]) – Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the ‘Person’ or ‘LegalEntity’ domains and have the format {domain}/{scope}/{code}, for example ‘Person/CompanyDetails/Role’. An Empty array may be used to return all related Entities.
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_person_relationships_with_http_info(id_type_scope, id_type_code, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)[source]
[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person # noqa: E501
Get relationships for the specified person. # 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_person_relationships_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person’s identifier type. (required)
id_type_code (str) – Code of the person’s identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (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]) – Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the ‘Person’ or ‘LegalEntity’ domains and have the format {domain}/{scope}/{code}, for example ‘Person/CompanyDetails/Role’. An Empty array may be used to return all related Entities.
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_person_with_http_info(id_type_scope, id_type_code, code, property_keys=None, effective_at=None, as_at=None, relationship_definition_ids=None, **kwargs)[source]
[EARLY ACCESS] GetPerson: Get Person # noqa: E501
Retrieve the definition of a person. # 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_person_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. (required)
property_keys (List[str]) – A list of property keys from the “Person” domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “Person/ContactDetails/Address”.
effective_at (str) – The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the person 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:
- list_all_persons(effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
List all persons which the user is entitled to see. # 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_all_persons(effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
page (str) – The pagination token to use to continue listing persons from a previous call to list persons. 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.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the display name, use “displayName eq ‘John’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Person” domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “Person/ContactDetails/Address”.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the persons 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:
- list_all_persons_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, relationship_definition_ids=None, **kwargs)[source]
[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
List all persons which the user is entitled to see. # 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_all_persons_with_http_info(effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
page (str) – The pagination token to use to continue listing persons from a previous call to list persons. 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.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the display name, use “displayName eq ‘John’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Person” domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “Person/ContactDetails/Address”.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the persons 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(ResourceListOfPerson, status_code(int), headers(HTTPHeaderDict))
- list_persons(id_type_scope, id_type_code, effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListPersons: List Persons # noqa: E501
List persons which have identifiers of a specific identifier type’s scope and code, and satisfies filter 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_persons(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
effective_at (str) – The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
page (str) – The pagination token to use to continue listing persons from a previous call to list persons. 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.
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 LUPID, use “lusidPersonId eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Person” domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “Person/ContactDetails/Address”.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the persons 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:
- list_persons_with_http_info(id_type_scope, id_type_code, effective_at=None, as_at=None, page=None, limit=None, filter=None, property_keys=None, relationship_definition_ids=None, **kwargs)[source]
[EARLY ACCESS] ListPersons: List Persons # noqa: E501
List persons which have identifiers of a specific identifier type’s scope and code, and satisfies filter 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_persons_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
effective_at (str) – The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
page (str) – The pagination token to use to continue listing persons from a previous call to list persons. 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.
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 LUPID, use “lusidPersonId eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Person” domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. “Person/ContactDetails/Address”.
relationship_definition_ids (List[str]) – A list of relationship definitions that are used to decorate related entities onto the persons 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(PagedResourceListOfPerson, status_code(int), headers(HTTPHeaderDict))
- patch_person_access_metadata(id_type_scope, id_type_code, code, access_metadata_operation, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. # noqa: E501
Patch Person 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 Person 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_person_access_metadata(id_type_scope, id_type_code, code, access_metadata_operation, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)
effective_at (str) – The effectiveAt datetime at which to upsert 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:
Dict[str, List[AccessMetadataValue]]
- patch_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, access_metadata_operation, effective_at=None, effective_until=None, **kwargs)[source]
[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. # noqa: E501
Patch Person 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 Person 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_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, access_metadata_operation, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
access_metadata_operation (List[AccessMetadataOperation]) – The Json Patch document (required)
effective_at (str) – The effectiveAt datetime at which to upsert 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(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))
- set_person_identifiers(id_type_scope, id_type_code, code, set_person_identifiers_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers # noqa: E501
Set identifiers of the person. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_person_identifiers(id_type_scope, id_type_code, code, set_person_identifiers_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
set_person_identifiers_request (SetPersonIdentifiersRequest) – Request containing identifiers to set for the person. Identifiers not specified in request will not be changed. (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:
- set_person_identifiers_with_http_info(id_type_scope, id_type_code, code, set_person_identifiers_request, **kwargs)[source]
[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers # noqa: E501
Set identifiers of the person. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_person_identifiers_with_http_info(id_type_scope, id_type_code, code, set_person_identifiers_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
set_person_identifiers_request (SetPersonIdentifiersRequest) – Request containing identifiers to set for the person. Identifiers not specified in request will not be changed. (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:
- set_person_properties(id_type_scope, id_type_code, code, set_person_properties_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] SetPersonProperties: Set Person Properties # noqa: E501
Set properties of the person. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_person_properties(id_type_scope, id_type_code, code, set_person_properties_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
set_person_properties_request (SetPersonPropertiesRequest) – Request containing properties to set for the person. Properties not specified in request will not be changed. (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:
- set_person_properties_with_http_info(id_type_scope, id_type_code, code, set_person_properties_request, **kwargs)[source]
[EARLY ACCESS] SetPersonProperties: Set Person Properties # noqa: E501
Set properties of the person. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_person_properties_with_http_info(id_type_scope, id_type_code, code, set_person_properties_request, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier type. (required)
id_type_code (str) – Code of the person identifier type. (required)
code (str) – Code of the person under specified identifier type’s scope and code. This together with stated identifier type uniquely identifies the person. (required)
set_person_properties_request (SetPersonPropertiesRequest) – Request containing properties to set for the person. Properties not specified in request will not be changed. (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:
- upsert_person(upsert_person_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertPerson: Upsert Person # noqa: E501
Create or update a new person under the specified scope. # 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_person(upsert_person_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_person_request (UpsertPersonRequest) – Request to create or update a person. (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:
- upsert_person_access_metadata(id_type_scope, id_type_code, code, metadata_key, upsert_person_access_metadata_request, effective_at=None, effective_until=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
Update or insert one Person 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 Person 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_person_access_metadata(id_type_scope, id_type_code, code, metadata_key, upsert_person_access_metadata_request, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
upsert_person_access_metadata_request (UpsertPersonAccessMetadataRequest) – The Person Access Metadata entry to upsert (required)
effective_at (str) – The effectiveAt datetime at which to upsert 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:
- upsert_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, upsert_person_access_metadata_request, effective_at=None, effective_until=None, **kwargs)[source]
[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
Update or insert one Person 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 Person 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_person_access_metadata_with_http_info(id_type_scope, id_type_code, code, metadata_key, upsert_person_access_metadata_request, effective_at, effective_until, async_req=True) >>> result = thread.get()
- Parameters:
id_type_scope (str) – Scope of the person identifier. (required)
id_type_code (str) – Code of the person identifier. (required)
code (str) – Code of the person under specified identifier type’s scope and code. (required)
metadata_key (str) – Key of the metadata entry to retrieve (required)
upsert_person_access_metadata_request (UpsertPersonAccessMetadataRequest) – The Person Access Metadata entry to upsert (required)
effective_at (str) – The effectiveAt datetime at which to upsert 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(ResourceListOfAccessMetadataValueOf, status_code(int), headers(HTTPHeaderDict))
- upsert_person_with_http_info(upsert_person_request, **kwargs)[source]
[EARLY ACCESS] UpsertPerson: Upsert Person # noqa: E501
Create or update a new person under the specified scope. # 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_person_with_http_info(upsert_person_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_person_request (UpsertPersonRequest) – Request to create or update a person. (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: