LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
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) |
[EARLY ACCESS] 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< DeletedEntityResponse > | DeleteLegalEntityWithHttpInfo (string idTypeScope, string idTypeCode, string code, int operationIndex=0) |
[EARLY ACCESS] 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... | |
async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteLegalEntityAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] 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... | |
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)) |
[EARLY ACCESS] 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... | |
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< DeletedEntityResponse > | DeleteLegalEntityAccessMetadataWithHttpInfo (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< DeletedEntityResponse > | 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)) |
[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< DeletedEntityResponse > | DeleteLegalEntityIdentifiersWithHttpInfo (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< DeletedEntityResponse > | 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)) |
[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< DeletedEntityResponse > | DeleteLegalEntityPropertiesWithHttpInfo (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< DeletedEntityResponse > | 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)) |
[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) |
[EARLY ACCESS] 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) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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) |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More... | |
Lusid.Sdk.Client.ApiResponse< LegalEntity > | 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) |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More... | |
async System.Threading.Tasks.Task< LegalEntity > | 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)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity. More... | |
List< AccessMetadataValue > | GetLegalEntityAccessMetadataByKey (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) |
[EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > | 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) |
[EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property. More... | |
async System.Threading.Tasks.Task< ResourceListOfPropertyInterval > | 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)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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) |
[EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelation > | 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) |
[EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity More... | |
async System.Threading.Tasks.Task< ResourceListOfRelation > | 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)) |
[EXPERIMENTAL] 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)) |
[EXPERIMENTAL] 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) |
[EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > | 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) |
[EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity More... | |
async System.Threading.Tasks.Task< ResourceListOfRelationship > | 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)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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) |
[EARLY ACCESS] ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfLegalEntity > | 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) |
[EARLY ACCESS] ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see. More... | |
async System.Threading.Tasks.Task< ResourceListOfLegalEntity > | 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)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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) |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfLegalEntity > | 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) |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria. More... | |
async System.Threading.Tasks.Task< PagedResourceListOfLegalEntity > | 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)) |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type'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)) |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type'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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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< LegalEntity > | SetLegalEntityIdentifiersWithHttpInfo (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< LegalEntity > | SetLegalEntityIdentifiersAsync (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) |
[EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity. More... | |
Lusid.Sdk.Client.ApiResponse< LegalEntity > | SetLegalEntityPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0) |
[EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity. More... | |
async System.Threading.Tasks.Task< LegalEntity > | SetLegalEntityPropertiesAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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< UpsertLegalEntitiesResponse > | UpsertLegalEntitiesWithHttpInfo (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< UpsertLegalEntitiesResponse > | UpsertLegalEntitiesAsync (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) |
[EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity More... | |
Lusid.Sdk.Client.ApiResponse< LegalEntity > | UpsertLegalEntityWithHttpInfo (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0) |
[EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity More... | |
async System.Threading.Tasks.Task< LegalEntity > | UpsertLegalEntityAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] 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)) |
[EARLY ACCESS] 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< ResourceListOfAccessMetadataValueOf > | UpsertLegalEntityAccessMetadataWithHttpInfo (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< ResourceListOfAccessMetadataValueOf > | 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)) |
[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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the LegalEntitiesApi class.
|
inline |
Initializes a new instance of the LegalEntitiesApi class.
|
inline |
Initializes a new instance of the LegalEntitiesApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the LegalEntitiesApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
[EARLY ACCESS] 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | The scope of the legal entity identifier type. |
idTypeCode | The code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effective date to delete at, if this is not supplied, it will delete all data found (optional) |
effectiveUntil | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effective date to delete at, if this is not supplied, it will delete all data found (optional) |
effectiveUntil | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
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).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effective date to delete at, if this is not supplied, it will delete all data found (optional) |
effectiveUntil | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effective date to delete at, if this is not supplied, it will delete all data found (optional) |
effectiveUntil | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | The scope of the legal entity identifier type. |
idTypeCode | The code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CreditAgency/Identifier". Each property must be from the "LegalEntity" domain. Identifiers or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CreditAgency/Identifier". Each property must be from the "LegalEntity" domain. Identifiers or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CreditAgency/Identifier". Each property must be from the "LegalEntity" domain. Identifiers or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers Delete identifiers that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CreditAgency/Identifier". Each property must be from the "LegalEntity" domain. Identifiers or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CompanyDetails/Role". Each property must be from the "LegalEntity" domain. Properties or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CompanyDetails/Role". Each property must be from the "LegalEntity" domain. Properties or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CompanyDetails/Role". Each property must be from the "LegalEntity" domain. Properties or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties Delete all properties that belong to the given property keys of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | The property keys of the legal entities properties to delete. These take the format {domain}/{scope}/{code} e.g. "LegalEntity/CompanyDetails/Role". Each property must be from the "LegalEntity" domain. Properties or identifiers not specified in request will not be changed. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | The scope of the legal entity identifier type. |
idTypeCode | The code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | The scope of the legal entity identifier type. |
idTypeCode | The code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with defined identifier type uniquely identifies the legal entity to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] 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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] 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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] 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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] 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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
|
inline |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
effectiveAt | The effectiveAt datetime at which to retrieve the Access Metadata (optional) |
asAt | The asAt datetime at which to retrieve the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKey | The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". Each property must be from the "LegalEntity" domain. |
asAt | The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
page | The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKey | The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". Each property must be from the "LegalEntity" domain. |
asAt | The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
page | The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKey | The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". Each property must be from the "LegalEntity" domain. |
asAt | The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
page | The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series List the complete time series of a legal entity property.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKey | The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "LegalEntity/ContactDetails/Address". Each property must be from the "LegalEntity" domain. |
asAt | The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
page | The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity's relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity's relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity's identifier type. |
idTypeCode | Code of the legal entity's identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity's identifier type. |
idTypeCode | Code of the legal entity's identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity's identifier type. |
idTypeCode | Code of the legal entity's identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] GetLegalEntityRelationships: Get Relationships for Legal Entity Get Relationships for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity's identifier type. |
idTypeCode | Code of the legal entity's identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity's relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EXPERIMENTAL] GetLegalEntityRelations: Get Relations for Legal Entity Get relations for the specified Legal Entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
effectiveAt | The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity's relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) |
identifierTypes | Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] GetLegalEntity: Get Legal Entity Retrieve the definition of a legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
effectiveAt | The effective datetime or cut label at which to retrieve the legal entity. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the legal entity. Defaults to return the latest version of the legal entity if not specified. (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] ListAllLegalEntities: List Legal Entities List all legal entities which the user is entitled to see.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to list the legal entities. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the legal entities. Defaults to return the latest version of each legal entities if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
effectiveAt | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
effectiveAt | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
effectiveAt | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] ListLegalEntities: List Legal Entities List legal entities which has identifier of specific identifier type's scope and code, and satisfies filter criteria.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
effectiveAt | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys or identifier types (as property keys) from the "LegalEntity" 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. "LegalEntity/ContactDetails/Address". (optional) |
relationshipDefinitionIds | A 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) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
accessMetadataOperation | The Json Patch document |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
accessMetadataOperation | The Json Patch document |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
accessMetadataOperation | The Json Patch document |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected 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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
accessMetadataOperation | The Json Patch document |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityIdentifiersRequest | Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityIdentifiersRequest | Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityIdentifiersRequest | Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers Set identifiers of the Legal Entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityIdentifiersRequest | Request containing identifiers to set for the legal entity. Identifiers not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityPropertiesRequest | Request containing properties to set for the legal entity. Properties not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityPropertiesRequest | Request containing properties to set for the legal entity. Properties not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityPropertiesRequest | Request containing properties to set for the legal entity. Properties not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] SetLegalEntityProperties: Set Legal Entity Properties Set properties of the legal entity.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the legal entity identifier type. |
idTypeCode | Code of the legal entity identifier type. |
code | Code of the legal entity under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the legal entity. |
setLegalEntityPropertiesRequest | Request containing properties to set for the legal entity. Properties not specified in request will not be changed. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial |
requestBody | A collection of requests to create or update Legal Entities. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial |
requestBody | A collection of requests to create or update Legal Entities. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial |
requestBody | A collection of requests to create or update Legal Entities. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities Creates or updates a collection of Legal Entities
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
successMode | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial |
requestBody | A collection of requests to create or update Legal Entities. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertLegalEntityRequest | Request to create or update a legal entity. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
upsertLegalEntityAccessMetadataRequest | The Legal Entity Access Metadata entry to upsert |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
upsertLegalEntityAccessMetadataRequest | The Legal Entity Access Metadata entry to upsert |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
upsertLegalEntityAccessMetadataRequest | The Legal Entity Access Metadata entry to upsert |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
idTypeScope | Scope of the Legal Entity identifier. |
idTypeCode | Code of the Legal Entity identifier. |
code | Code of the Legal Entity under specified identifier type's scope and code. |
metadataKey | Key of the metadata entry to retrieve |
upsertLegalEntityAccessMetadataRequest | The Legal Entity Access Metadata entry to upsert |
effectiveAt | The effectiveAt datetime at which to upsert the Access Metadata (optional) |
effectiveUntil | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertLegalEntityRequest | Request to create or update a legal entity. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
inline |
[EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertLegalEntityRequest | Request to create or update a legal entity. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiSync.
|
inline |
[EARLY ACCESS] UpsertLegalEntity: Upsert Legal Entity Create or update a legal entity
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
upsertLegalEntityRequest | Request to create or update a legal entity. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.ILegalEntitiesApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.