RecipeService¶
Initialize the Elevate service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
server
|
Optional[str]
|
The server name for the Elevate service API. If not provided, defaults to the |
None
|
client_id
|
Optional[str]
|
The client ID for authentication. If not provided, defaults to the |
None
|
secret_key
|
Optional[str]
|
The secret key for authentication. If not provided, defaults to the |
None
|
Raises:
| Type | Description |
|---|---|
ElevateConfigurationException
|
If any required parameter is missing or invalid |
create_recipe
¶
Create new recipe
Creates a new recipe with version 1. The recipe can then be reused across multiple datasets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_recipe_request
|
CreateRecipeRequest
|
Request body containing the configuration details needed to create a new Recipe, including name, description, language, type, and initial code (required) |
required |
Returns:
| Type | Description |
|---|---|
RecipeResponse
|
Returns the result object. |
create_recipe_version
¶
Create new recipe version
Creates new RecipeVersionEntity with versionNumber = latestVersionNumber + 1. If code is provided in the request, uses that code for the new version. If code is not provided, copies code from the latest version. Updates RecipeEntity.latestVersionNumber. Returns RecipeVersionResponse.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
create_recipe_version_request
|
CreateRecipeVersionRequest
|
Request body containing optional code for creating a new version of a Recipe. If code is not provided, it will be copied from the latest version (required) |
required |
Returns:
| Type | Description |
|---|---|
RecipeVersionResponse
|
Returns the result object. |
get_recipe
¶
Get recipe
Returns Recipe - recipe base information from RecipeEntity (id, name, description, language, latestVersionNumber). Does NOT include version-specific code. To get code, use GET /v1/recipes/{recipe-id}/versions/{version-number}
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
RecipeResponse
|
Returns the result object. |
get_recipe_version
¶
Get specific recipe version
Returns RecipeVersionResponse - combines RecipeEntity base fields (via Recipe) with specific RecipeVersionEntity. Allows retrieving any historical version including code and lock status.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
version_number
|
StrictInt
|
Version number of the recipe (required) |
required |
Returns:
| Type | Description |
|---|---|
RecipeVersionResponse
|
Returns the result object. |
get_recipe_version_usage
¶
Get recipe version usage details
Returns RecipeUsageResponse - lists all dataset versions using this specific recipe version with full dataset version metadata (dataset ID, version, name, status, node ID, created/modified info). Includes DRAFT and RELEASED dataset versions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
version_number
|
StrictInt
|
Version number of the recipe (required) |
required |
Returns:
| Type | Description |
|---|---|
List[RecipeVersionUsageResponse]
|
Returns the result object. |
list_recipe_versions
¶
List all versions of recipe
Returns all versions of the recipe sorted by version number descending. Includes versionNumber, code, and isLocked for each version.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
List[RecipeVersionResponse]
|
Returns the result object. |
list_recipes
¶
List all recipes with latest version
Returns array of recipes with nested latest version. Each item includes base info (recipeId, name, description, language, type) AND latestVersion object containing (versionNumber, code, isLocked).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_query
|
Optional[ListQuery]
|
List query parameters |
None
|
Returns:
| Type | Description |
|---|---|
RecipesResponse
|
Returns the result object. |
update_recipe
¶
Update recipe
Updates RecipeEntity fields ONLY: name, description. These are shared across all versions and can ALWAYS be updated regardless of lock status. Does NOT update code. Returns Recipe.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
update_recipe_request
|
UpdateRecipeRequest
|
Request body containing the updated configuration for an existing Recipe, including metadata changes such as name and description (required) |
required |
Returns:
| Type | Description |
|---|---|
RecipeResponse
|
Returns the result object. |
update_recipe_version
¶
Update recipe version
Update version-specific code. Can ONLY update code if version is NOT locked (not used in released datasets). If version is locked, returns 409 CONFLICT with suggestion to create new version. This is the ONLY way to update recipe code.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recipe_id
|
StrictInt
|
Unique identifier of the recipe to operate on (required) |
required |
version_number
|
StrictInt
|
Version number of the recipe (required) |
required |
update_recipe_version_request
|
UpdateRecipeVersionRequest
|
Request body containing the updated code for a specific Recipe version. Can only update code if the version is not locked (required) |
required |
Returns:
| Type | Description |
|---|---|
RecipeVersionResponse
|
Returns the result object. |