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

Inheritance diagram for Lusid.Sdk.Api.IConfigurationRecipeApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< AnnulSingleStructuredDataResponse >	DeleteConfigurationRecipeAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present. More...

System.Threading.Tasks.Task< ApiResponse< AnnulSingleStructuredDataResponse > >	DeleteConfigurationRecipeWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present. More...

System.Threading.Tasks.Task< AnnulSingleStructuredDataResponse >	DeleteRecipeComposerAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present. More...

System.Threading.Tasks.Task< ApiResponse< AnnulSingleStructuredDataResponse > >	DeleteRecipeComposerWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present. More...

System.Threading.Tasks.Task< GetRecipeResponse >	GetConfigurationRecipeAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetConfigurationRecipe: Get Configuration Recipe More...

System.Threading.Tasks.Task< ApiResponse< GetRecipeResponse > >	GetConfigurationRecipeWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetConfigurationRecipe: Get Configuration Recipe More...

System.Threading.Tasks.Task< GetRecipeResponse >	GetDerivedRecipeAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. More...

System.Threading.Tasks.Task< ApiResponse< GetRecipeResponse > >	GetDerivedRecipeWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. More...

System.Threading.Tasks.Task< GetRecipeComposerResponse >	GetRecipeComposerAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer More...

System.Threading.Tasks.Task< ApiResponse< GetRecipeComposerResponse > >	GetRecipeComposerWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer More...

