LUSID C# SDK
List of all members
Lusid.Sdk.Api.ICustomEntitiesApi Interface Reference

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

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

Additional Inherited Members

- Public Member Functions inherited from Lusid.Sdk.Api.ICustomEntitiesApiSync
DeletedEntityResponse DeleteCustomEntity (string entityType, string identifierType, string identifierValue, string identifierScope, int operationIndex=0)
 [EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. More...
 
ApiResponse< DeletedEntityResponseDeleteCustomEntityWithHttpInfo (string entityType, string identifierType, string identifierValue, string identifierScope, int operationIndex=0)
 [EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. More...
 
DeletedEntityResponse DeleteCustomEntityAccessMetadata (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry More...
 
ApiResponse< DeletedEntityResponseDeleteCustomEntityAccessMetadataWithHttpInfo (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry More...
 
Dictionary< string, List< AccessMetadataValue > > GetAllCustomEntityAccessMetadata (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity More...
 
ApiResponse< Dictionary< string, List< AccessMetadataValue > > > GetAllCustomEntityAccessMetadataWithHttpInfo (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity More...
 
CustomEntityResponse GetCustomEntity (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 GetCustomEntity: Get a Custom Entity instance. More...
 
ApiResponse< CustomEntityResponseGetCustomEntityWithHttpInfo (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 GetCustomEntity: Get a Custom Entity instance. More...
 
List< AccessMetadataValueGetCustomEntityAccessMetadataByKey (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity More...
 
ApiResponse< List< AccessMetadataValue > > GetCustomEntityAccessMetadataByKeyWithHttpInfo (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity More...
 
ResourceListOfRelationship GetCustomEntityRelationships (string entityType, string identifierScope, string identifierType, string identifierValue, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity More...
 
ApiResponse< ResourceListOfRelationshipGetCustomEntityRelationshipsWithHttpInfo (string entityType, string identifierScope, string identifierType, string identifierValue, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity More...
 
PagedResourceListOfCustomEntityResponse ListCustomEntities (string entityType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListCustomEntities: List Custom Entities of the specified entityType. More...
 
ApiResponse< PagedResourceListOfCustomEntityResponseListCustomEntitiesWithHttpInfo (string entityType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListCustomEntities: List Custom Entities of the specified entityType. More...
 
Dictionary< string, List< AccessMetadataValue > > PatchCustomEntityAccessMetadata (string entityType, string identifierType, string identifierValue, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. More...
 
ApiResponse< Dictionary< string, List< AccessMetadataValue > > > PatchCustomEntityAccessMetadataWithHttpInfo (string entityType, string identifierType, string identifierValue, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. More...
 
UpsertCustomEntitiesResponse UpsertCustomEntities (string entityType, string successMode, Dictionary< string, CustomEntityRequest > requestBody, int operationIndex=0)
 [EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities More...
 
ApiResponse< UpsertCustomEntitiesResponseUpsertCustomEntitiesWithHttpInfo (string entityType, string successMode, Dictionary< string, CustomEntityRequest > requestBody, int operationIndex=0)
 [EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities More...
 
CustomEntityResponse UpsertCustomEntity (string entityType, CustomEntityRequest customEntityRequest, int operationIndex=0)
 UpsertCustomEntity: Upsert a Custom Entity instance More...
 
ApiResponse< CustomEntityResponseUpsertCustomEntityWithHttpInfo (string entityType, CustomEntityRequest customEntityRequest, int operationIndex=0)
 UpsertCustomEntity: Upsert a Custom Entity instance More...
 
List< AccessMetadataValueUpsertCustomEntityAccessMetadata (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, UpsertCustomEntityAccessMetadataRequest upsertCustomEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...
 
ApiResponse< List< AccessMetadataValue > > UpsertCustomEntityAccessMetadataWithHttpInfo (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, UpsertCustomEntityAccessMetadataRequest upsertCustomEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom 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...
 
- Public Member Functions inherited from Lusid.Sdk.Api.ICustomEntitiesApiAsync
System.Threading.Tasks.Task< DeletedEntityResponseDeleteCustomEntityAsync (string entityType, string identifierType, string identifierValue, string identifierScope, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteCustomEntityWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteCustomEntity: Delete a Custom Entity instance. More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry More...
 
System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > GetAllCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity More...
 
System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > GetAllCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity More...
 
System.Threading.Tasks.Task< CustomEntityResponseGetCustomEntityAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetCustomEntity: Get a Custom Entity instance. More...
 
System.Threading.Tasks.Task< ApiResponse< CustomEntityResponse > > GetCustomEntityWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetCustomEntity: Get a Custom Entity instance. More...
 
System.Threading.Tasks.Task< List< AccessMetadataValue > > GetCustomEntityAccessMetadataByKeyAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity More...
 
System.Threading.Tasks.Task< ApiResponse< List< AccessMetadataValue > > > GetCustomEntityAccessMetadataByKeyWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity More...
 
System.Threading.Tasks.Task< ResourceListOfRelationshipGetCustomEntityRelationshipsAsync (string entityType, string identifierScope, string identifierType, string identifierValue, 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] GetCustomEntityRelationships: Get Relationships for Custom Entity More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfRelationship > > GetCustomEntityRelationshipsWithHttpInfoAsync (string entityType, string identifierScope, string identifierType, string identifierValue, 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] GetCustomEntityRelationships: Get Relationships for Custom Entity More...
 
System.Threading.Tasks.Task< PagedResourceListOfCustomEntityResponseListCustomEntitiesAsync (string entityType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListCustomEntities: List Custom Entities of the specified entityType. More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCustomEntityResponse > > ListCustomEntitiesWithHttpInfoAsync (string entityType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? page=default(string?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListCustomEntities: List Custom Entities of the specified entityType. More...
 
System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > PatchCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. More...
 
System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > PatchCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string identifierScope, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. More...
 
System.Threading.Tasks.Task< UpsertCustomEntitiesResponseUpsertCustomEntitiesAsync (string entityType, string successMode, Dictionary< string, CustomEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertCustomEntitiesResponse > > UpsertCustomEntitiesWithHttpInfoAsync (string entityType, string successMode, Dictionary< string, CustomEntityRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities More...
 
System.Threading.Tasks.Task< CustomEntityResponseUpsertCustomEntityAsync (string entityType, CustomEntityRequest customEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertCustomEntity: Upsert a Custom Entity instance More...
 
System.Threading.Tasks.Task< ApiResponse< CustomEntityResponse > > UpsertCustomEntityWithHttpInfoAsync (string entityType, CustomEntityRequest customEntityRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertCustomEntity: Upsert a Custom Entity instance More...
 
System.Threading.Tasks.Task< List< AccessMetadataValue > > UpsertCustomEntityAccessMetadataAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, UpsertCustomEntityAccessMetadataRequest upsertCustomEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...
 
System.Threading.Tasks.Task< ApiResponse< List< AccessMetadataValue > > > UpsertCustomEntityAccessMetadataWithHttpInfoAsync (string entityType, string identifierType, string identifierValue, string metadataKey, string identifierScope, UpsertCustomEntityAccessMetadataRequest upsertCustomEntityAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...
 
- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints


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