LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.LegalEntitiesApi Class Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.LegalEntitiesApi:
Inheritance graph
[legend]

Public Member Functions

 LegalEntitiesApi ()
 Initializes a new instance of the LegalEntitiesApi class. More...
 
 LegalEntitiesApi (string basePath)
 Initializes a new instance of the LegalEntitiesApi class. More...
 
 LegalEntitiesApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the LegalEntitiesApi class using Configuration object More...
 
 LegalEntitiesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the LegalEntitiesApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
DeletedEntityResponse DeleteLegalEntity (string idTypeScope, string idTypeCode, string code, int operationIndex=0)
 DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity's creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteLegalEntityWithHttpInfo (string idTypeScope, string idTypeCode, string code, int operationIndex=0)
 DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteLegalEntityWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
DeletedEntityResponse DeleteLegalEntityAccessMetadata (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteLegalEntityAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteLegalEntityAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
DeletedEntityResponse DeleteLegalEntityIdentifiers (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteLegalEntityIdentifiersWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityIdentifiersAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteLegalEntityIdentifiersWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity. More...
 
DeletedEntityResponse DeleteLegalEntityProperties (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteLegalEntityPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityPropertiesAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteLegalEntityPropertiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity. More...
 
Dictionary< string, List< AccessMetadataValue > > GetAllLegalEntityAccessMetadata (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > GetAllLegalEntityAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata More...
 
async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > GetAllLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > GetAllLegalEntityAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata More...
 
LegalEntity GetLegalEntity (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More...
 
Lusid.Sdk.Client.ApiResponse< LegalEntityGetLegalEntityWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More...
 
async System.Threading.Tasks.Task< LegalEntityGetLegalEntityAsync (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< LegalEntity > > GetLegalEntityWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More...
 
List< AccessMetadataValueGetLegalEntityAccessMetadataByKey (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > GetLegalEntityAccessMetadataByKeyWithHttpInfo (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
async System.Threading.Tasks.Task< List< AccessMetadataValue > > GetLegalEntityAccessMetadataByKeyAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > > GetLegalEntityAccessMetadataByKeyWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
ResourceListOfPropertyInterval GetLegalEntityPropertyTimeSeries (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyIntervalGetLegalEntityPropertyTimeSeriesWithHttpInfo (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property. More...
 
async System.Threading.Tasks.Task< ResourceListOfPropertyIntervalGetLegalEntityPropertyTimeSeriesAsync (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > > GetLegalEntityPropertyTimeSeriesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property. More...
 
ResourceListOfRelation GetLegalEntityRelations (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationGetLegalEntityRelationsWithHttpInfo (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity More...
 
async System.Threading.Tasks.Task< ResourceListOfRelationGetLegalEntityRelationsAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelation > > GetLegalEntityRelationsWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity More...
 
ResourceListOfRelationship GetLegalEntityRelationships (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationshipGetLegalEntityRelationshipsWithHttpInfo (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity More...
 
async System.Threading.Tasks.Task< ResourceListOfRelationshipGetLegalEntityRelationshipsAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > > GetLegalEntityRelationshipsWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity More...
 
ResourceListOfLegalEntity ListAllLegalEntities (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfLegalEntityListAllLegalEntitiesWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see. More...
 
async System.Threading.Tasks.Task< ResourceListOfLegalEntityListAllLegalEntitiesAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfLegalEntity > > ListAllLegalEntitiesWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see. More...
 
PagedResourceListOfLegalEntity ListLegalEntities (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfLegalEntityListLegalEntitiesWithHttpInfo (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
async System.Threading.Tasks.Task< PagedResourceListOfLegalEntityListLegalEntitiesAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfLegalEntity > > ListLegalEntitiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
Dictionary< string, List< AccessMetadataValue > > PatchLegalEntityAccessMetadata (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > PatchLegalEntityAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > PatchLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > PatchLegalEntityAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
LegalEntity SetLegalEntityIdentifiers (string idTypeScope, string idTypeCode, string code, SetLegalEntityIdentifiersRequest setLegalEntityIdentifiersRequest, int operationIndex=0)
 [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity. More...
 
Lusid.Sdk.Client.ApiResponse< LegalEntitySetLegalEntityIdentifiersWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetLegalEntityIdentifiersRequest setLegalEntityIdentifiersRequest, int operationIndex=0)
 [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity. More...
 
async System.Threading.Tasks.Task< LegalEntitySetLegalEntityIdentifiersAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityIdentifiersRequest setLegalEntityIdentifiersRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< LegalEntity > > SetLegalEntityIdentifiersWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityIdentifiersRequest setLegalEntityIdentifiersRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity. More...
 
LegalEntity SetLegalEntityProperties (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0)
 SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity. More...
 
Lusid.Sdk.Client.ApiResponse< LegalEntitySetLegalEntityPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0)
 SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity. More...
 
async System.Threading.Tasks.Task< LegalEntitySetLegalEntityPropertiesAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< LegalEntity > > SetLegalEntityPropertiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity. More...
 
UpsertLegalEntitiesResponse UpsertLegalEntities (string successMode, Dictionary< string, UpsertLegalEntityRequest > requestBody, int operationIndex=0)
 [EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities More...
 
Lusid.Sdk.Client.ApiResponse< UpsertLegalEntitiesResponseUpsertLegalEntitiesWithHttpInfo (string successMode, Dictionary< string, UpsertLegalEntityRequest > requestBody, int operationIndex=0)
 [EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities More...
 
async System.Threading.Tasks.Task< UpsertLegalEntitiesResponseUpsertLegalEntitiesAsync (string successMode, Dictionary< string, UpsertLegalEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertLegalEntitiesResponse > > UpsertLegalEntitiesWithHttpInfoAsync (string successMode, Dictionary< string, UpsertLegalEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities More...
 
LegalEntity UpsertLegalEntity (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0)
 UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity More...
 
Lusid.Sdk.Client.ApiResponse< LegalEntityUpsertLegalEntityWithHttpInfo (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0)
 UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity More...
 
async System.Threading.Tasks.Task< LegalEntityUpsertLegalEntityAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< LegalEntity > > UpsertLegalEntityWithHttpInfoAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity More...
 
ResourceListOfAccessMetadataValueOf UpsertLegalEntityAccessMetadata (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertLegalEntityAccessMetadataRequest upsertLegalEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOfUpsertLegalEntityAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertLegalEntityAccessMetadataRequest upsertLegalEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< ResourceListOfAccessMetadataValueOfUpsertLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertLegalEntityAccessMetadataRequest upsertLegalEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOf > > UpsertLegalEntityAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertLegalEntityAccessMetadataRequest upsertLegalEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ LegalEntitiesApi() [1/4]

Lusid.Sdk.Api.LegalEntitiesApi.LegalEntitiesApi ( )
inline

Initializes a new instance of the LegalEntitiesApi class.

Returns

◆ LegalEntitiesApi() [2/4]

Lusid.Sdk.Api.LegalEntitiesApi.LegalEntitiesApi ( string  basePath)
inline

Initializes a new instance of the LegalEntitiesApi class.

Returns

◆ LegalEntitiesApi() [3/4]

Lusid.Sdk.Api.LegalEntitiesApi.LegalEntitiesApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the LegalEntitiesApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ LegalEntitiesApi() [4/4]

Lusid.Sdk.Api.LegalEntitiesApi.LegalEntitiesApi ( Lusid.Sdk.Client.ISynchronousClient  client,
Lusid.Sdk.Client.IAsynchronousClient  asyncClient,
Lusid.Sdk.Client.IReadableConfiguration  configuration 
)
inline

Initializes a new instance of the LegalEntitiesApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ DeleteLegalEntity()

DeletedEntityResponse Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntity ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0 
)
inline

DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the legal entity identifier type.
idTypeCodeThe code of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityAccessMetadataAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry Deletes the Legal Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the legal entity identifier type.
idTypeCodeThe code of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityIdentifiers()

DeletedEntityResponse Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityIdentifiers ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CreditAgency/Identifier&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe 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. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityIdentifiersAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityIdentifiersAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CreditAgency/Identifier&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe 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. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityIdentifiersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityIdentifiersWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CreditAgency/Identifier&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe 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. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityIdentifiersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityIdentifiersWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CreditAgency/Identifier&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe 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. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityProperties()

DeletedEntityResponse Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityProperties ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CompanyDetails/Role&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityPropertiesAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityPropertiesAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CompanyDetails/Role&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityPropertiesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CompanyDetails/Role&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityPropertiesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CompanyDetails/Role&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ DeleteLegalEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0 
)
inline

DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the legal entity identifier type.
idTypeCodeThe code of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ DeleteLegalEntityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.LegalEntitiesApi.DeleteLegalEntityWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

DeleteLegalEntity: Delete Legal Entity Delete a legal entity. Deletion will be valid from the legal entity&#39;s creation datetime. This means that the legal entity will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the legal entity identifier type.
idTypeCodeThe code of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with defined identifier type uniquely identifies the legal entity to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetAllLegalEntityAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.LegalEntitiesApi.GetAllLegalEntityAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetAllLegalEntityAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.LegalEntitiesApi.GetAllLegalEntityAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetAllLegalEntityAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.LegalEntitiesApi.GetAllLegalEntityAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetAllLegalEntityAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.LegalEntitiesApi.GetAllLegalEntityAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.LegalEntitiesApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetLegalEntity()

LegalEntity Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntity ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityAccessMetadataByKey()

List<AccessMetadataValue> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityAccessMetadataByKey ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
List<AccessMetadataValue>

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityAccessMetadataByKeyAsync()

async System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityAccessMetadataByKeyAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of List<AccessMetadataValue>

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityAccessMetadataByKeyWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityAccessMetadataByKeyWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of List<AccessMetadataValue>

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityAccessMetadataByKeyWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityAccessMetadataByKeyWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity Get a specific Legal Entity Access Metadata by specifying the corresponding identifier parts and Legal Entity code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (List<AccessMetadataValue>)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityAsync()

async System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityPropertyTimeSeries ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)
inline

GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. Each property must be from the &quot;LegalEntity&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityPropertyTimeSeriesAsync()

async System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityPropertyTimeSeriesAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. Each property must be from the &quot;LegalEntity&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityPropertyTimeSeriesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityPropertyTimeSeriesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)
inline

GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. Each property must be from the &quot;LegalEntity&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityPropertyTimeSeriesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityPropertyTimeSeriesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. Each property must be from the &quot;LegalEntity&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPropertyInterval)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityRelations()

ResourceListOfRelation Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelations ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfRelation

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityRelationsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelation> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationsAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfRelation

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationships ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity&#39;s identifier type.
idTypeCodeCode of the legal entity&#39;s identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfRelationship

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityRelationshipsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationshipsAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity&#39;s identifier type.
idTypeCodeCode of the legal entity&#39;s identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfRelationship

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityRelationshipsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationshipsWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity&#39;s identifier type.
idTypeCodeCode of the legal entity&#39;s identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfRelationship

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityRelationshipsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationshipsWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity&#39;s identifier type.
idTypeCodeCode of the legal entity&#39;s identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfRelationship)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityRelationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationsWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfRelation

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityRelationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityRelationsWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfRelation)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ GetLegalEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ GetLegalEntityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<LegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.GetLegalEntityWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for found legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the legal entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (LegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ ListAllLegalEntities()

ResourceListOfLegalEntity Lusid.Sdk.Api.LegalEntitiesApi.ListAllLegalEntities ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ ListAllLegalEntitiesAsync()

async System.Threading.Tasks.Task<ResourceListOfLegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.ListAllLegalEntitiesAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ ListAllLegalEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfLegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.ListAllLegalEntitiesWithHttpInfo ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ ListAllLegalEntitiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfLegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.ListAllLegalEntitiesWithHttpInfoAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfLegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ ListLegalEntities()

PagedResourceListOfLegalEntity Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntities ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ ListLegalEntitiesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfLegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntitiesAsync ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ ListLegalEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfLegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntitiesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfLegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ ListLegalEntitiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfLegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.ListLegalEntitiesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List<string>?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing legal entities from a previous call to list legal entities. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys or identifier types (as property keys) from the &quot;LegalEntity&quot; domain to include for each legal entity, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto each portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfLegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ PatchLegalEntityAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.LegalEntitiesApi.PatchLegalEntityAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ PatchLegalEntityAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.LegalEntitiesApi.PatchLegalEntityAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ PatchLegalEntityAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.LegalEntitiesApi.PatchLegalEntityAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ PatchLegalEntityAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.LegalEntitiesApi.PatchLegalEntityAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity. Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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 Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ SetLegalEntityIdentifiers()

LegalEntity Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityIdentifiers ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityIdentifiersRequest  setLegalEntityIdentifiersRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityIdentifiersRequestRequest containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ SetLegalEntityIdentifiersAsync()

async System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityIdentifiersAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityIdentifiersRequest  setLegalEntityIdentifiersRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityIdentifiersRequestRequest containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ SetLegalEntityIdentifiersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityIdentifiersWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityIdentifiersRequest  setLegalEntityIdentifiersRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityIdentifiersRequestRequest containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
ApiResponse of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ SetLegalEntityIdentifiersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<LegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityIdentifiersWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityIdentifiersRequest  setLegalEntityIdentifiersRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityIdentifiersRequestRequest containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (LegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ SetLegalEntityProperties()

LegalEntity Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityProperties ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityPropertiesRequest  setLegalEntityPropertiesRequest,
int  operationIndex = 0 
)
inline

SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityPropertiesRequestRequest containing properties to set for the legal entity. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ SetLegalEntityPropertiesAsync()

async System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityPropertiesAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityPropertiesRequest  setLegalEntityPropertiesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityPropertiesRequestRequest containing properties to set for the legal entity. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ SetLegalEntityPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityPropertiesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityPropertiesRequest  setLegalEntityPropertiesRequest,
int  operationIndex = 0 
)
inline

SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityPropertiesRequestRequest containing properties to set for the legal entity. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
ApiResponse of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ SetLegalEntityPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<LegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.SetLegalEntityPropertiesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetLegalEntityPropertiesRequest  setLegalEntityPropertiesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
setLegalEntityPropertiesRequestRequest containing properties to set for the legal entity. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (LegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntities()

UpsertLegalEntitiesResponse Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntities ( string  successMode,
Dictionary< string, UpsertLegalEntityRequest requestBody,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Legal Entities.
operationIndexIndex associated with the operation.
Returns
UpsertLegalEntitiesResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntitiesAsync()

async System.Threading.Tasks.Task<UpsertLegalEntitiesResponse> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntitiesAsync ( string  successMode,
Dictionary< string, UpsertLegalEntityRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Legal Entities.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertLegalEntitiesResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertLegalEntitiesResponse> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntitiesWithHttpInfo ( string  successMode,
Dictionary< string, UpsertLegalEntityRequest requestBody,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Legal Entities.
operationIndexIndex associated with the operation.
Returns
ApiResponse of UpsertLegalEntitiesResponse

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntitiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertLegalEntitiesResponse> > Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntitiesWithHttpInfoAsync ( string  successMode,
Dictionary< string, UpsertLegalEntityRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Legal Entities.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertLegalEntitiesResponse)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntity()

LegalEntity Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntity ( UpsertLegalEntityRequest  upsertLegalEntityRequest,
int  operationIndex = 0 
)
inline

UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertLegalEntityRequestRequest to create or update a legal entity.
operationIndexIndex associated with the operation.
Returns
LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntityAccessMetadata()

ResourceListOfAccessMetadataValueOf Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertLegalEntityAccessMetadataRequest  upsertLegalEntityAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertLegalEntityAccessMetadataRequestThe Legal Entity Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntityAccessMetadataAsync()

async System.Threading.Tasks.Task<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertLegalEntityAccessMetadataRequest  upsertLegalEntityAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertLegalEntityAccessMetadataRequestThe Legal Entity Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntityAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertLegalEntityAccessMetadataRequest  upsertLegalEntityAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertLegalEntityAccessMetadataRequestThe Legal Entity Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntityAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> > Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertLegalEntityAccessMetadataRequest  upsertLegalEntityAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Legal Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Legal Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the Legal Entity identifier.
idTypeCodeCode of the Legal Entity identifier.
codeCode of the Legal Entity under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertLegalEntityAccessMetadataRequestThe Legal Entity Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAccessMetadataValueOf)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntityAsync()

async System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityAsync ( UpsertLegalEntityRequest  upsertLegalEntityRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertLegalEntityRequestRequest to create or update a legal entity.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

◆ UpsertLegalEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<LegalEntity> Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityWithHttpInfo ( UpsertLegalEntityRequest  upsertLegalEntityRequest,
int  operationIndex = 0 
)
inline

UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertLegalEntityRequestRequest to create or update a legal entity.
operationIndexIndex associated with the operation.
Returns
ApiResponse of LegalEntity

Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.

◆ UpsertLegalEntityWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<LegalEntity> > Lusid.Sdk.Api.LegalEntitiesApi.UpsertLegalEntityWithHttpInfoAsync ( UpsertLegalEntityRequest  upsertLegalEntityRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertLegalEntityRequestRequest to create or update a legal entity.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (LegalEntity)

Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.LegalEntitiesApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.LegalEntitiesApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.LegalEntitiesApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.LegalEntitiesApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: