latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

recipes

Lists all Recipes which are available in the specified Workspace Id

You need workspace memberships to access this resource

get/recipes

Query parameters

page[size]integer

Amount of items per page

page[number]integer

Number of page you want to display

workspace_idstring required
Example:workspace_id

An Id of the Workspace

include'recipe-deployments'

Include related objects

searchstring
Example:webhook

Search recipes by a word or a phrase contained in a title. Behavior is similar to operator LIKE in SQL. Case insensitive. Leading/following spaces are trimmed

Response

OK

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/recipes/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "allow_modification": true,
        "declarations": {
          "variables": [
            {
              "id": "petStatus",
              "title": "Status of the pet to get",
              "help": {
                "description": "Every pet in our store has a status. Please enter your favourite status.",
                "link": "http://test.com/recipes/12345"
              }
            }
          ],
          "credentials": [
            {
              "id": "petstore",
              "help": {
                "description": "Credentials to access your Petstore"
              }
            }
          ],
          "topics": [
            {
              "id": "topic-1"
            }
          ]
        },
        "info": {
          "title": "My simple recipe",
          "author": "John Doe",
          "short_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
        },
        "flow_templates": [
          {
            "title": "My first flow template",
            "cron": "*/9 * * * *",
            "type": "ordinary",
            "graph": {
              "nodes": [
                {
                  "name": "step_1",
                  "description": "Retrieve pets with status pending",
                  "command": "core/petStore:getPetsByStatusWithDynamicSelectModel@c0a749a85eb62b322704055cfca29649ffad64ed",
                  "id": "step_1",
                  "data_sample": "f4c8fd34-09b7-46e9-827a-8e5ee6c897cb",
                  "credentials_id": "petstore",
                  "pub_sub_id": "topic-1"
                }
              ],
              "edges": [
                {
                  "config": {
                    "mapper_type": "jsonata",
                    "mapper": "{\"name\": pets[0].name,\"status\": pets[0].status,\"newDynamicField\": pets[0].id}",
                    "condition": "$getPassthrough().step_1.body.status=\"pending\""
                  }
                }
              ]
            }
          }
        ],
        "created_at": "2021-12-10T10:29:15.008Z",
        "updated_at": "2021-12-10T14:40:03.389Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/users/5b4f337bff4304610483ba67"
          }
        },
        "workspace": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/workspaces/5b4f337bff4304610483ba67"
          }
        },
        "contract": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/contracts/5b4f337bff4304610483ba67"
          }
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 12,
    "total": 746,
    "total_pages": 63
  },
  "included": [
    {
      "data": {
        "id": "5b4f337bff4304610483ba67",
        "links": {
          "self": "/v2/recipe_deployment/5b4f337bff4304610483ba67"
        },
        "attributes": {
          "name": "My simple recipe deployment",
          "recipe_version": 3,
          "flows": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ],
          "created_at": "2021-12-10T10:29:15.008Z",
          "updated_at": "2021-12-10T14:40:03.389Z"
        },
        "relationships": {
          "recipe": {
            "data": {
              "id": "5b4f337bff4304610483ba67"
            },
            "links": {
              "self": "/v2/recipes/5b4f337bff4304610483ba67"
            }
          },
          "workspace": {
            "data": {
              "id": "5b4f337bff4304610483ba67"
            },
            "links": {
              "self": "/v2/workspaces/5b4f337bff4304610483ba67"
            }
          }
        }
      }
    }
  ]
}