Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IScopesApiAsync:
Public Member Functions | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
| 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 More... | |
Detailed Description
Represents a collection of functions to interact with the API endpoints
Member Function Documentation
◆ ListEntityScopesAsync()
| System.Threading.Tasks.Task<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiAsync.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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
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.
- Returns
- Task of ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListEntityScopesWithHttpInfoAsync()
| System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.IScopesApiAsync.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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
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.
- Returns
- Task of ApiResponse (ResourceListOfScopeDefinition)
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListScopesAsync()
| System.Threading.Tasks.Task<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiAsync.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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
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.
- Returns
- Task of ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListScopesWithHttpInfoAsync()
| System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.IScopesApiAsync.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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
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.
- Returns
- Task of ApiResponse (ResourceListOfScopeDefinition)
Implemented in Lusid.Sdk.Api.ScopesApi.
The documentation for this interface was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/ScopesApi.cs
