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, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| ListEntityScopes: List Entity Scopes More... | |
| System.Threading.Tasks.Task< ApiResponse< ResourceListOfScopeDefinition > > | ListEntityScopesWithHttpInfoAsync (string entityType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| 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)) |
| ListScopes: List Scopes More... | |
| System.Threading.Tasks.Task< ApiResponse< ResourceListOfScopeDefinition > > | ListScopesWithHttpInfoAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| ListScopes: List Scopes 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
◆ ListEntityScopesAsync()
| System.Threading.Tasks.Task<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiAsync.ListEntityScopesAsync | ( | string | entityType, |
| int | operationIndex = 0, |
||
| System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken) |
||
| ) |
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. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListEntityScopesWithHttpInfoAsync()
| System.Threading.Tasks.Task<ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.IScopesApiAsync.ListEntityScopesWithHttpInfoAsync | ( | string | entityType, |
| int | operationIndex = 0, |
||
| System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken) |
||
| ) |
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. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the 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) |
||
| ) |
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.
- Returns
- Task of ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListScopesWithHttpInfoAsync()
| System.Threading.Tasks.Task<ApiResponse<ResourceListOfScopeDefinition> > Lusid.Sdk.Api.IScopesApiAsync.ListScopesWithHttpInfoAsync | ( | string? | filter = default(string?), |
| int | operationIndex = 0, |
||
| System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken) |
||
| ) |
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.
- 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
