LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.ILegalEntitiesApiAsync Interface Reference

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

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

Public Member Functions

System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeleteLegalEntity: Delete Legal Entity More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteLegalEntityWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 DeleteLegalEntity: Delete Legal Entity More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityIdentifiersAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteLegalEntityPropertiesAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > GetAllLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity More...
 
System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > GetAllLegalEntityAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity More...
 
System.Threading.Tasks.Task< LegalEntityGetLegalEntityAsync (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntity: Get Legal Entity More...
 
System.Threading.Tasks.Task< ApiResponse< LegalEntity > > GetLegalEntityWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntity: Get Legal Entity More...
 
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 More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< ResourceListOfPropertyIntervalGetLegalEntityPropertyTimeSeriesAsync (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfPropertyInterval > > GetLegalEntityPropertyTimeSeriesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series More...
 
System.Threading.Tasks.Task< ResourceListOfRelationGetLegalEntityRelationsAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelations: Get Relations for Legal Entity More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfRelation > > GetLegalEntityRelationsWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelations: Get Relations for Legal Entity More...
 
System.Threading.Tasks.Task< ResourceListOfRelationshipGetLegalEntityRelationshipsAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelationships: Get Relationships for Legal Entity More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfRelationship > > GetLegalEntityRelationshipsWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetLegalEntityRelationships: Get Relationships for Legal Entity More...
 
System.Threading.Tasks.Task< ResourceListOfLegalEntityListAllLegalEntitiesAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListAllLegalEntities: List Legal Entities More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfLegalEntity > > ListAllLegalEntitiesWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListAllLegalEntities: List Legal Entities More...
 
System.Threading.Tasks.Task< PagedResourceListOfLegalEntityListLegalEntitiesAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListLegalEntities: List Legal Entities More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfLegalEntity > > ListLegalEntitiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListLegalEntities: List Legal Entities More...
 
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. More...
 
System.Threading.Tasks.Task< 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. More...
 
System.Threading.Tasks.Task< LegalEntitySetLegalEntityIdentifiersAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityIdentifiersRequest setLegalEntityIdentifiersRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< LegalEntitySetLegalEntityPropertiesAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 SetLegalEntityProperties: Set Legal Entity Properties More...
 
System.Threading.Tasks.Task< ApiResponse< LegalEntity > > SetLegalEntityPropertiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, SetLegalEntityPropertiesRequest setLegalEntityPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 SetLegalEntityProperties: Set Legal Entity Properties More...
 
System.Threading.Tasks.Task< UpsertLegalEntitiesResponseUpsertLegalEntitiesAsync (string successMode, Dictionary< string, UpsertLegalEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< LegalEntityUpsertLegalEntityAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertLegalEntity: Upsert Legal Entity More...
 
System.Threading.Tasks.Task< ApiResponse< LegalEntity > > UpsertLegalEntityWithHttpInfoAsync (UpsertLegalEntityRequest upsertLegalEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertLegalEntity: Upsert Legal Entity More...
 
System.Threading.Tasks.Task< ResourceListOfAccessMetadataValueOfUpsertLegalEntityAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertLegalEntityAccessMetadataRequest upsertLegalEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...
 
System.Threading.Tasks.Task< 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. More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteLegalEntityAccessMetadataAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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).

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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).

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityAsync()

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

DeleteLegalEntity: Delete Legal Entity

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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityIdentifiersAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CreditAgency/Identifier&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityIdentifiersWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the legal entity identifier type.
idTypeCodeCode of the legal entity identifier type.
codeCode of the legal entity under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the legal entity.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;LegalEntity/CreditAgency/Identifier&quot;. Each property must be from the &quot;LegalEntity&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityPropertiesAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ DeleteLegalEntityWithHttpInfoAsync()

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

DeleteLegalEntity: Delete Legal Entity

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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetAllLegalEntityAccessMetadataAsync()

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

GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity

Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetAllLegalEntityAccessMetadataWithHttpInfoAsync()

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

GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity

Pass the Scope and Code of the Legal Entity identifier along with the Legal Entity code parameter to retrieve the associated Access Metadata

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityAccessMetadataByKeyAsync()

System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityAccessMetadataByKeyWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityAsync()

System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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) 
)

GetLegalEntity: Get Legal Entity

Retrieve the definition of a legal entity.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityPropertyTimeSeriesAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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) 
)

GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series

List the complete time series of a legal entity property.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityPropertyTimeSeriesWithHttpInfoAsync()

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

GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series

List the complete time series of a legal entity property.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityRelationsAsync()

System.Threading.Tasks.Task<ResourceListOfRelation> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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) 
)

GetLegalEntityRelations: Get Relations for Legal Entity

Get relations for the specified Legal Entity

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityRelationshipsAsync()

System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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) 
)

GetLegalEntityRelationships: Get Relationships for Legal Entity

Get Relationships for the specified Legal Entity

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityRelationshipsWithHttpInfoAsync()

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

GetLegalEntityRelationships: Get Relationships for Legal Entity

Get Relationships for the specified Legal Entity

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityRelationsWithHttpInfoAsync()

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

GetLegalEntityRelations: Get Relations for Legal Entity

Get relations for the specified Legal Entity

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ GetLegalEntityWithHttpInfoAsync()

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

GetLegalEntity: Get Legal Entity

Retrieve the definition of a legal entity.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ ListAllLegalEntitiesAsync()

System.Threading.Tasks.Task<ResourceListOfLegalEntity> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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) 
)

ListAllLegalEntities: List Legal Entities

List all legal entities which the user is entitled to see.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ ListAllLegalEntitiesWithHttpInfoAsync()

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

ListAllLegalEntities: List Legal Entities

List all legal entities which the user is entitled to see.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ ListLegalEntitiesAsync()

System.Threading.Tasks.Task<PagedResourceListOfLegalEntity> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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) 
)

ListLegalEntities: List Legal Entities

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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ ListLegalEntitiesWithHttpInfoAsync()

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

ListLegalEntities: List Legal Entities

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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ PatchLegalEntityAccessMetadataAsync()

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

[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity.

Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ PatchLegalEntityAccessMetadataWithHttpInfoAsync()

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

[EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity.

Patch Legal Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Legal Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ SetLegalEntityIdentifiersAsync()

System.Threading.Tasks.Task<LegalEntity> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ SetLegalEntityIdentifiersWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<LegalEntity> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ SetLegalEntityPropertiesAsync()

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

SetLegalEntityProperties: Set Legal Entity Properties

Set properties of the legal entity.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ SetLegalEntityPropertiesWithHttpInfoAsync()

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

SetLegalEntityProperties: Set Legal Entity Properties

Set properties of the legal entity.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntitiesAsync()

System.Threading.Tasks.Task<UpsertLegalEntitiesResponse> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertLegalEntitiesResponse> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntityAccessMetadataAsync()

System.Threading.Tasks.Task<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntityAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfAccessMetadataValueOf> > Lusid.Sdk.Api.ILegalEntitiesApiAsync.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.

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntityAsync()

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

UpsertLegalEntity: Upsert Legal Entity

Create or update a legal entity

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.

◆ UpsertLegalEntityWithHttpInfoAsync()

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

UpsertLegalEntity: Upsert Legal Entity

Create or update a legal entity

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

Implemented in Lusid.Sdk.Api.LegalEntitiesApi.


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