System.Threading.Tasks.Task< GetRecipeResponse >	GetRecipeComposerResolvedInlineAsync (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes. More...

System.Threading.Tasks.Task< ApiResponse< GetRecipeResponse > >	GetRecipeComposerResolvedInlineWithHttpInfoAsync (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes. More...

System.Threading.Tasks.Task< ResourceListOfGetRecipeResponse >	ListConfigurationRecipesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListConfigurationRecipes: List the set of Configuration Recipes More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfGetRecipeResponse > >	ListConfigurationRecipesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListConfigurationRecipes: List the set of Configuration Recipes More...

System.Threading.Tasks.Task< ResourceListOfGetRecipeResponse >	ListDerivedRecipesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfGetRecipeResponse > >	ListDerivedRecipesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. More...

System.Threading.Tasks.Task< ResourceListOfGetRecipeComposerResponse >	ListRecipeComposersAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfGetRecipeComposerResponse > >	ListRecipeComposersWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers More...

System.Threading.Tasks.Task< UpsertSingleStructuredDataResponse >	UpsertConfigurationRecipeAsync (UpsertRecipeRequest upsertRecipeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid. More...

System.Threading.Tasks.Task< ApiResponse< UpsertSingleStructuredDataResponse > >	UpsertConfigurationRecipeWithHttpInfoAsync (UpsertRecipeRequest upsertRecipeRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid. More...

System.Threading.Tasks.Task< UpsertSingleStructuredDataResponse >	UpsertRecipeComposerAsync (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid. More...

System.Threading.Tasks.Task< ApiResponse< UpsertSingleStructuredDataResponse > >	UpsertRecipeComposerWithHttpInfoAsync (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid. 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

◆ DeleteConfigurationRecipeAsync()

System.Threading.Tasks.Task<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.DeleteConfigurationRecipeAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present.

Delete the specified Configuration Recipe from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response.

Exceptions

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

Parameters

scope	The scope of the Configuration Recipe to delete.
code	The Configuration Recipe to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ DeleteConfigurationRecipeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AnnulSingleStructuredDataResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.DeleteConfigurationRecipeWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present.

Delete the specified Configuration Recipe from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response.

Exceptions

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

Parameters

scope	The scope of the Configuration Recipe to delete.
code	The Configuration Recipe to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AnnulSingleStructuredDataResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ DeleteRecipeComposerAsync()

System.Threading.Tasks.Task<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.DeleteRecipeComposerAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present.

Delete the specified Recipe Composer from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response.

Exceptions

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

Parameters

scope	The scope of the Recipe Composer to delete.
code	The Recipe Composer to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ DeleteRecipeComposerWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AnnulSingleStructuredDataResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.DeleteRecipeComposerWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present.

Delete the specified Recipe Composer from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response.

Exceptions

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

Parameters

scope	The scope of the Recipe Composer to delete.
code	The Recipe Composer to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AnnulSingleStructuredDataResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetConfigurationRecipeAsync()

System.Threading.Tasks.Task<GetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetConfigurationRecipeAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetConfigurationRecipe: Get Configuration Recipe

Get a Configuration Recipe from a single scope. The response will return either the recipe that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures).

Exceptions

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

Parameters

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

Returns: Task of GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetConfigurationRecipeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetRecipeResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetConfigurationRecipeWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetConfigurationRecipe: Get Configuration Recipe

Get a Configuration Recipe from a single scope. The response will return either the recipe that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures).

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (GetRecipeResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetDerivedRecipeAsync()

System.Threading.Tasks.Task<GetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetDerivedRecipeAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer.

If scope-code is referring to a Configuration Recipe it is returned, if it refers to Recipe Composer, it is expanded into a Configuration Recipe and returned.

Exceptions

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

Parameters

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

Returns: Task of GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetDerivedRecipeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetRecipeResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetDerivedRecipeWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer.

If scope-code is referring to a Configuration Recipe it is returned, if it refers to Recipe Composer, it is expanded into a Configuration Recipe and returned.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (GetRecipeResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerAsync()

System.Threading.Tasks.Task<GetRecipeComposerResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetRecipeComposerAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer

Get a Recipe Composer from a single scope. The response will return either the recipe composer that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures).

Exceptions

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

Parameters

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

Returns: Task of GetRecipeComposerResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerResolvedInlineAsync()

System.Threading.Tasks.Task<GetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetRecipeComposerResolvedInlineAsync	(	UpsertRecipeComposerRequest	upsertRecipeComposerRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes.

Resolves an inline recipe composer into a ConfigurationRecipe.

Exceptions

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

Parameters

upsertRecipeComposerRequest	Recipe composer used to expand into the Configuration Recipe.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerResolvedInlineWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetRecipeResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetRecipeComposerResolvedInlineWithHttpInfoAsync	(	UpsertRecipeComposerRequest	upsertRecipeComposerRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes.

Resolves an inline recipe composer into a ConfigurationRecipe.

Exceptions

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

Parameters

upsertRecipeComposerRequest	Recipe composer used to expand into the Configuration Recipe.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (GetRecipeResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetRecipeComposerResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.GetRecipeComposerWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer

Get a Recipe Composer from a single scope. The response will return either the recipe composer that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures).

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (GetRecipeComposerResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListConfigurationRecipesAsync()

System.Threading.Tasks.Task<ResourceListOfGetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.ListConfigurationRecipesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListConfigurationRecipes: List the set of Configuration Recipes

List the set of configuration recipes at the specified date/time and scope. Note this only returns recipes stored directly and does not include any recipes expanded from recipe composers.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set. 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 ResourceListOfGetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListConfigurationRecipesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfGetRecipeResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.ListConfigurationRecipesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListConfigurationRecipes: List the set of Configuration Recipes

List the set of configuration recipes at the specified date/time and scope. Note this only returns recipes stored directly and does not include any recipes expanded from recipe composers.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set. 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 (ResourceListOfGetRecipeResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListDerivedRecipesAsync()

System.Threading.Tasks.Task<ResourceListOfGetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.ListDerivedRecipesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers.

This endpoints returns a union of the output of ListConfigurationRecipes and the resolved Recipe Composers from the ListRecipeComposers endpoints.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfGetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListDerivedRecipesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfGetRecipeResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.ListDerivedRecipesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers.

This endpoints returns a union of the output of ListConfigurationRecipes and the resolved Recipe Composers from the ListRecipeComposers endpoints.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfGetRecipeResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListRecipeComposersAsync()

System.Threading.Tasks.Task<ResourceListOfGetRecipeComposerResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.ListRecipeComposersAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers

List the set of Recipe Composers at the specified date/time and scope

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfGetRecipeComposerResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListRecipeComposersWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfGetRecipeComposerResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.ListRecipeComposersWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers

List the set of Recipe Composers at the specified date/time and scope

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified. (optional)
filter	Expression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfGetRecipeComposerResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertConfigurationRecipeAsync()

System.Threading.Tasks.Task<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.UpsertConfigurationRecipeAsync	(	UpsertRecipeRequest	upsertRecipeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid.

Update or insert one Configuration Recipe in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Configuration Recipe or failure message if unsuccessful It is important to always check to verify success (or failure).

Exceptions

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

Parameters

upsertRecipeRequest	The Configuration Recipe to update or insert
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertConfigurationRecipeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertSingleStructuredDataResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.UpsertConfigurationRecipeWithHttpInfoAsync	(	UpsertRecipeRequest	upsertRecipeRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid.

Update or insert one Configuration Recipe in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Configuration Recipe or failure message if unsuccessful It is important to always check to verify success (or failure).

Exceptions

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

Parameters

upsertRecipeRequest	The Configuration Recipe to update or insert
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertSingleStructuredDataResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertRecipeComposerAsync()

System.Threading.Tasks.Task<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiAsync.UpsertRecipeComposerAsync	(	UpsertRecipeComposerRequest	upsertRecipeComposerRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid.

Update or insert one Recipe Composer in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Recipe Composer or failure message if unsuccessful It is important to always check to verify success (or failure).

Exceptions

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

Parameters

upsertRecipeComposerRequest	The Recipe Composer to update or insert
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertRecipeComposerWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertSingleStructuredDataResponse> > Lusid.Sdk.Api.IConfigurationRecipeApiAsync.UpsertRecipeComposerWithHttpInfoAsync	(	UpsertRecipeComposerRequest	upsertRecipeComposerRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid.

Update or insert one Recipe Composer in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Recipe Composer or failure message if unsuccessful It is important to always check to verify success (or failure).

Exceptions

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

Parameters

upsertRecipeComposerRequest	The Recipe Composer to update or insert
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertSingleStructuredDataResponse)

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteConfigurationRecipeAsync()

◆ DeleteConfigurationRecipeWithHttpInfoAsync()

◆ DeleteRecipeComposerAsync()

◆ DeleteRecipeComposerWithHttpInfoAsync()

◆ GetConfigurationRecipeAsync()

◆ GetConfigurationRecipeWithHttpInfoAsync()

◆ GetDerivedRecipeAsync()

◆ GetDerivedRecipeWithHttpInfoAsync()

◆ GetRecipeComposerAsync()

◆ GetRecipeComposerResolvedInlineAsync()

◆ GetRecipeComposerResolvedInlineWithHttpInfoAsync()

◆ GetRecipeComposerWithHttpInfoAsync()

◆ ListConfigurationRecipesAsync()

◆ ListConfigurationRecipesWithHttpInfoAsync()

◆ ListDerivedRecipesAsync()

◆ ListDerivedRecipesWithHttpInfoAsync()

◆ ListRecipeComposersAsync()

◆ ListRecipeComposersWithHttpInfoAsync()

◆ UpsertConfigurationRecipeAsync()

◆ UpsertConfigurationRecipeWithHttpInfoAsync()

◆ UpsertRecipeComposerAsync()

◆ UpsertRecipeComposerWithHttpInfoAsync()