LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
ScopesApi () | |
Initializes a new instance of the ScopesApi class. More... | |
ScopesApi (string basePath) | |
Initializes a new instance of the ScopesApi class. More... | |
ScopesApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the ScopesApi class using Configuration object More... | |
ScopesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the ScopesApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
ResourceListOfScopeDefinition | ListEntityScopes (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null) |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > | ListEntityScopesWithHttpInfo (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null) |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More... | |
async System.Threading.Tasks.Task< ResourceListOfScopeDefinition > | ListEntityScopesAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > > | ListEntityScopesWithHttpInfoAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data. More... | |
ResourceListOfScopeDefinition | ListScopes (string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
ListScopes: List Scopes List all the scopes that contain data. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > | ListScopesWithHttpInfo (string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
ListScopes: List Scopes List all the scopes that contain data. More... | |
async System.Threading.Tasks.Task< ResourceListOfScopeDefinition > | ListScopesAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
ListScopes: List Scopes List all the scopes that contain data. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfScopeDefinition > > | ListScopesWithHttpInfoAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
ListScopes: List Scopes List all the scopes that contain data. More... | |
Properties | |
Lusid.Sdk.Client.IAsynchronousClient | AsynchronousClient [get, set] |
The client for accessing this underlying API asynchronously. More... | |
Lusid.Sdk.Client.ISynchronousClient | Client [get, set] |
The client for accessing this underlying API synchronously. More... | |
Lusid.Sdk.Client.IReadableConfiguration | Configuration [get, set] |
Gets or sets the configuration object More... | |
Lusid.Sdk.Client.ExceptionFactory | ExceptionFactory [get, set] |
Provides a factory method hook for the creation of exceptions. More... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the ScopesApi class.
|
inline |
Initializes a new instance of the ScopesApi class.
|
inline |
Initializes a new instance of the ScopesApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the ScopesApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
Gets the base path of the API client.
The base path
|
inline |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
entityType | The entity type to list scopes for. |
asAt | The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. (optional) |
page | The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiSync.
|
inline |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
entityType | The entity type to list scopes for. |
asAt | The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. (optional) |
page | The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiAsync.
|
inline |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
entityType | The entity type to list scopes for. |
asAt | The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. (optional) |
page | The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiSync.
|
inline |
ListEntityScopes: List Entity Scopes List all the scopes for a given entity type that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
entityType | The entity type to list scopes for. |
asAt | The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. (optional) |
page | The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiAsync.
|
inline |
ListScopes: List Scopes List all the scopes that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
filter | Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiSync.
|
inline |
ListScopes: List Scopes List all the scopes that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
filter | Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiAsync.
|
inline |
ListScopes: List Scopes List all the scopes that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
filter | Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiSync.
|
inline |
ListScopes: List Scopes List all the scopes that contain data.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
filter | Expression to filter the result set. For example, to filter on the Scope, use "scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IScopesApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.