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

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

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

Public Member Functions

System.Threading.Tasks.Task< DeletedEntityResponseDeleteReferenceListAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteReferenceList: Delete Reference List More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteReferenceListWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteReferenceList: Delete Reference List More...
 
System.Threading.Tasks.Task< ReferenceListResponseGetReferenceListAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 GetReferenceList: Get Reference List More...
 
System.Threading.Tasks.Task< ApiResponse< ReferenceListResponse > > GetReferenceListWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 GetReferenceList: Get Reference List More...
 
System.Threading.Tasks.Task< PagedResourceListOfReferenceListResponseListReferenceListsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListReferenceLists: List Reference Lists More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfReferenceListResponse > > ListReferenceListsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListReferenceLists: List Reference Lists More...
 
System.Threading.Tasks.Task< ReferenceListResponseUpsertReferenceListAsync (ReferenceListRequest? referenceListRequest=default(ReferenceListRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertReferenceList: Upsert Reference List More...
 
System.Threading.Tasks.Task< ApiResponse< ReferenceListResponse > > UpsertReferenceListWithHttpInfoAsync (ReferenceListRequest? referenceListRequest=default(ReferenceListRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertReferenceList: Upsert Reference List 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

◆ DeleteReferenceListAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IReferenceListsApiAsync.DeleteReferenceListAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] DeleteReferenceList: Delete Reference List

Delete a Reference List instance.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the Reference List belongs.
codeThe Reference List&#39;s unique identifier.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ DeleteReferenceListWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IReferenceListsApiAsync.DeleteReferenceListWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] DeleteReferenceList: Delete Reference List

Delete a Reference List instance.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the Reference List belongs.
codeThe Reference List&#39;s unique identifier.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ GetReferenceListAsync()

System.Threading.Tasks.Task<ReferenceListResponse> Lusid.Sdk.Api.IReferenceListsApiAsync.GetReferenceListAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

GetReferenceList: Get Reference List

Retrieve a Reference List instance at a point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the Reference List belongs.
codeThe Reference List&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ReferenceListResponse

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ GetReferenceListWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ReferenceListResponse> > Lusid.Sdk.Api.IReferenceListsApiAsync.GetReferenceListWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

GetReferenceList: Get Reference List

Retrieve a Reference List instance at a point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the Reference List belongs.
codeThe Reference List&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the Reference List. Defaults to return the latest version of the Reference List if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ReferenceListResponse)

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ ListReferenceListsAsync()

System.Threading.Tasks.Task<PagedResourceListOfReferenceListResponse> Lusid.Sdk.Api.IReferenceListsApiAsync.ListReferenceListsAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] ListReferenceLists: List Reference Lists

List all the Reference Lists matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified. (optional)
pageThe pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists. This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this number. 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfReferenceListResponse

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ ListReferenceListsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfReferenceListResponse> > Lusid.Sdk.Api.IReferenceListsApiAsync.ListReferenceListsWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] ListReferenceLists: List Reference Lists

List all the Reference Lists matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list Reference Lists. Defaults to return the latest version of Reference Lists if not specified. (optional)
pageThe pagination token to use to continue listing Reference Lists from a previous call to list Reference Lists. This value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this number. 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfReferenceListResponse)

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ UpsertReferenceListAsync()

System.Threading.Tasks.Task<ReferenceListResponse> Lusid.Sdk.Api.IReferenceListsApiAsync.UpsertReferenceListAsync ( ReferenceListRequest referenceListRequest = default(ReferenceListRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpsertReferenceList: Upsert Reference List

Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
referenceListRequestThe payload describing the Reference List instance. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ReferenceListResponse

Implemented in Lusid.Sdk.Api.ReferenceListsApi.

◆ UpsertReferenceListWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ReferenceListResponse> > Lusid.Sdk.Api.IReferenceListsApiAsync.UpsertReferenceListWithHttpInfoAsync ( ReferenceListRequest referenceListRequest = default(ReferenceListRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EARLY ACCESS] UpsertReferenceList: Upsert Reference List

Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
referenceListRequestThe payload describing the Reference List instance. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ReferenceListResponse)

Implemented in Lusid.Sdk.Api.ReferenceListsApi.


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