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

Inheritance diagram for Lusid.Sdk.Api.SchemasApi:

[legend]

Public Member Functions
	SchemasApi ()
	Initializes a new instance of the SchemasApi class. More...

	SchemasApi (string basePath)
	Initializes a new instance of the SchemasApi class. More...

	SchemasApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the SchemasApi class using Configuration object More...

	SchemasApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the SchemasApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

Schema	GetEntitySchema (string entity, int operationIndex=0)
	[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity More...

Lusid.Sdk.Client.ApiResponse< Schema >	GetEntitySchemaWithHttpInfo (string entity, int operationIndex=0)
	[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity More...

async System.Threading.Tasks.Task< Schema >	GetEntitySchemaAsync (string entity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Schema > >	GetEntitySchemaWithHttpInfoAsync (string entity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity More...

PropertySchema	GetPropertySchema (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys. More...

Lusid.Sdk.Client.ApiResponse< PropertySchema >	GetPropertySchemaWithHttpInfo (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys. More...

async System.Threading.Tasks.Task< PropertySchema >	GetPropertySchemaAsync (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PropertySchema > >	GetPropertySchemaWithHttpInfoAsync (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys. More...

ResourceListOfValueType	GetValueTypes (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0)
	[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfValueType >	GetValueTypesWithHttpInfo (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0)
	[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available. More...

async System.Threading.Tasks.Task< ResourceListOfValueType >	GetValueTypesAsync (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfValueType > >	GetValueTypesWithHttpInfoAsync (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available. More...

ResourceListOfString	ListEntities (int operationIndex=0)
	[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfString >	ListEntitiesWithHttpInfo (int operationIndex=0)
	[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available. More...

async System.Threading.Tasks.Task< ResourceListOfString >	ListEntitiesAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfString > >	ListEntitiesWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available. 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...

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

Constructor & Destructor Documentation

◆ SchemasApi() [1/4]

Lusid.Sdk.Api.SchemasApi.SchemasApi ( )

inline

Initializes a new instance of the SchemasApi class.

Returns

◆ SchemasApi() [2/4]

Lusid.Sdk.Api.SchemasApi.SchemasApi ( string basePath )

inline

Initializes a new instance of the SchemasApi class.

Returns

◆ SchemasApi() [3/4]

Lusid.Sdk.Api.SchemasApi.SchemasApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the SchemasApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ SchemasApi() [4/4]

Lusid.Sdk.Api.SchemasApi.SchemasApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the SchemasApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ GetBasePath()

string Lusid.Sdk.Api.SchemasApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetEntitySchema()

Schema Lusid.Sdk.Api.SchemasApi.GetEntitySchema	(	string	entity,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entity	The name of a valid entity
operationIndex	Index associated with the operation.

Returns: Schema

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ GetEntitySchemaAsync()

async System.Threading.Tasks.Task<Schema> Lusid.Sdk.Api.SchemasApi.GetEntitySchemaAsync	(	string	entity,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entity	The name of a valid entity
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Schema

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ GetEntitySchemaWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Schema> Lusid.Sdk.Api.SchemasApi.GetEntitySchemaWithHttpInfo	(	string	entity,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entity	The name of a valid entity
operationIndex	Index associated with the operation.

Returns: ApiResponse of Schema

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ GetEntitySchemaWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Schema> > Lusid.Sdk.Api.SchemasApi.GetEntitySchemaWithHttpInfoAsync	(	string	entity,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetEntitySchema: Get schema Gets the schema and meta-data for a given entity

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entity	The name of a valid entity
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Schema)

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ GetPropertySchema()

PropertySchema Lusid.Sdk.Api.SchemasApi.GetPropertySchema	(	List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

propertyKeys	One or more property keys for which the schema is requested (optional)
asAt	Optional. The AsAt date of the data (optional)
operationIndex	Index associated with the operation.

Returns: PropertySchema

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ GetPropertySchemaAsync()

async System.Threading.Tasks.Task<PropertySchema> Lusid.Sdk.Api.SchemasApi.GetPropertySchemaAsync	(	List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

propertyKeys	One or more property keys for which the schema is requested (optional)
asAt	Optional. The AsAt date of the data (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PropertySchema

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ GetPropertySchemaWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertySchema> Lusid.Sdk.Api.SchemasApi.GetPropertySchemaWithHttpInfo	(	List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

propertyKeys	One or more property keys for which the schema is requested (optional)
asAt	Optional. The AsAt date of the data (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PropertySchema

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ GetPropertySchemaWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PropertySchema> > Lusid.Sdk.Api.SchemasApi.GetPropertySchemaWithHttpInfoAsync	(	List< string >?	propertyKeys = `default(List<string>?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetPropertySchema: Get property schema Get the schemas for the provided list of property keys.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

propertyKeys	One or more property keys for which the schema is requested (optional)
asAt	Optional. The AsAt date of the data (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PropertySchema)

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ GetValueTypes()

ResourceListOfValueType Lusid.Sdk.Api.SchemasApi.GetValueTypes	(	List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfValueType

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ GetValueTypesAsync()

async System.Threading.Tasks.Task<ResourceListOfValueType> Lusid.Sdk.Api.SchemasApi.GetValueTypesAsync	(	List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfValueType

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ GetValueTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfValueType> Lusid.Sdk.Api.SchemasApi.GetValueTypesWithHttpInfo	(	List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfValueType

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ GetValueTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfValueType> > Lusid.Sdk.Api.SchemasApi.GetValueTypesWithHttpInfoAsync	(	List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetValueTypes: Get value types Gets the available value types for which a schema is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfValueType)

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ ListEntities()

ResourceListOfString Lusid.Sdk.Api.SchemasApi.ListEntities ( int operationIndex = 0 )

inline

[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex Index associated with the operation.

Returns: ResourceListOfString

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ ListEntitiesAsync()

async System.Threading.Tasks.Task<ResourceListOfString> Lusid.Sdk.Api.SchemasApi.ListEntitiesAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfString

Implements Lusid.Sdk.Api.ISchemasApiAsync.

◆ ListEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfString> Lusid.Sdk.Api.SchemasApi.ListEntitiesWithHttpInfo ( int operationIndex = 0 )

inline

[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex Index associated with the operation.

Returns: ApiResponse of ResourceListOfString

Implements Lusid.Sdk.Api.ISchemasApiSync.

◆ ListEntitiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfString> > Lusid.Sdk.Api.SchemasApi.ListEntitiesWithHttpInfoAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListEntities: List entities List all available entities for which schema information is available.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfString)

Implements Lusid.Sdk.Api.ISchemasApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.SchemasApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.SchemasApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.SchemasApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.SchemasApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/SchemasApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SchemasApi() [1/4]

◆ SchemasApi() [2/4]

◆ SchemasApi() [3/4]

◆ SchemasApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ GetEntitySchema()

◆ GetEntitySchemaAsync()

◆ GetEntitySchemaWithHttpInfo()

◆ GetEntitySchemaWithHttpInfoAsync()

◆ GetPropertySchema()

◆ GetPropertySchemaAsync()

◆ GetPropertySchemaWithHttpInfo()

◆ GetPropertySchemaWithHttpInfoAsync()

◆ GetValueTypes()

◆ GetValueTypesAsync()

◆ GetValueTypesWithHttpInfo()

◆ GetValueTypesWithHttpInfoAsync()

◆ ListEntities()

◆ ListEntitiesAsync()

◆ ListEntitiesWithHttpInfo()

◆ ListEntitiesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory