LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IConfigurationRecipeApiSync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IConfigurationRecipeApiSync:
Inheritance graph
[legend]

Public Member Functions

AnnulSingleStructuredDataResponse DeleteConfigurationRecipe (string scope, string code, int operationIndex=0)
 DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present. More...
 
ApiResponse< AnnulSingleStructuredDataResponseDeleteConfigurationRecipeWithHttpInfo (string scope, string code, int operationIndex=0)
 DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present. More...
 
AnnulSingleStructuredDataResponse DeleteRecipeComposer (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present. More...
 
ApiResponse< AnnulSingleStructuredDataResponseDeleteRecipeComposerWithHttpInfo (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present. More...
 
GetRecipeResponse GetConfigurationRecipe (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetConfigurationRecipe: Get Configuration Recipe More...
 
ApiResponse< GetRecipeResponseGetConfigurationRecipeWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetConfigurationRecipe: Get Configuration Recipe More...
 
GetRecipeResponse GetDerivedRecipe (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. More...
 
ApiResponse< GetRecipeResponseGetDerivedRecipeWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. More...
 
GetRecipeComposerResponse GetRecipeComposer (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer More...
 
ApiResponse< GetRecipeComposerResponseGetRecipeComposerWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer More...
 
GetRecipeResponse GetRecipeComposerResolvedInline (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0)
 [EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes. More...
 
ApiResponse< GetRecipeResponseGetRecipeComposerResolvedInlineWithHttpInfo (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0)
 [EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes. More...
 
ResourceListOfGetRecipeResponse ListConfigurationRecipes (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 ListConfigurationRecipes: List the set of Configuration Recipes More...
 
ApiResponse< ResourceListOfGetRecipeResponseListConfigurationRecipesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 ListConfigurationRecipes: List the set of Configuration Recipes More...
 
ResourceListOfGetRecipeResponse ListDerivedRecipes (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. More...
 
ApiResponse< ResourceListOfGetRecipeResponseListDerivedRecipesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. More...
 
ResourceListOfGetRecipeComposerResponse ListRecipeComposers (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers More...
 
ApiResponse< ResourceListOfGetRecipeComposerResponseListRecipeComposersWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 [EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers More...
 
UpsertSingleStructuredDataResponse UpsertConfigurationRecipe (UpsertRecipeRequest upsertRecipeRequest, int operationIndex=0)
 UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid. More...
 
ApiResponse< UpsertSingleStructuredDataResponseUpsertConfigurationRecipeWithHttpInfo (UpsertRecipeRequest upsertRecipeRequest, int operationIndex=0)
 UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid. More...
 
UpsertSingleStructuredDataResponse UpsertRecipeComposer (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0)
 [EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid. More...
 
ApiResponse< UpsertSingleStructuredDataResponseUpsertRecipeComposerWithHttpInfo (UpsertRecipeComposerRequest upsertRecipeComposerRequest, int operationIndex=0)
 [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

◆ DeleteConfigurationRecipe()

AnnulSingleStructuredDataResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.DeleteConfigurationRecipe ( string  scope,
string  code,
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Configuration Recipe to delete.
codeThe Configuration Recipe to delete.
operationIndexIndex associated with the operation.
Returns
AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ DeleteConfigurationRecipeWithHttpInfo()

ApiResponse<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.DeleteConfigurationRecipeWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Configuration Recipe to delete.
codeThe Configuration Recipe to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ DeleteRecipeComposer()

AnnulSingleStructuredDataResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.DeleteRecipeComposer ( string  scope,
string  code,
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Recipe Composer to delete.
codeThe Recipe Composer to delete.
operationIndexIndex associated with the operation.
Returns
AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ DeleteRecipeComposerWithHttpInfo()

ApiResponse<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.DeleteRecipeComposerWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Recipe Composer to delete.
codeThe Recipe Composer to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetConfigurationRecipe()

GetRecipeResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetConfigurationRecipe ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Configuration Recipe to retrieve.
codeThe name of the recipe to retrieve the data for.
asAtThe asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetConfigurationRecipeWithHttpInfo()

ApiResponse<GetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetConfigurationRecipeWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Configuration Recipe to retrieve.
codeThe name of the recipe to retrieve the data for.
asAtThe asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetDerivedRecipe()

GetRecipeResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetDerivedRecipe ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Configuration Recipe or Recipe Composer to return.
codeThe code of the Configuration Recipe or Recipe Composer to return.
asAtThe asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetDerivedRecipeWithHttpInfo()

ApiResponse<GetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetDerivedRecipeWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Configuration Recipe or Recipe Composer to return.
codeThe code of the Configuration Recipe or Recipe Composer to return.
asAtThe asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposer()

GetRecipeComposerResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetRecipeComposer ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Recipe Composer to retrieve.
codeThe name of the Recipe Composer to retrieve the data for.
asAtThe asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
GetRecipeComposerResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerResolvedInline()

GetRecipeResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetRecipeComposerResolvedInline ( UpsertRecipeComposerRequest  upsertRecipeComposerRequest,
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
upsertRecipeComposerRequestRecipe composer used to expand into the Configuration Recipe.
operationIndexIndex associated with the operation.
Returns
GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerResolvedInlineWithHttpInfo()

ApiResponse<GetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetRecipeComposerResolvedInlineWithHttpInfo ( UpsertRecipeComposerRequest  upsertRecipeComposerRequest,
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
upsertRecipeComposerRequestRecipe composer used to expand into the Configuration Recipe.
operationIndexIndex associated with the operation.
Returns
ApiResponse of GetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ GetRecipeComposerWithHttpInfo()

ApiResponse<GetRecipeComposerResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.GetRecipeComposerWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Recipe Composer to retrieve.
codeThe name of the Recipe Composer to retrieve the data for.
asAtThe asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of GetRecipeComposerResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListConfigurationRecipes()

ResourceListOfGetRecipeResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.ListConfigurationRecipes ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfGetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListConfigurationRecipesWithHttpInfo()

ApiResponse<ResourceListOfGetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.ListConfigurationRecipesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfGetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListDerivedRecipes()

ResourceListOfGetRecipeResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.ListDerivedRecipes ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filterExpression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfGetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListDerivedRecipesWithHttpInfo()

ApiResponse<ResourceListOfGetRecipeResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.ListDerivedRecipesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified. (optional)
filterExpression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfGetRecipeResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListRecipeComposers()

ResourceListOfGetRecipeComposerResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.ListRecipeComposers ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified. (optional)
filterExpression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfGetRecipeComposerResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ ListRecipeComposersWithHttpInfo()

ApiResponse<ResourceListOfGetRecipeComposerResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.ListRecipeComposersWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified. (optional)
filterExpression to filter the result set, note this functionality is not yet enabled for this endpoint. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfGetRecipeComposerResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertConfigurationRecipe()

UpsertSingleStructuredDataResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.UpsertConfigurationRecipe ( UpsertRecipeRequest  upsertRecipeRequest,
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
upsertRecipeRequestThe Configuration Recipe to update or insert
operationIndexIndex associated with the operation.
Returns
UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertConfigurationRecipeWithHttpInfo()

ApiResponse<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.UpsertConfigurationRecipeWithHttpInfo ( UpsertRecipeRequest  upsertRecipeRequest,
int  operationIndex = 0 
)

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.ApiExceptionThrown when fails to make API call
Parameters
upsertRecipeRequestThe Configuration Recipe to update or insert
operationIndexIndex associated with the operation.
Returns
ApiResponse of UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertRecipeComposer()

UpsertSingleStructuredDataResponse Lusid.Sdk.Api.IConfigurationRecipeApiSync.UpsertRecipeComposer ( UpsertRecipeComposerRequest  upsertRecipeComposerRequest,
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
upsertRecipeComposerRequestThe Recipe Composer to update or insert
operationIndexIndex associated with the operation.
Returns
UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.

◆ UpsertRecipeComposerWithHttpInfo()

ApiResponse<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.IConfigurationRecipeApiSync.UpsertRecipeComposerWithHttpInfo ( UpsertRecipeComposerRequest  upsertRecipeComposerRequest,
int  operationIndex = 0 
)

[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.ApiExceptionThrown when fails to make API call
Parameters
upsertRecipeComposerRequestThe Recipe Composer to update or insert
operationIndexIndex associated with the operation.
Returns
ApiResponse of UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.ConfigurationRecipeApi.


The documentation for this interface was generated from the following file: