Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IScopesApiSync:
Public Member Functions | |
| ResourceListOfScopeDefinition | ListEntityScopes (string entityType, int operationIndex=0) |
| ListEntityScopes: List Entity Scopes More... | |
| ApiResponse< ResourceListOfScopeDefinition > | ListEntityScopesWithHttpInfo (string entityType, int operationIndex=0) |
| ListEntityScopes: List Entity Scopes More... | |
| ResourceListOfScopeDefinition | ListScopes (string? filter=default(string?), int operationIndex=0) |
| ListScopes: List Scopes More... | |
| ApiResponse< ResourceListOfScopeDefinition > | ListScopesWithHttpInfo (string? filter=default(string?), int operationIndex=0) |
| 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
◆ ListEntityScopes()
| ResourceListOfScopeDefinition Lusid.Sdk.Api.IScopesApiSync.ListEntityScopes | ( | string | entityType, |
| int | operationIndex = 0 |
||
| ) |
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.
- Returns
- ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListEntityScopesWithHttpInfo()
| ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiSync.ListEntityScopesWithHttpInfo | ( | string | entityType, |
| int | operationIndex = 0 |
||
| ) |
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.
- Returns
- ApiResponse of ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListScopes()
| ResourceListOfScopeDefinition Lusid.Sdk.Api.IScopesApiSync.ListScopes | ( | string? | filter = default(string?), |
| int | operationIndex = 0 |
||
| ) |
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.
- Returns
- ResourceListOfScopeDefinition
Implemented in Lusid.Sdk.Api.ScopesApi.
◆ ListScopesWithHttpInfo()
| ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiSync.ListScopesWithHttpInfo | ( | string? | filter = default(string?), |
| int | operationIndex = 0 |
||
| ) |
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.
- Returns
- ApiResponse of 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
