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

Inheritance diagram for Lusid.Sdk.Api.ISchemasApiSync:

[legend]

Public Member Functions
Schema	GetEntitySchema (string entity, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetEntitySchema: Get schema More...

Lusid.Sdk.Client.ApiResponse< Schema >	GetEntitySchemaWithHttpInfo (string entity, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetEntitySchema: Get schema More...

PropertySchema	GetPropertySchema (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetPropertySchema: Get property schema More...

Lusid.Sdk.Client.ApiResponse< PropertySchema >	GetPropertySchemaWithHttpInfo (List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetPropertySchema: Get property schema More...

ResourceListOfValueType	GetValueTypes (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetValueTypes: Get value types More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfValueType >	GetValueTypesWithHttpInfo (List< string >? sortBy=default(List< string >?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetValueTypes: Get value types More...

ResourceListOfString	ListEntities (int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListEntities: List entities More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfString >	ListEntitiesWithHttpInfo (int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListEntities: List entities More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ GetEntitySchema()

Schema Lusid.Sdk.Api.ISchemasApiSync.GetEntitySchema	(	string	entity,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: Schema

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetEntitySchemaWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Schema> Lusid.Sdk.Api.ISchemasApiSync.GetEntitySchemaWithHttpInfo	(	string	entity,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of Schema

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetPropertySchema()

PropertySchema Lusid.Sdk.Api.ISchemasApiSync.GetPropertySchema	(	List< string >?	propertyKeys = `default(List< string >?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: PropertySchema

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetPropertySchemaWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PropertySchema> Lusid.Sdk.Api.ISchemasApiSync.GetPropertySchemaWithHttpInfo	(	List< string >?	propertyKeys = `default(List< string >?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of PropertySchema

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetValueTypes()

ResourceListOfValueType Lusid.Sdk.Api.ISchemasApiSync.GetValueTypes	(	List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ResourceListOfValueType

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ GetValueTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfValueType> Lusid.Sdk.Api.ISchemasApiSync.GetValueTypesWithHttpInfo	(	List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfValueType

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ ListEntities()

ResourceListOfString Lusid.Sdk.Api.ISchemasApiSync.ListEntities	(	int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ResourceListOfString

Implemented in Lusid.Sdk.Api.SchemasApi.

◆ ListEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfString> Lusid.Sdk.Api.ISchemasApiSync.ListEntitiesWithHttpInfo	(	int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of 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

Detailed Description

Member Function Documentation

◆ GetEntitySchema()

◆ GetEntitySchemaWithHttpInfo()

◆ GetPropertySchema()

◆ GetPropertySchemaWithHttpInfo()

◆ GetValueTypes()

◆ GetValueTypesWithHttpInfo()

◆ ListEntities()

◆ ListEntitiesWithHttpInfo()