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

Inheritance diagram for Lusid.Sdk.Api.DataTypesApi:

[legend]

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

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

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

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

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

DataType	CreateDataType (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0)
	[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes. More...

Lusid.Sdk.Client.ApiResponse< DataType >	CreateDataTypeWithHttpInfo (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0)
	[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes. More...

async System.Threading.Tasks.Task< DataType >	CreateDataTypeAsync (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DataType > >	CreateDataTypeWithHttpInfoAsync (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes. More...

DataType	GetDataType (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	GetDataType: Get data type definition Get the definition of a specified data type More...

Lusid.Sdk.Client.ApiResponse< DataType >	GetDataTypeWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	GetDataType: Get data type definition Get the definition of a specified data type More...

async System.Threading.Tasks.Task< DataType >	GetDataTypeAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetDataType: Get data type definition Get the definition of a specified data type More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DataType > >	GetDataTypeWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetDataType: Get data type definition Get the definition of a specified data type More...

ResourceListOfIUnitDefinitionDto	GetUnitsFromDataType (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfIUnitDefinitionDto >	GetUnitsFromDataTypeWithHttpInfo (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type More...

async System.Threading.Tasks.Task< ResourceListOfIUnitDefinitionDto >	GetUnitsFromDataTypeAsync (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfIUnitDefinitionDto > >	GetUnitsFromDataTypeWithHttpInfoAsync (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type More...

PagedResourceListOfDataTypeSummary	ListDataTypeSummaries (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfDataTypeSummary >	ListDataTypeSummariesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries More...

async System.Threading.Tasks.Task< PagedResourceListOfDataTypeSummary >	ListDataTypeSummariesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfDataTypeSummary > >	ListDataTypeSummariesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries More...

ResourceListOfDataType	ListDataTypes (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeSystem=default(bool?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
	ListDataTypes: List data types List all data types in a specified scope More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfDataType >	ListDataTypesWithHttpInfo (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeSystem=default(bool?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
	ListDataTypes: List data types List all data types in a specified scope More...

async System.Threading.Tasks.Task< ResourceListOfDataType >	ListDataTypesAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeSystem=default(bool?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListDataTypes: List data types List all data types in a specified scope More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfDataType > >	ListDataTypesWithHttpInfoAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), bool? includeSystem=default(bool?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListDataTypes: List data types List all data types in a specified scope More...

DataType	UpdateDataType (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types More...

Lusid.Sdk.Client.ApiResponse< DataType >	UpdateDataTypeWithHttpInfo (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types More...

async System.Threading.Tasks.Task< DataType >	UpdateDataTypeAsync (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DataType > >	UpdateDataTypeWithHttpInfoAsync (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types More...

DataType	UpdateReferenceValues (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0)
	[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values More...

Lusid.Sdk.Client.ApiResponse< DataType >	UpdateReferenceValuesWithHttpInfo (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0)
	[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values More...

async System.Threading.Tasks.Task< DataType >	UpdateReferenceValuesAsync (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DataType > >	UpdateReferenceValuesWithHttpInfoAsync (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values 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

◆ DataTypesApi() [1/4]

Lusid.Sdk.Api.DataTypesApi.DataTypesApi ( )

inline

Initializes a new instance of the DataTypesApi class.

Returns

◆ DataTypesApi() [2/4]

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

inline

Initializes a new instance of the DataTypesApi class.

Returns

◆ DataTypesApi() [3/4]

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

inline

Initializes a new instance of the DataTypesApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ DataTypesApi() [4/4]

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

inline

Initializes a new instance of the DataTypesApi 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

◆ CreateDataType()

DataType Lusid.Sdk.Api.DataTypesApi.CreateDataType	(	CreateDataTypeRequest?	createDataTypeRequest = `default(CreateDataTypeRequest?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes.

Exceptions

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

Parameters

createDataTypeRequest	The definition of the new data type (optional)
operationIndex	Index associated with the operation.

Returns: DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ CreateDataTypeAsync()

async System.Threading.Tasks.Task<DataType> Lusid.Sdk.Api.DataTypesApi.CreateDataTypeAsync	(	CreateDataTypeRequest?	createDataTypeRequest = `default(CreateDataTypeRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes.

Exceptions

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

Parameters

createDataTypeRequest	The definition of the new data type (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DataType

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ CreateDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.DataTypesApi.CreateDataTypeWithHttpInfo	(	CreateDataTypeRequest?	createDataTypeRequest = `default(CreateDataTypeRequest?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes.

Exceptions

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

Parameters

createDataTypeRequest	The definition of the new data type (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ CreateDataTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DataType> > Lusid.Sdk.Api.DataTypesApi.CreateDataTypeWithHttpInfoAsync	(	CreateDataTypeRequest?	createDataTypeRequest = `default(CreateDataTypeRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] CreateDataType: Create data type definition Create a new data type definition Data types cannot be created in either the "default" or "system" scopes.

Exceptions

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

Parameters

createDataTypeRequest	The definition of the new data type (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DataType)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetDataType()

DataType Lusid.Sdk.Api.DataTypesApi.GetDataType	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

GetDataType: Get data type definition Get the definition of a specified data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
asAt	The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ GetDataTypeAsync()

async System.Threading.Tasks.Task<DataType> Lusid.Sdk.Api.DataTypesApi.GetDataTypeAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

GetDataType: Get data type definition Get the definition of a specified data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
asAt	The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DataType

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ GetDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.DataTypesApi.GetDataTypeWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

GetDataType: Get data type definition Get the definition of a specified data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
asAt	The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ GetDataTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DataType> > Lusid.Sdk.Api.DataTypesApi.GetDataTypeWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

GetDataType: Get data type definition Get the definition of a specified data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
asAt	The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DataType)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ GetUnitsFromDataType()

ResourceListOfIUnitDefinitionDto Lusid.Sdk.Api.DataTypesApi.GetUnitsFromDataType	(	string	scope,
		string	code,
		List< string >?	units = `default(List<string>?)`,
		string?	filter = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
units	One or more unit identifiers for which the definition is being requested (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Schema, use "schema eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
asAt	Optional. The as at of the requested data type (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfIUnitDefinitionDto

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ GetUnitsFromDataTypeAsync()

async System.Threading.Tasks.Task<ResourceListOfIUnitDefinitionDto> Lusid.Sdk.Api.DataTypesApi.GetUnitsFromDataTypeAsync	(	string	scope,
		string	code,
		List< string >?	units = `default(List<string>?)`,
		string?	filter = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
units	One or more unit identifiers for which the definition is being requested (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Schema, use "schema eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
asAt	Optional. The as at of the requested data type (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfIUnitDefinitionDto

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ GetUnitsFromDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfIUnitDefinitionDto> Lusid.Sdk.Api.DataTypesApi.GetUnitsFromDataTypeWithHttpInfo	(	string	scope,
		string	code,
		List< string >?	units = `default(List<string>?)`,
		string?	filter = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
units	One or more unit identifiers for which the definition is being requested (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Schema, use "schema eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
asAt	Optional. The as at of the requested data type (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfIUnitDefinitionDto

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ GetUnitsFromDataTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfIUnitDefinitionDto> > Lusid.Sdk.Api.DataTypesApi.GetUnitsFromDataTypeWithHttpInfoAsync	(	string	scope,
		string	code,
		List< string >?	units = `default(List<string>?)`,
		string?	filter = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetUnitsFromDataType: Get units from data type Get the definitions of the specified units associated bound to a specific data type

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
units	One or more unit identifiers for which the definition is being requested (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Schema, use "schema eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
asAt	Optional. The as at of the requested data type (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfIUnitDefinitionDto)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ ListDataTypes()

ResourceListOfDataType Lusid.Sdk.Api.DataTypesApi.ListDataTypes	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeSystem = `default(bool?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`
	)

inline

ListDataTypes: List data types List all data types in a specified scope

Exceptions

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

Parameters

scope	The requested scope of the data types
asAt	The as at of the requested data types (optional)
includeSystem	Whether to additionally include those data types in the "system" scope (optional)
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)
filter	Optional. Expression to filter the result set. For example, to filter on the Display Name, use "displayName 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: ResourceListOfDataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ ListDataTypesAsync()

async System.Threading.Tasks.Task<ResourceListOfDataType> Lusid.Sdk.Api.DataTypesApi.ListDataTypesAsync	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeSystem = `default(bool?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

ListDataTypes: List data types List all data types in a specified scope

Exceptions

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

Parameters

scope	The requested scope of the data types
asAt	The as at of the requested data types (optional)
includeSystem	Whether to additionally include those data types in the "system" scope (optional)
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)
filter	Optional. Expression to filter the result set. For example, to filter on the Display Name, use "displayName 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfDataType

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ ListDataTypeSummaries()

PagedResourceListOfDataTypeSummary Lusid.Sdk.Api.DataTypesApi.ListDataTypeSummaries	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. (optional)
page	The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'myscope'", to filter on Schema, use "schema eq 'string'", to filter on AcceptableValues use "acceptableValues any (~ eq 'value')" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfDataTypeSummary

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ ListDataTypeSummariesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfDataTypeSummary> Lusid.Sdk.Api.DataTypesApi.ListDataTypeSummariesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. (optional)
page	The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'myscope'", to filter on Schema, use "schema eq 'string'", to filter on AcceptableValues use "acceptableValues any (~ eq 'value')" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfDataTypeSummary

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ ListDataTypeSummariesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfDataTypeSummary> Lusid.Sdk.Api.DataTypesApi.ListDataTypeSummariesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. (optional)
page	The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'myscope'", to filter on Schema, use "schema eq 'string'", to filter on AcceptableValues use "acceptableValues any (~ eq 'value')" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfDataTypeSummary

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ ListDataTypeSummariesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfDataTypeSummary> > Lusid.Sdk.Api.DataTypesApi.ListDataTypeSummariesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data List all data type summaries

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. (optional)
page	The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'myscope'", to filter on Schema, use "schema eq 'string'", to filter on AcceptableValues use "acceptableValues any (~ eq 'value')" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfDataTypeSummary)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ ListDataTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfDataType> Lusid.Sdk.Api.DataTypesApi.ListDataTypesWithHttpInfo	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeSystem = `default(bool?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`
	)

inline

ListDataTypes: List data types List all data types in a specified scope

Exceptions

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

Parameters

scope	The requested scope of the data types
asAt	The as at of the requested data types (optional)
includeSystem	Whether to additionally include those data types in the "system" scope (optional)
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)
filter	Optional. Expression to filter the result set. For example, to filter on the Display Name, use "displayName 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 ResourceListOfDataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ ListDataTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfDataType> > Lusid.Sdk.Api.DataTypesApi.ListDataTypesWithHttpInfoAsync	(	string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		bool?	includeSystem = `default(bool?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

ListDataTypes: List data types List all data types in a specified scope

Exceptions

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

Parameters

scope	The requested scope of the data types
asAt	The as at of the requested data types (optional)
includeSystem	Whether to additionally include those data types in the "system" scope (optional)
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)
filter	Optional. Expression to filter the result set. For example, to filter on the Display Name, use "displayName 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfDataType)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ UpdateDataType()

DataType Lusid.Sdk.Api.DataTypesApi.UpdateDataType	(	string	scope,
		string	code,
		UpdateDataTypeRequest	updateDataTypeRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
updateDataTypeRequest	The updated definition of the data type
operationIndex	Index associated with the operation.

Returns: DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ UpdateDataTypeAsync()

async System.Threading.Tasks.Task<DataType> Lusid.Sdk.Api.DataTypesApi.UpdateDataTypeAsync	(	string	scope,
		string	code,
		UpdateDataTypeRequest	updateDataTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
updateDataTypeRequest	The updated definition of the data type
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DataType

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ UpdateDataTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.DataTypesApi.UpdateDataTypeWithHttpInfo	(	string	scope,
		string	code,
		UpdateDataTypeRequest	updateDataTypeRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
updateDataTypeRequest	The updated definition of the data type
operationIndex	Index associated with the operation.

Returns: ApiResponse of DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ UpdateDataTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DataType> > Lusid.Sdk.Api.DataTypesApi.UpdateDataTypeWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateDataTypeRequest	updateDataTypeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateDataType: Update data type definition Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
updateDataTypeRequest	The updated definition of the data type
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DataType)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ UpdateReferenceValues()

DataType Lusid.Sdk.Api.DataTypesApi.UpdateReferenceValues	(	string	scope,
		string	code,
		List< FieldValue >	fieldValue,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
fieldValue	The updated reference values
operationIndex	Index associated with the operation.

Returns: DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ UpdateReferenceValuesAsync()

async System.Threading.Tasks.Task<DataType> Lusid.Sdk.Api.DataTypesApi.UpdateReferenceValuesAsync	(	string	scope,
		string	code,
		List< FieldValue >	fieldValue,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
fieldValue	The updated reference values
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DataType

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

◆ UpdateReferenceValuesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.DataTypesApi.UpdateReferenceValuesWithHttpInfo	(	string	scope,
		string	code,
		List< FieldValue >	fieldValue,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
fieldValue	The updated reference values
operationIndex	Index associated with the operation.

Returns: ApiResponse of DataType

Implements Lusid.Sdk.Api.IDataTypesApiSync.

◆ UpdateReferenceValuesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DataType> > Lusid.Sdk.Api.DataTypesApi.UpdateReferenceValuesWithHttpInfoAsync	(	string	scope,
		string	code,
		List< FieldValue >	fieldValue,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type Replaces the whole set of reference values

Exceptions

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

Parameters

scope	The scope of the data type
code	The code of the data type
fieldValue	The updated reference values
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DataType)

Implements Lusid.Sdk.Api.IDataTypesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.DataTypesApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.DataTypesApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.DataTypesApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.DataTypesApi.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/DataTypesApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DataTypesApi() [1/4]

◆ DataTypesApi() [2/4]

◆ DataTypesApi() [3/4]

◆ DataTypesApi() [4/4]

Member Function Documentation

◆ CreateDataType()

◆ CreateDataTypeAsync()

◆ CreateDataTypeWithHttpInfo()

◆ CreateDataTypeWithHttpInfoAsync()

◆ GetBasePath()

◆ GetDataType()

◆ GetDataTypeAsync()

◆ GetDataTypeWithHttpInfo()

◆ GetDataTypeWithHttpInfoAsync()

◆ GetUnitsFromDataType()

◆ GetUnitsFromDataTypeAsync()

◆ GetUnitsFromDataTypeWithHttpInfo()

◆ GetUnitsFromDataTypeWithHttpInfoAsync()

◆ ListDataTypes()

◆ ListDataTypesAsync()

◆ ListDataTypeSummaries()

◆ ListDataTypeSummariesAsync()

◆ ListDataTypeSummariesWithHttpInfo()

◆ ListDataTypeSummariesWithHttpInfoAsync()

◆ ListDataTypesWithHttpInfo()

◆ ListDataTypesWithHttpInfoAsync()

◆ UpdateDataType()

◆ UpdateDataTypeAsync()

◆ UpdateDataTypeWithHttpInfo()

◆ UpdateDataTypeWithHttpInfoAsync()

◆ UpdateReferenceValues()

◆ UpdateReferenceValuesAsync()

◆ UpdateReferenceValuesWithHttpInfo()

◆ UpdateReferenceValuesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory