LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
DataType | CreateDataType (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] CreateDataType: Create data type definition More... | |
Lusid.Sdk.Client.ApiResponse< DataType > | CreateDataTypeWithHttpInfo (CreateDataTypeRequest? createDataTypeRequest=default(CreateDataTypeRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] CreateDataType: Create data type definition More... | |
DeletedEntityResponse | DeleteDataType (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteDataType: Delete a data type definition. More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteDataTypeWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteDataType: Delete a data type definition. More... | |
DataType | GetDataType (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetDataType: Get data type definition More... | |
Lusid.Sdk.Client.ApiResponse< DataType > | GetDataTypeWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetDataType: Get data type definition More... | |
ResourceListOfIUnitDefinitionDto | GetUnitsFromDataType (string scope, string code, List< string >? units=default(List< string >?), string? filter=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetUnitsFromDataType: Get units from 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetUnitsFromDataType: Get units from 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data 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, ConfigurationOptions? opts=null) |
ListDataTypes: List data types 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, ConfigurationOptions? opts=null) |
ListDataTypes: List data types More... | |
DataType | UpdateDataType (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpdateDataType: Update data type definition More... | |
Lusid.Sdk.Client.ApiResponse< DataType > | UpdateDataTypeWithHttpInfo (string scope, string code, UpdateDataTypeRequest updateDataTypeRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpdateDataType: Update data type definition More... | |
DataType | UpdateReferenceData (string scope, string code, UpdateReferenceDataRequest updateReferenceDataRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values More... | |
Lusid.Sdk.Client.ApiResponse< DataType > | UpdateReferenceDataWithHttpInfo (string scope, string code, UpdateReferenceDataRequest updateReferenceDataRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values More... | |
DataType | UpdateReferenceValues (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type More... | |
Lusid.Sdk.Client.ApiResponse< DataType > | UpdateReferenceValuesWithHttpInfo (string scope, string code, List< FieldValue > fieldValue, int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type More... | |
Represents a collection of functions to interact with the API endpoints
DataType Lusid.Sdk.Api.IDataTypesApiSync.CreateDataType | ( | CreateDataTypeRequest? | createDataTypeRequest = default(CreateDataTypeRequest?) , |
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
createDataTypeRequest | The definition of the new data type (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.CreateDataTypeWithHttpInfo | ( | CreateDataTypeRequest? | createDataTypeRequest = default(CreateDataTypeRequest?) , |
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
createDataTypeRequest | The definition of the new data type (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
DeletedEntityResponse Lusid.Sdk.Api.IDataTypesApiSync.DeleteDataType | ( | string | scope, |
string | code, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
DeleteDataType: Delete a data type definition.
Delete an existing data type definition. Data types cannot be deleted in either the "default" or "system" scopes, scopes beginning with "LUSID-", or data types that are in use on a property definition.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the data type |
code | The code of the data type |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IDataTypesApiSync.DeleteDataTypeWithHttpInfo | ( | string | scope, |
string | code, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
DeleteDataType: Delete a data type definition.
Delete an existing data type definition. Data types cannot be deleted in either the "default" or "system" scopes, scopes beginning with "LUSID-", or data types that are in use on a property definition.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the data type |
code | The code of the data type |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
DataType Lusid.Sdk.Api.IDataTypesApiSync.GetDataType | ( | string | scope, |
string | code, | ||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetDataType: Get data type definition
Get the definition of a specified data type
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.GetDataTypeWithHttpInfo | ( | string | scope, |
string | code, | ||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetDataType: Get data type definition
Get the definition of a specified data type
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
ResourceListOfIUnitDefinitionDto Lusid.Sdk.Api.IDataTypesApiSync.GetUnitsFromDataType | ( | string | scope, |
string | code, | ||
List< string >? | units = default(List< string >?) , |
||
string? | filter = default(string?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] GetUnitsFromDataType: Get units from data type
Get the definitions of the specified units associated bound to a specific data type
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfIUnitDefinitionDto> Lusid.Sdk.Api.IDataTypesApiSync.GetUnitsFromDataTypeWithHttpInfo | ( | string | scope, |
string | code, | ||
List< string >? | units = default(List< string >?) , |
||
string? | filter = default(string?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] GetUnitsFromDataType: Get units from data type
Get the definitions of the specified units associated bound to a specific data type
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
ResourceListOfDataType Lusid.Sdk.Api.IDataTypesApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
ListDataTypes: List data types
List all data types in a specified scope
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
PagedResourceListOfDataTypeSummary Lusid.Sdk.Api.IDataTypesApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data
List all data type summaries
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<PagedResourceListOfDataTypeSummary> Lusid.Sdk.Api.IDataTypesApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data
List all data type summaries
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfDataType> Lusid.Sdk.Api.IDataTypesApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
ListDataTypes: List data types
List all data types in a specified scope
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
DataType Lusid.Sdk.Api.IDataTypesApiSync.UpdateDataType | ( | string | scope, |
string | code, | ||
UpdateDataTypeRequest | updateDataTypeRequest, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.UpdateDataTypeWithHttpInfo | ( | string | scope, |
string | code, | ||
UpdateDataTypeRequest | updateDataTypeRequest, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
DataType Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceData | ( | string | scope, |
string | code, | ||
UpdateReferenceDataRequest | updateReferenceDataRequest, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values
Replaces the whole set of reference data
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the data type |
code | The code of the data type |
updateReferenceDataRequest | The updated reference data |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceDataWithHttpInfo | ( | string | scope, |
string | code, | ||
UpdateReferenceDataRequest | updateReferenceDataRequest, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values
Replaces the whole set of reference data
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the data type |
code | The code of the data type |
updateReferenceDataRequest | The updated reference data |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
DataType Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceValues | ( | string | scope, |
string | code, | ||
List< FieldValue > | fieldValue, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type
Replaces the whole set of reference values
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.
Lusid.Sdk.Client.ApiResponse<DataType> Lusid.Sdk.Api.IDataTypesApiSync.UpdateReferenceValuesWithHttpInfo | ( | string | scope, |
string | code, | ||
List< FieldValue > | fieldValue, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type
Replaces the whole set of reference values
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.DataTypesApi.