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

Inheritance diagram for Lusid.Sdk.Api.ISchemasApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< Schema >	GetEntitySchemaAsync (string entity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetEntitySchema: Get schema More...

System.Threading.Tasks.Task< ApiResponse< Schema > >	GetEntitySchemaWithHttpInfoAsync (string entity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetEntitySchema: Get schema More...

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), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetPropertySchema: Get property schema More...

System.Threading.Tasks.Task< ApiResponse< PropertySchema > >	GetPropertySchemaWithHttpInfoAsync (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetPropertySchema: Get property schema More...

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), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetValueTypes: Get value types More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfValueType > >	GetValueTypesWithHttpInfoAsync (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetValueTypes: Get value types More...

System.Threading.Tasks.Task< ResourceListOfString >	ListEntitiesAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListEntities: List entities More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfString > >	ListEntitiesWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListEntities: List entities 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

◆ GetEntitySchemaAsync()

System.Threading.Tasks.Task<Schema> Lusid.Sdk.Api.ISchemasApiAsync.GetEntitySchemaAsync	(	string	entity,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: Task of Schema

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetEntitySchemaWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Schema> > Lusid.Sdk.Api.ISchemasApiAsync.GetEntitySchemaWithHttpInfoAsync	(	string	entity,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: Task of ApiResponse (Schema)

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetPropertySchemaAsync()

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

[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.
opts	Options for this request.

Returns: Task of PropertySchema

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetPropertySchemaWithHttpInfoAsync()

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

[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.
opts	Options for this request.

Returns: Task of ApiResponse (PropertySchema)

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetValueTypesAsync()

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

[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.
opts	Options for this request.

Returns: Task of ResourceListOfValueType

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetValueTypesWithHttpInfoAsync()

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

[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.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfValueType)

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ ListEntitiesAsync()

System.Threading.Tasks.Task<ResourceListOfString> Lusid.Sdk.Api.ISchemasApiAsync.ListEntitiesAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: Task of ResourceListOfString

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ ListEntitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfString> > Lusid.Sdk.Api.ISchemasApiAsync.ListEntitiesWithHttpInfoAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfString)

Implemented in Lusid.Sdk.Api.SchemasApi.

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/SchemasApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetEntitySchemaAsync()

◆ GetEntitySchemaWithHttpInfoAsync()

◆ GetPropertySchemaAsync()

◆ GetPropertySchemaWithHttpInfoAsync()

◆ GetValueTypesAsync()

◆ GetValueTypesWithHttpInfoAsync()

◆ ListEntitiesAsync()

◆ ListEntitiesWithHttpInfoAsync()