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

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

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

Public Member Functions

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 More...
 
ApiResponse< ResourceListOfScopeDefinitionListEntityScopesWithHttpInfo (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
 ListEntityScopes: List Entity Scopes More...
 
ResourceListOfScopeDefinition ListScopes (string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 ListScopes: List Scopes More...
 
ApiResponse< ResourceListOfScopeDefinitionListScopesWithHttpInfo (string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 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,
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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type to list scopes for.
asAtThe asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfScopeDefinition

Implemented in Lusid.Sdk.Api.ScopesApi.

◆ ListEntityScopesWithHttpInfo()

ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityTypeThe entity type to list scopes for.
asAtThe asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this number. Defaults to 100 if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfScopeDefinition

Implemented in Lusid.Sdk.Api.ScopesApi.

◆ ListScopes()

ResourceListOfScopeDefinition Lusid.Sdk.Api.IScopesApiSync.ListScopes ( string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

ListScopes: List Scopes

List all the scopes that contain data.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
filterExpression to filter the result set. For example, to filter on the Scope, use &quot;scope eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfScopeDefinition

Implemented in Lusid.Sdk.Api.ScopesApi.

◆ ListScopesWithHttpInfo()

ApiResponse<ResourceListOfScopeDefinition> Lusid.Sdk.Api.IScopesApiSync.ListScopesWithHttpInfo ( string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

ListScopes: List Scopes

List all the scopes that contain data.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
filterExpression to filter the result set. For example, to filter on the Scope, use &quot;scope eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfScopeDefinition

Implemented in Lusid.Sdk.Api.ScopesApi.


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