# Recipe lifecycle management
GLOSSARY
Manifest: A container of different assets, including recipes, lookup tables, connections, and more.
Package: The build of a manifest. Contains the source code of each asset within a manifest. It includes the latest version of the asset available when the package was created.
# Quick reference
Type | Resource | Description |
---|---|---|
POST | api/export_manifests | Create an export manifest. |
PUT | api/export_manifests/:id | Update an export manifest. |
GET | api/export_manifests/:id | View an export manifest. |
POST | /api/packages/export/:manifest_id | Export package based on a manifest. |
POST | /api/packages/import/:folder_id | Import package into a folder. |
GET | /api/packages/:id | Get package by ID. |
GET | /api/packages/:id/download | Download a package. |
# Create an export manifest
Create an export manifest.
POST /api/export_manifests
# Payload
Name | Type | Description |
---|---|---|
name | string required | Name of the new manifest. |
assets | object required | Dependent assets. |
id | integer required | ID of the dependency. |
type | string required | Type of dependent asset. |
checked | boolean optional | Determines if the asset is included in the manifest. Defaults to true . |
version | integer optional | The version of the asset. Defaults to the latest version. |
folder | string optional | The folder that contains the asset. Defaults to "" . |
absolute_path | string optional | The absolute path of the asset. Defaults to root folder. |
root_folder | boolean optional | Name root folder. Defaults to false . |
unreachable | boolean optional | Whether the asset is unreachable. Defaults to false . |
zip_name | string optional | Name in the exported zip file. By default, Workato auto-generates a name with this structure: asset_#{index}.#{type}.json . |
folder_id | integer optional | The ID of the folder containing the asset. Defaults to the root folder. |
# Sample request
curl -X POST 'https://www.workato.com/api/export_manifests' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
-d '{
"export_manifest": {
"name": "Test Manifest",
"assets": [
{
"id": 12,
"name": "Copy of Recipeops",
"type": "recipe",
"version": 1,
"folder": "",
"absolute_path": "All projects",
"root_folder": false,
"unreachable": false,
"zip_name": "copy_of_recipeops.recipe.json",
"checked": true
}
],
"folder_id": 112
}
}
'
# Response
{
"result": {
"id": 12,
"name": "Test Manifest",
"last_exported_at": null,
"created_at": "2023-02-27T02:44:59.447-08:00",
"updated_at": "2023-02-27T02:44:59.447-08:00",
"deleted_at": null,
"project_path": "Folder 1",
"status": "working"
}
}
# Possible statuses
Status | Definition |
---|---|
working | Active. |
archived | Deleted. |
# Update an export manifest
Update an export manifest.
PUT /api/export_manifests/:id
# URL parameters
Name | Type | Description |
---|---|---|
id | integer string | The ID of the dependency. |
# Payload
Update the properties contained in assets[]
to replace the assets previously defined.
Name | Type | Description |
---|---|---|
name | string optional | Name of the manifest. Update this value to change the manifest name. Defaults to previous name. |
assets | object required | Dependent assets. |
id | integer required | ID of the dependency. |
type | string required | Type of dependent asset. |
checked | boolean optional | Determines if the asset is included in the manifest. Defaults to true . |
version | integer optional | The version of the asset. Defaults to the latest version. |
folder | string optional | The folder that contains the asset. Defaults to "" . |
absolute_path | string optional | The absolute path of the asset. Defaults to root folder. |
root_folder | boolean optional | Name root folder. Defaults to false . |
unreachable | boolean optional | Whether the asset is unreachable. Defaults to false . |
zip_name | string optional | Name in the exported zip file. By default, Workato auto-generates a name with this structure: asset_#{index}.#{type}.json . |
folder_id | integer optional | The ID of the folder containing the asset. Defaults to the root folder. |
# Sample request
curl -X PUT 'https://www.workato.com/api/export_manifests/12' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
-d '{
"export_manifest": {
"name": "Test Manifest",
"assets": [
{
"id": 12,
"name": "Copy of Recipeops",
"type": "recipe",
"version": 1,
"folder": "",
"absolute_path": "All projects",
"root_folder": false,
"unreachable": false,
"zip_name": "copy_of_recipeops.recipe.json",
"checked": true
}
],
"folder_id": 112
}
}
'
# Response
{
"result": {
"id": 12,
"name": "Test Manifest",
"last_exported_at": null,
"created_at": "2023-02-27T02:44:59.447-08:00",
"updated_at": "2023-02-27T02:44:59.447-08:00",
"deleted_at": null,
"project_path": "Folder 1",
"status": "working"
}
}
# View an export manifest
View an export manifest.
GET /api/export_manifests/:id
# URL parameters
Name | Type | Description |
---|---|---|
id | integer string | The ID of the dependency. |
# Sample request
curl -X GET 'https://www.workato.com/api/export_manifests/12' \
-H 'Authorization: Bearer <api_token>'
# Response
{
"result": {
"id": 12,
"name": "Test Manifest",
"last_exported_at": null,
"created_at": "2023-02-27T02:44:59.447-08:00",
"updated_at": "2023-02-27T02:44:59.447-08:00",
"deleted_at": null,
"project_path": "Folder 1",
"status": "working"
}
}
# Export package based on a manifest
Export package based on a manifest.
WARNING
Take note that providing an API client with privilege to this endpoint will indirectly give it the ability to view other assets like recipes, lookup tables, pubsub topics and message templates by examining the resultant zip file.
POST /api/packages/export/:id
This is an asynchronous request. Use GET package by ID endpoint to get details of the exported package.
# URL parameters
Name | Type | Description |
---|---|---|
id | string required | Export manifest ID. |
# Sample request
curl -X POST 'https://www.workato.com/api/packages/export/<manifest_id>' \
-H 'Authorization: Bearer <api_token>'
# Response
{
"id":242,
"operation_type":"export",
"status":"completed",
"export_manifest_id":3,
"download_url":"https://www.workato-staging-assets.com/packages/zip_files/000/000/242/original/exportdemo.zip"
}
# Import package into a folder
Import a package (zip file) into a folder.
WARNING
Take note that providing an API client with privilege to this endpoint will indirectly give it the ability to create/update other assets like recipes, lookup tables, pubsub topics and message templates via importing packages.
POST /api/packages/import/:id
This is an asynchronous request. Use GET package by ID endpoint to get details of the imported the package.
The input (zip file) is a application/octet-stream
payload containing package content. URL parameter restart_recipes must be true
if the running recipes need to be restarted upon import.
# URL parameters
Name | Type | Description |
---|---|---|
id | string required | Folder ID. |
restart_recipes | boolean optional | Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided. |
# Sample request
curl -X POST 'https://www.workato.com/api/packages/import/<folder_id>?restart_recipes=true' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/octet-stream' \
--data-binary @'path/to/local/file.zip'
# Response
{
"id":251,
"operation_type":"import",
"status":"completed",
"download_url":"https://www.workato-staging-assets,com/packages/zip_files/000/000/242/original/exportdemo.zip"
}
# Get package by ID
Get details of an imported or exported package.
GET /api/packages/:id
# URL parameters
Name | Type | Description |
---|---|---|
id | string required | Package ID. |
# Sample request
curl -X GET 'https://www.workato.com/api/packages/<package_id>' \
-H 'Authorization: Bearer <api_token>'
# Response
- This shows the response from the retrieval of a completed export manifest.
{
"id":242,
"operation_type":"export",
"status":"completed",
"export_manifest_id":3,
"download_url":"https://www.workato-staging-assets,com/packages/zip_files/000/000/242/original/exportdemo.zip"
}
- This shows the response from the retrieval of a failed export manifest
{
"id":242,
"operation_type":"export",
"status":"failed",
"error":"error_message",
"export_manifest_id":4,
"download_url":"null"
}
- This shows the response from the retrieval of a completed import.
NOTE
For any completed import, it is important to also check each recipe's import_result. Learn more about the possible import_result values.
{
"id":242,
"operation_type":"export",
"status":"completed",,
"download_url":"https://www.workato-staging-assets,com/packages/zip_files/000/000/242/original/importdemo.zip",
"recipe_status":[
{
"id": 12345,
"import_result": "no_update_or_update_without_restart"
},
{
"id": 12346,
"import_result": "restarted"
},
{
"id": 12347,
"import_result": "stopped"
}
]
}
- This shows the response from the retrieval of a failed import.
NOTE
For any failed import, not all recipes may be returned in recipe_status
as they may not have been updated before the import failed. Learn more about the possible import_result values.
{
"id":242,
"operation_type":"export",
"status":"completed",,
"download_url":"https://www.workato-staging-assets,com/packages/zip_files/000/000/242/original/importdemo.zip",
"recipe_status":[
{
"id": 12345,
"import_result": "no_update_or_update_without_restart"
},
{
"id": 12346,
"import_result": "restarted"
},
{
"id": 12347,
"import_result": "stopped"
}
]
}
# Recipe import_result values
There are a total of 6 possible results:
no_update_or_update_without_restart
- This indicates no restart was needed for the recipe. Either recipe could be updated without it or no update was made. Successful importnot_found
- Unexpected error when recipe cannot be found. Should not often be seen. Import has failed with no update to recipe.stop_failed
- For recipes that need to be restarted, we attempt to stop the recipe. This state indicates we could not stop the recipe. Import has failed with no update to recipe.stopped
- Workato stopped the recipe but recipe was not restarted due to errors in the recipe. Import has failed with recipe updated but not restartedrestart_failed
- Workato attempted to restart recipe but failed to do so. Import has failed with recipe updated but not restartedrestarted
- Workato successfully restarted recipe after update. Successful import
# Download package
Downloads a package.
GET /api/packages/:id/download
# URL parameters
Name | Type | Description |
---|---|---|
id | string required | Package ID. |
# Sample request
curl -L -X GET 'https://www.workato.com/api/packages/<package_id>/download' \
-H 'Authorization: Bearer <api_token>'
Follow redirects in cURL
Use the -L
flag to follow redirect paths.
# Response
If successful, you will be redirected to the package content. Returns 404
if package not found or doesn't have content.
Last updated: 9/13/2023, 4:48:18 PM