@directus/app 9.12.2 → 9.13.0

package/dist/assets/filter-rules.247581e5.js

@@ -0,0 +1,76 @@
+import{a as e,o as u,b as i,w as s,g as t,e as d,B as l}from"./runtime-core.esm-bundler.e6808e6c.js";const c={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[l("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),l(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),p=t("p",null,[t("div",{class:"table-of-contents"},[t("ul",null,[t("li",null,[t("a",{href:"#syntax"},"Syntax")]),t("li",null,[t("a",{href:"#filter-operators"},"Filter Operators")]),t("li",null,[t("a",{href:"#relational"},"Relational")]),t("li",null,[t("a",{href:"#logical-operators"},"Logical Operators")]),t("li",null,[t("a",{href:"#dynamic-variables"},"Dynamic Variables")])])])],-1),_=t("h2",{id:"syntax"},[l("Syntax "),t("a",{class:"header-anchor",href:"#syntax"},"#")],-1),f=t("ul",null,[t("li",null,[t("strong",null,"Field"),l(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),l(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),l(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),l(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),g=t("pre",null,[t("code",null,`{
+	<field>: {
+		<operator>: <value>
+	}
+}
+`)],-1),m=t("h3",{id:"examples"},[l("Examples "),t("a",{class:"header-anchor",href:"#examples"},"#")],-1),y=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"title"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_contains"'),l(": "),t("span",{class:"hljs-string"},'"Directus"'),l(`
+	}
+}
+`)])],-1),b=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"owner"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+	}
+}
+`)])],-1),v=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"datetime"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_lte"'),l(": "),t("span",{class:"hljs-string"},'"$NOW"'),l(`
+	}
+}
+`)])],-1),j=t("h2",{id:"filter-operators"},[l("Filter Operators "),t("a",{class:"header-anchor",href:"#filter-operators"},"#")],-1),R=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,[l("Operator Title "),t("em",null,"(in app)")]),t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,"Equals"),t("td",null,[t("code",null,"_eq")]),t("td",null,"Equal to")]),t("tr",null,[t("td",null,"Doesn\u2019t equal"),t("td",null,[t("code",null,"_neq")]),t("td",null,"Not equal to")]),t("tr",null,[t("td",null,"Less than"),t("td",null,[t("code",null,"_lt")]),t("td",null,"Less than")]),t("tr",null,[t("td",null,"Less than or equal to"),t("td",null,[t("code",null,"_lte")]),t("td",null,"Less than or equal to")]),t("tr",null,[t("td",null,"Greater than"),t("td",null,[t("code",null,"_gt")]),t("td",null,"Greater than")]),t("tr",null,[t("td",null,"Greater than or equal to"),t("td",null,[t("code",null,"_gte")]),t("td",null,"Greater than or equal to")]),t("tr",null,[t("td",null,"Is one of"),t("td",null,[t("code",null,"_in")]),t("td",null,"Matches any of the values")]),t("tr",null,[t("td",null,"Is not one of"),t("td",null,[t("code",null,"_nin")]),t("td",null,"Doesn\u2019t match any of the values")]),t("tr",null,[t("td",null,"Is null"),t("td",null,[t("code",null,"_null")]),t("td",null,[l("Is "),t("code",null,"null")])]),t("tr",null,[t("td",null,"Isn\u2019t null"),t("td",null,[t("code",null,"_nnull")]),t("td",null,[l("Is not "),t("code",null,"null")])]),t("tr",null,[t("td",null,"Contains"),t("td",null,[t("code",null,"_contains")]),t("td",null,"Contains the substring")]),t("tr",null,[t("td",null,"Doesn\u2019t contain"),t("td",null,[t("code",null,"_ncontains")]),t("td",null,"Doesn\u2019t contain the substring")]),t("tr",null,[t("td",null,"Starts with"),t("td",null,[t("code",null,"_starts_with")]),t("td",null,"Starts with")]),t("tr",null,[t("td",null,"Doesn\u2019t start with"),t("td",null,[t("code",null,"_nstarts_with")]),t("td",null,"Doesn\u2019t start with")]),t("tr",null,[t("td",null,"Ends with"),t("td",null,[t("code",null,"_ends_with")]),t("td",null,"Ends with")]),t("tr",null,[t("td",null,"Doesn\u2019t end with"),t("td",null,[t("code",null,"_nends_with")]),t("td",null,"Doesn\u2019t end with")]),t("tr",null,[t("td",null,"Is between"),t("td",null,[t("code",null,"_between")]),t("td",null,"Is between two values (inclusive)")]),t("tr",null,[t("td",null,"Isn\u2019t between"),t("td",null,[t("code",null,"_nbetween")]),t("td",null,"Is not between two values (inclusive)")]),t("tr",null,[t("td",null,"Is empty"),t("td",null,[t("code",null,"_empty")]),t("td",null,[l("Is empty ("),t("code",null,"null"),l(" or falsy)")])]),t("tr",null,[t("td",null,"Isn\u2019t empty"),t("td",null,[t("code",null,"_nempty")]),t("td",null,[l("Is not empty ("),t("code",null,"null"),l(" or falsy)")])]),t("tr",null,[t("td",null,"Intersects"),t("td",null,[t("code",null,"_intersects"),l(),t("sup",null,"[1]")]),t("td",null,"Value intersects a given point")]),t("tr",null,[t("td",null,"Doesn\u2019t intersect"),t("td",null,[t("code",null,"_nintersects"),l(),t("sup",null,"[1]")]),t("td",null,"Value does not intersect a given point")]),t("tr",null,[t("td",null,"Intersects Bounding box"),t("td",null,[t("code",null,"_intersects_bbox"),l(),t("sup",null,"[1]")]),t("td",null,"Value is in a bounding box")]),t("tr",null,[t("td",null,"Doesn\u2019t intersect bounding box"),t("td",null,[t("code",null,"_nintersects_bbox"),l(),t("sup",null,"[1]")]),t("td",null,"Value is not in a bounding box")])])],-1),w=t("p",null,[l("The following operator has no Title on the Filter Interface as it is "),t("strong",null,"only available in validation permissions"),l(":")],-1),x=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"_regex"),l(),t("sup",null,"[2]")]),t("td",null,"Field has to match regex")])])],-1),E=t("sup",null,"[1]",-1),N=l(" Only available on Geometry types.\\ "),O=t("sup",null,"[2]",-1),I=l(' JavaScript "flavor" regex. Make sure to escape backslashes. '),T=t("h2",{id:"relational"},[l("Relational "),t("a",{class:"header-anchor",href:"#relational"},"#")],-1),q=t("p",null,[l("You can target related values by nesting field names. For example, if you have a relational Many-to-One "),t("code",null,"author"),l(" field, you can set a rule for the "),t("code",null,"author.name"),l(" field using the following syntax.")],-1),D=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"author"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Rijk van Zanten"'),l(`
+		}
+	}
+}
+`)])],-1),U=t("h2",{id:"logical-operators"},[l("Logical Operators "),t("a",{class:"header-anchor",href:"#logical-operators"},"#")],-1),F=t("p",null,[l("You can nest or group multiple rules using the "),t("code",null,"_and"),l(" or "),t("code",null,"_or"),l(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),$=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"_or"'),l(`: [
+		{
+			`),t("span",{class:"hljs-attr"},'"_and"'),l(`: [
+				{
+					`),t("span",{class:"hljs-attr"},'"user_created"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+					}
+				},
+				{
+					`),t("span",{class:"hljs-attr"},'"status"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_in"'),l(": ["),t("span",{class:"hljs-string"},'"published"'),l(", "),t("span",{class:"hljs-string"},'"draft"'),l(`]
+					}
+				}
+			]
+		},
+		{
+			`),t("span",{class:"hljs-attr"},'"_and"'),l(`: [
+				{
+					`),t("span",{class:"hljs-attr"},'"user_created"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_neq"'),l(": "),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),l(`
+					}
+				},
+				{
+					`),t("span",{class:"hljs-attr"},'"status"'),l(`: {
+						`),t("span",{class:"hljs-attr"},'"_in"'),l(": ["),t("span",{class:"hljs-string"},'"published"'),l(`]
+					}
+				}
+			]
+		}
+	]
+}
+`)])],-1),C=t("h3",{id:"some-vs-none-in-one-to-many"},[l("Some vs None in One-to-Many "),t("a",{class:"header-anchor",href:"#some-vs-none-in-one-to-many"},"#")],-1),S=t("p",null,"When applying filters to a one-to-many field, Directus will default to a \u201Csome\u201D search, for example in:",-1),k=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"categories"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Recipe"'),l(`
+		}
+	}
+}
+`)])],-1),L=t("p",null,[l("the top level parent will be returned if "),t("em",null,"one of"),l(" the categories has the name "),t("code",null,"Recipe"),l(". This behavior can be overridden by using the explicit "),t("code",null,"_some"),l(" and "),t("code",null,"_none"),l(" operators, for example:")],-1),V=t("pre",null,[t("code",{class:"language-json"},[l(`{
+	`),t("span",{class:"hljs-attr"},'"categories"'),l(`: {
+		`),t("span",{class:"hljs-attr"},'"_none"'),l(`: {
+			`),t("span",{class:"hljs-attr"},'"name"'),l(`: {
+				`),t("span",{class:"hljs-attr"},'"_eq"'),l(": "),t("span",{class:"hljs-string"},'"Recipe"'),l(`
+			}
+		}
+	}
+}
+`)])],-1),W=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),A=t("h2",{id:"dynamic-variables"},[l("Dynamic Variables "),t("a",{class:"header-anchor",href:"#dynamic-variables"},"#")],-1),B=t("p",null,[l("In addition to static values, you can also filter against "),t("em",null,"dynamic"),l(" values using the following variables.")],-1),G=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),l(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),l(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),l(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),l(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),l(", "),t("code",null,"$NOW(+2 hours)")])],-1),M={class:"tip hint"},P=t("div",{class:"hint-title"},"Functions",-1),Y=l("You can also use "),J=l("Function Parameters"),z=l(" when building Filters."),H=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[l("When configuring permissions, "),t("code",null,"$CURRENT_USER"),l(" and "),t("code",null,"$CURRENT_ROLE"),l(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),l(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),l(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),tt="Filter Rules",lt=!1,nt={name:"filter-rules",setup(Z,{expose:a}){const n={title:"Filter Rules",modularExtension:!1};return a({frontmatter:n}),(K,Q)=>{const o=e("router-link"),r=e("docs-wrapper");return u(),i(r,{frontmatter:n},{default:s(()=>[t("div",c,[h,p,_,f,g,m,y,b,v,j,R,w,x,E,N,O,I,T,q,D,U,F,$,C,S,k,L,V,W,A,B,G,t("div",M,[P,t("p",null,[Y,d(o,{to:"/docs/reference/query/#functions"},{default:s(()=>[J]),_:1}),z])]),H])]),_:1})}}};export{nt as default,lt as modularExtension,tt as title};

package/dist/assets/filters.43e74661.js

@@ -0,0 +1 @@
+import{a as n,o as d,b as c,w as o,g as e,e as i,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.")],-1),_=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),p=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"},"How it Works")]),e("li",null,[e("a",{href:"#and%2For-groups"},"AND/OR Groups")]),e("li",null,[e("a",{href:"#dynamic-variables"},"Dynamic Variables")]),e("li",null,[e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections")]),e("li",null,[e("a",{href:"#unfilterable-fields"},"Unfilterable Fields")]),e("li",null,[e("a",{href:"#extensibility-options"},"Extensibility Options")]),e("li",null,[e("a",{href:"#more-help"},"More Help")])])])],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),y=t("This page is a non-technical guide to using Filters. For more technical info, see "),g=t("Filter-Rules"),b=t("."),w=e("h2",{id:"how-it-works"},[t("How it Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),F={class:"tip hint"},v=e("div",{class:"hint-title"},"Assumed Knowledge",-1),A=t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),k=t("(aka "),C=t("data model"),O=t(")"),x=t(" being filtered as well as any relevant "),R=t("Users, Roles and Permissions"),D=t("."),N=t("A basic filter is composed of 3 parts: A "),G=e("strong",null,"Field",-1),I=t(" from the Collection being Filtered, a logical "),V=t("Operator"),E=t(", and some specified "),H=e("strong",null,"Value",-1),T=t(" to filter for within each Item\u2019s Field."),U=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),W=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),S=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),B={class:"tip hint"},$=e("div",{class:"hint-title"},"Operators",-1),j=t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),P=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),q=t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),L=t("Filter Rules"),M=t(" document."),Y=e("h2",{id:"and%2For-groups"},[t("AND/OR Groups "),e("a",{class:"header-anchor",href:"#and%2For-groups"},"#")],-1),z=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),J=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),X=e("h2",{id:"dynamic-variables"},[t("Dynamic Variables "),e("a",{class:"header-anchor",href:"#dynamic-variables"},"#")],-1),Z=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),ee=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),te=t("The following Dynamic Variables are built into Directus to make Filtering easier: "),oe=e("code",null,"$CURRENT_USER",-1),le=t(", "),ie=e("code",null,"$CURRENT_ROLE",-1),se=t(", "),ne=e("code",null,"$NOW",-1),re=t(" and "),ae=e("code",null,"$NOW(<adjustment>)",-1),de=t(". For more information, please see the Dynamic Variables section in "),ce=t("Filter Rules"),ue=t("."),he=e("h2",{id:"filtering-by-related-collections"},[t("Filtering by Related Collections "),e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#")],-1),_e=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),pe=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),fe=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),me=t("You will notice a "),ye=e("span",{mi:"",icon:""},"chevron_right",-1),ge=t(" icon beside relational Fields. When you click on any "),be=t("Alias"),we=t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection."),Fe=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),ve=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),Ae=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),ke=e("h2",{id:"unfilterable-fields"},[t("Unfilterable Fields "),e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#")],-1),Ce=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),Oe=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),xe=e("h2",{id:"extensibility-options"},[t("Extensibility Options "),e("a",{class:"header-anchor",href:"#extensibility-options"},"#")],-1),Re=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),De=t("Extensions > Introduction"),Ne=t("Extensions > Creating Extensions"),Ge=t("Contributing > Introduction"),Ie=t("Contributing > Codebase Overview"),Ve=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Ee=e("h2",{id:"more-help"},[t("More Help "),e("a",{class:"header-anchor",href:"#more-help"},"#")],-1),He=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),Be="Filters",$e=!1,je={name:"filters",setup(Te,{expose:r}){const s={title:"Filters",modularExtension:!1};return r({frontmatter:s}),(Ue,We)=>{const l=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:s},{default:o(()=>[e("div",u,[h,_,p,e("div",f,[m,e("p",null,[y,i(l,{to:"/docs/reference/filter-rules/"},{default:o(()=>[g]),_:1}),b])]),w,e("div",F,[v,e("p",null,[A,e("em",null,[k,i(l,{to:"/docs/configuration/data-model/"},{default:o(()=>[C]),_:1}),O]),x,i(l,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[R]),_:1}),D])]),e("p",null,[N,G,I,i(l,{to:"/docs/reference/filter-rules/#filter-operators"},{default:o(()=>[V]),_:1}),E,H,T]),U,W,S,e("div",B,[$,e("p",null,[j,P,q,i(l,{to:"/docs/reference/filter-rules/#filter-operators"},{default:o(()=>[L]),_:1}),M])]),Y,z,K,J,Q,X,Z,ee,e("p",null,[te,oe,le,ie,se,ne,re,ae,de,i(l,{to:"/docs/reference/filter-rules/"},{default:o(()=>[ce]),_:1}),ue]),he,_e,pe,fe,e("p",null,[me,ye,ge,i(l,{to:"/docs/getting-started/glossary/#alias"},{default:o(()=>[be]),_:1}),we]),Fe,ve,Ae,ke,Ce,Oe,xe,Re,e("ul",null,[e("li",null,[i(l,{to:"/docs/extensions/introduction/"},{default:o(()=>[De]),_:1})]),e("li",null,[i(l,{to:"/docs/extensions/creating-extensions/"},{default:o(()=>[Ne]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/introduction/"},{default:o(()=>[Ge]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/codebase-overview/"},{default:o(()=>[Ie]),_:1})])]),Ve,Ee,He])]),_:1})}}};export{je as default,$e as modularExtension,Be as title};

package/dist/assets/flows.323ce75f.js

@@ -0,0 +1,15 @@
+import{a as l,o as c,b as d,w as o,g as e,e as n,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";const h={class:"markdown-body"},_=e("blockquote",null,[e("p",null,"Flows enable custom, event-driven data processing and task automation within Directus. Each Flow is composed of one Trigger, followed by a series of Operations.")],-1),u=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#what's-a-flow%3F"},"What's a Flow?")]),e("li",null,[e("a",{href:"#create-a-flow"},"Create a Flow")]),e("li",null,[e("a",{href:"#the-flow-object"},"The Flow Object")]),e("li",null,[e("a",{href:"#logs"},"Logs")])])])],-1),p={class:"tip hint"},w=e("div",{class:"hint-title"},"Learn More",-1),f=t("There is also dedicated API documentation on "),g=t("Flows"),m=t(" and "),b=t("Operations"),O=t("."),y=e("h2",{id:"what%E2%80%99s-a-flow%3F"},[t("What\u2019s a Flow? "),e("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#")],-1),F=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp",alt:"What's a Flow?"})],-1),v=t("Each Flow begins with one Trigger, which defines the actions that start the Flow. Triggers can be an event or action within the app, an incoming webhook, a cron job, or a manual click of a button. Please see the documentation on "),j=t("Triggers"),k=t(" for more details."),T=t("Operations are the actions performed after the Trigger. An operation can be creating new Items in a Collection, sending off emails, pushing "),A=e("em",null,"in-app",-1),x=t(" notifications, or sending webhooks, just to name a few. You can even set up divergent chains of Flow Operations, which execute conditionally, based on whether one Operation passed or failed. A "),C=t("console log"),S=t(" is also included to help design and troubleshoot your Flows and ensure data is passed on as intended. Check out the documentation on "),P=t("Operations"),N=t(" for more details."),E=e("p",null,[t("Once a Flow is triggered, Directus creates a "),e("a",{href:"#the-flow-object"},"Flow Object"),t(", which stores data from the Trigger event. As each Operation in the flow executes, the data generated is added onto this Flow Object, and every Operation in a Flow has access to it.")],-1),$=e("h2",{id:"create-a-flow"},[t("Create a Flow "),e("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),D=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Create a Flow"},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4",type:"video/mp4"})],-1),L=e("p",null,"To create a Flow, follow these steps:",-1),V=e("li",null,[t("Navigate to "),e("strong",null,"\u201CSettings > Flows\u201D"),t(" and click "),e("span",{mi:"",btn:""},"add"),t(" in the Page Header. A side menu will appear.")],-1),W=e("li",null,[t("Under "),e("strong",null,"Flow Setup"),t(", fill in a name for the Flow."),e("br"),t(" Optional: Set a status, material icon, description or color to help remember the Flow.")],-1),B=t("Select your "),J=e("strong",null,"Activity and Logs Tracking",-1),G=t(" preference as desired."),H=e("br",null,null,-1),I=t(" To learn more, please see "),Y=t("Activity"),q=t(" and "),M=t("Logs"),K=t("."),R=t("Click "),U=e("span",{mi:"",btn:""},"arrow_forward",-1),z=t(" to navigate to "),Q=e("strong",null,"Trigger Setup",-1),X=t(", select a "),Z=t("Trigger"),ee=t(" type and configure as desired."),te=e("li",null,[t("Click "),e("span",{mi:"",btn:""},"done"),t(" in the Menu Header to be taken to the Flow Grid Area."),e("br"),t(" You\u2019ll see the Trigger Panel on the Flow Grid.")],-1),oe=e("li",null,[t("On the Trigger Panel, click "),e("span",{mi:""},"add"),t(" and the "),e("strong",null,"Create Operation"),t(" side menu will open.")],-1),se=t("Choose a name and the "),ne=t("Operation"),ae=t(" type, and configure as desired."),le=e("br",null,null,-1),ie=t(" Directus will convert the unique name into an Operation Key, used on the "),re=e("a",{href:"#the-flow-object"},"Flow Object",-1),ce=t("."),de=e("br",null,null,-1),he=t(" If you don\u2019t choose a name, the system will auto-generate a name and key."),_e=e("li",null,[t("Next, click "),e("span",{mi:"",btn:""},"done"),t(" in the Page Header to confirm your choices and return to the Flow Grid Area.")],-1),ue=e("li",null,[t("On the newly created Operation Panel: "),e("ul",null,[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"add"),t(" to add an Operation to follow the successful execution of the current Operation.")]),e("li",null,[t("Click "),e("span",{mi:"",icon:""},"remove"),t(" to add an Operation should the current Operation fail.")])])],-1),pe=e("li",null,"Repeat steps 8-10 to add to your Flow.",-1),we=e("li",null,[e("strong",null,"Optional:"),t(" To edit a Trigger or Operation Panel, click "),e("span",{mi:"",icon:""},"edit"),t(" and make any necessary edits.")],-1),fe=e("li",null,[e("strong",null,"Optional:"),t(" To delete an Operation Panel, click "),e("span",{mi:"",icon:""},"more_vert"),t(" then "),e("span",{mi:"",icon:"",dngr:""},"delete"),t(".")],-1),ge=e("h2",{id:"the-flow-object"},[t("The Flow Object "),e("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),me=e("p",null,"When a Flow is triggered, Directus creates a JSON object to store all data generated within the Flow. When you create an Operation, this generates a key that appends to the Flow Object when the Operation executes. The key is used to add the associated Operation\u2019s data onto the Flows Object. As each Operation in the Flow executes, it has access to the Flow Object and therefore the data generated from preceding Operations.",-1),be=e("p",null,[t("The following JSON object is a simple example of a Flow with two Operations. The "),e("code",null,"$trigger"),t(", "),e("code",null,"$last"),t(", and "),e("code",null,"$accountability"),t(" keys are included on every Flow. An Operation key will be generated for each Operation that executes successfully.")],-1),Oe=e("pre",null,[e("code",{class:"language-JSON"},[t(`{
+   `),e("span",{class:"hljs-attr"},'"$trigger"'),t(": {}, "),e("span",{class:"hljs-comment"},"// Data generated by the Flow's Trigger."),t(`
+   `),e("span",{class:"hljs-attr"},'"$last"'),t(": "),e("span",{class:"hljs-literal"},"null"),t(", "),e("span",{class:"hljs-comment"},"// Data from the last Operation in the flow, for easy access!"),t(`
+   `),e("span",{class:"hljs-attr"},'"$accountability"'),t(": {}, "),e("span",{class:"hljs-comment"},"// Provides details on who/what tripped the Trigger and generated this Flow Object."),t(`
+   `),e("span",{class:"hljs-attr"},'"operation_key"'),t(": { "),e("span",{class:"hljs-comment"},"// The data (if any) generated by the first Operation."),t(`
+			`),e("span",{class:"hljs-attr"},'"some_nested_key"'),t(": "),e("span",{class:"hljs-string"},'"Some nested value."'),t(`,
+    },
+	`),e("span",{class:"hljs-attr"},'"operation_key_2"'),t(": "),e("span",{class:"hljs-literal"},"null"),t(", "),e("span",{class:"hljs-comment"},"// Value is null if no data was generated during an Operation."),t(`
+}
+`)])],-1),ye=e("h3",{id:"flow-variables"},[t("Flow Variables "),e("a",{class:"header-anchor",href:"#flow-variables"},"#")],-1),Fe=e("p",null,"The Flow Object keys serve as variables that allow data access from every Flow Operation. Variables must be passed using the following double-moustache syntax. You can even use dot-notation to extract sub-nested values.",-1),ve=e("pre",null,[e("code",{class:"language-JSON"},[t(`{
+   `),e("span",{class:"hljs-attr"},'"operation_key_3"'),t(`: {
+			`),e("span",{class:"hljs-attr"},'"user"'),t(": "),e("span",{class:"hljs-string"},'"{{ $accountability.user }}"'),t(`,
+	 }
+}
+`)])],-1),je=e("h2",{id:"logs"},[t("Logs "),e("a",{class:"header-anchor",href:"#logs"},"#")],-1),ke=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/logs-20220603A.mp4",type:"video/mp4"})],-1),Te=e("p",null,"Accessible from the Sidebar, Logs store information for each Flow execution. Each log will display information from Triggers as well as each Operation in the Flow.",-1),Pe="Flows",Ne=!1,Ee={name:"flows",setup(Ae,{expose:i}){const a={title:"Flows",modularExtension:!1};return i({frontmatter:a}),(xe,Ce)=>{const s=l("router-link"),r=l("docs-wrapper");return c(),d(r,{frontmatter:a},{default:o(()=>[e("div",h,[_,u,e("div",p,[w,e("p",null,[f,n(s,{to:"/docs/reference/system/flows"},{default:o(()=>[g]),_:1}),m,n(s,{to:"/docs/reference/system/operations"},{default:o(()=>[b]),_:1}),O])]),y,F,e("p",null,[v,n(s,{to:"/docs/configuration/flows/triggers"},{default:o(()=>[j]),_:1}),k]),e("p",null,[T,A,x,n(s,{to:"/docsconfiguration/flows/operations/#log-to-console"},{default:o(()=>[C]),_:1}),S,n(s,{to:"/docs/configuration/flows/operations"},{default:o(()=>[P]),_:1}),N]),E,$,D,L,e("ol",null,[V,W,e("li",null,[B,J,G,H,I,n(s,{to:"/docs/reference/system/activity/"},{default:o(()=>[Y]),_:1}),q,n(s,{to:"/docs/#logs"},{default:o(()=>[M]),_:1}),K]),e("li",null,[R,U,z,Q,X,n(s,{to:"/docsconfiguration/flows/triggers"},{default:o(()=>[Z]),_:1}),ee]),te,oe,e("li",null,[se,n(s,{to:"/docsconfiguration/flows/operations"},{default:o(()=>[ne]),_:1}),ae,le,ie,re,ce,de,he]),_e,ue,pe,we,fe]),ge,me,be,Oe,ye,Fe,ve,je,ke,Te])]),_:1})}}};export{Ee as default,Ne as modularExtension,Pe as title};

package/dist/assets/{flows.22228af1.js → flows.5f5e16d5.js}

@@ -1,4 +1,4 @@
-import{a as n,o as h,b as d,w as a,g as s,e as l,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var o={};const i={class:"markdown-body"},p=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-flow-object"},"The Flow Object")]),s("li",null,[s("a",{href:"#list-flows"},"List Flows")]),s("li",null,[s("a",{href:"#retrieve-a-flow"},"Retrieve a flow")]),s("li",null,[s("a",{href:"#create-a-flow"},"Create a Flow")]),s("li",null,[s("a",{href:"#create-multiple-flows"},"Create Multiple Flows")]),s("li",null,[s("a",{href:"#update-a-flow"},"Update a Flow")]),s("li",null,[s("a",{href:"#update-multiple-flows"},"Update Multiple Flows")]),s("li",null,[s("a",{href:"#delete-a-flow"},"Delete a Flow")]),s("li",null,[s("a",{href:"#delete-multiple-flows"},"Delete Multiple Flows")]),s("li",null,[s("a",{href:"#flow-with-get-webhook-trigger"},"Flow with GET webhook trigger")]),s("li",null,[s("a",{href:"#flow-with-post-webhook-trigger"},"Flow with POST webhook trigger")])])])])])],-1),u=s("hr",null,null,-1),f=s("h2",{id:"the-flow-object"},[e("The Flow Object "),s("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),_={class:"two-up"},g={class:"left"},w={class:"definitions"},m=s("p",null,[s("code",{class:""},"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the flow.")],-1),j=s("p",null,[s("code",{class:""},"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the flow.")],-1),y=s("p",null,[s("code",{class:""},"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon displayed in the Admin App for the flow.")],-1),b=s("p",null,[s("code",{class:""},"color"),e(),s("strong",null,"string"),s("br"),e(" Color of the icon displayed in the Admin App for the flow.")],-1),q=s("p",null,[s("code",{class:""},"note"),e(),s("strong",null,"text"),s("br"),e(" Short description displayed in the Admin App.")],-1),x=s("p",null,[s("code",{class:""},"status"),e(),s("strong",null,"string"),s("br"),e(" Current status of the flow. One of "),s("code",{class:""},"active"),e(", "),s("code",{class:""},"inactive"),e(". Defaults to "),s("code",{class:""},"active"),e(" when not specified.")],-1),v=s("p",null,[s("code",{class:""},"trigger"),e(),s("strong",null,"string"),s("br"),e(" Type of trigger for the flow. One of "),s("code",{class:""},"hook"),e(", "),s("code",{class:""},"webhook"),e(", "),s("code",{class:""},"operation"),e(", "),s("code",{class:""},"schedule"),e(", "),s("code",{class:""},"manual"),e(".")],-1),E=s("p",null,[s("code",{class:""},"options"),e(),s("strong",null,"json"),s("br"),e(" Options of the selected trigger for the flow.")],-1),T=s("p",null,[s("code",{class:""},"accountability"),e(),s("strong",null,"string"),s("br"),e(" The permission used during the flow. One of "),s("code",{class:""},"$public"),e(", "),s("code",{class:""},"$trigger"),e(", "),s("code",{class:""},"$full"),e(", or UUID of a role.")],-1),k=s("p",null,[s("code",{class:""},"date_created"),e(),s("strong",null,"timestamp"),s("br"),e(" Timestamp in ISO8601 when the flow was created.")],-1),P=s("code",{class:""},"user_created",-1),S=e(),R=s("strong",null,"many-to-one",-1),F=s("br",null,null,-1),A=e(" The user who created the flow. Many-to-one to "),O=e("users"),D=e("."),I=s("p",null,[s("code",{class:""},"operation"),e(),s("strong",null,"string"),s("br"),e(" UUID of the operation connected to the trigger in the flow.")],-1),M=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
+import{a as o,o as c,b as d,w as l,g as s,e as a,B as e}from"./runtime-core.esm-bundler.e6808e6c.js";const i={class:"markdown-body"},p=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-flow-object"},"The Flow Object")]),s("li",null,[s("a",{href:"#list-flows"},"List Flows")]),s("li",null,[s("a",{href:"#retrieve-a-flow"},"Retrieve a flow")]),s("li",null,[s("a",{href:"#create-a-flow"},"Create a Flow")]),s("li",null,[s("a",{href:"#create-multiple-flows"},"Create Multiple Flows")]),s("li",null,[s("a",{href:"#update-a-flow"},"Update a Flow")]),s("li",null,[s("a",{href:"#update-multiple-flows"},"Update Multiple Flows")]),s("li",null,[s("a",{href:"#delete-a-flow"},"Delete a Flow")]),s("li",null,[s("a",{href:"#delete-multiple-flows"},"Delete Multiple Flows")]),s("li",null,[s("a",{href:"#flow-with-get-webhook-trigger"},"Flow with GET webhook trigger")]),s("li",null,[s("a",{href:"#flow-with-post-webhook-trigger"},"Flow with POST webhook trigger")])])])])])],-1),u=s("hr",null,null,-1),f=s("h2",{id:"the-flow-object"},[e("The Flow Object "),s("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),_={class:"two-up"},g={class:"left"},w={class:"definitions"},m=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the flow.")],-1),j=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the flow.")],-1),y=s("p",null,[s("code",null,"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon displayed in the Admin App for the flow.")],-1),b=s("p",null,[s("code",null,"color"),e(),s("strong",null,"string"),s("br"),e(" Color of the icon displayed in the Admin App for the flow.")],-1),q=s("p",null,[s("code",null,"note"),e(),s("strong",null,"text"),s("br"),e(" Short description displayed in the Admin App.")],-1),x=s("p",null,[s("code",null,"status"),e(),s("strong",null,"string"),s("br"),e(" Current status of the flow. One of "),s("code",null,"active"),e(", "),s("code",null,"inactive"),e(". Defaults to "),s("code",null,"active"),e(" when not specified.")],-1),v=s("p",null,[s("code",null,"trigger"),e(),s("strong",null,"string"),s("br"),e(" Type of trigger for the flow. One of "),s("code",null,"hook"),e(", "),s("code",null,"webhook"),e(", "),s("code",null,"operation"),e(", "),s("code",null,"schedule"),e(", "),s("code",null,"manual"),e(".")],-1),E=s("p",null,[s("code",null,"options"),e(),s("strong",null,"json"),s("br"),e(" Options of the selected trigger for the flow.")],-1),T=s("p",null,[s("code",null,"accountability"),e(),s("strong",null,"string"),s("br"),e(" The permission used during the flow. One of "),s("code",null,"$public"),e(", "),s("code",null,"$trigger"),e(", "),s("code",null,"$full"),e(", or UUID of a role.")],-1),k=s("p",null,[s("code",null,"date_created"),e(),s("strong",null,"timestamp"),s("br"),e(" Timestamp in ISO8601 when the flow was created.")],-1),P=s("code",null,"user_created",-1),S=e(),R=s("strong",null,"many-to-one",-1),F=s("br",null,null,-1),A=e(" The user who created the flow. Many-to-one to "),O=e("users"),D=e("."),I=s("p",null,[s("code",null,"operation"),e(),s("strong",null,"string"),s("br"),e(" UUID of the operation connected to the trigger in the flow.")],-1),M=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
 	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"2fab3b9d-0543-4b87-8a30-3c5ee66fedf1"'),e(`,
 	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
 	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"bolt"'),e(`,
@@ -11,10 +11,10 @@ import{a as n,o as h,b as d,w as a,g as s,e as l,B as e}from"./runtime-core.esm-
 	`),s("span",{class:"hljs-attr"},'"user_created"'),e(": "),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),e(`,
 	`),s("span",{class:"hljs-attr"},'"operation"'),e(": "),s("span",{class:"hljs-string"},'"92e82998-e421-412f-a513-13701e83e4ce"'),e(`
 }
-`)])])],-1),C=s("hr",null,null,-1),L=s("h2",{id:"list-flows"},[e("List Flows "),s("a",{class:"header-anchor",href:"#list-flows"},"#")],-1),G=s("p",null,"List all flows that exist in Directus.",-1),Q={class:"two-up"},U={class:"left"},B=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),H=e("Supports all "),N=e("global query parameters"),$=e("."),V=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),Z=e("An array of up to "),z=e("limit"),J=e(),K=s("a",{href:"#the-flow-object"},"flow objects",-1),W=e(". If no items are available, data will be an empty array."),X={class:"right"},Y=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),ss=s("pre",null,[s("code",{class:""},`GET /flows
+`)])])],-1),C=s("hr",null,null,-1),L=s("h2",{id:"list-flows"},[e("List Flows "),s("a",{class:"header-anchor",href:"#list-flows"},"#")],-1),G=s("p",null,"List all flows that exist in Directus.",-1),Q={class:"two-up"},U={class:"left"},B=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),H=e("Supports all "),N=e("global query parameters"),$=e("."),V=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),Z=e("An array of up to "),z=e("limit"),J=e(),K=s("a",{href:"#the-flow-object"},"flow objects",-1),W=e(". If no items are available, data will be an empty array."),X={class:"right"},Y=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),ss=s("pre",null,[s("code",null,`GET /flows
 SEARCH /flows
-`)],-1),es=e("Learn more about SEARCH ->"),as=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ts=s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)],-1),ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+`)],-1),es=e("Learn more about SEARCH ->"),ls=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ts=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),as=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	flows: [directus_flows]
 }
 `)])],-1),ns=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
@@ -24,9 +24,9 @@ SEARCH /flows
 		status
 	}
 }
-`)])],-1),rs=s("hr",null,null,-1),cs=s("h2",{id:"retrieve-a-flow"},[e("Retrieve a flow "),s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#")],-1),hs=s("p",null,"List an existing flow by primary key.",-1),ds={class:"two-up"},is={class:"left"},ps=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),us=e("Supports all "),fs=e("global query parameters"),_s=e("."),gs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ws=s("p",null,[e("Returns the requested "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),ms=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /flows/:id
-`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
-`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])],-1),rs=s("hr",null,null,-1),hs=s("h2",{id:"retrieve-a-flow"},[e("Retrieve a flow "),s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#")],-1),cs=s("p",null,"List an existing flow by primary key.",-1),ds={class:"two-up"},is={class:"left"},ps=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),us=e("Supports all "),fs=e("global query parameters"),_s=e("."),gs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ws=s("p",null,[e("Returns the requested "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),ms=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /flows/:id
+`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",null,`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
+`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
 	flows_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_flows
 }
@@ -37,7 +37,7 @@ SEARCH /flows
 		status
 	}
 }
-`)])])],-1),js=s("hr",null,null,-1),ys=s("h2",{id:"create-a-flow"},[e("Create a Flow "),s("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),bs=s("p",null,"Create a new flow.",-1),qs={class:"two-up"},xs={class:"left"},vs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Es=e("Supports all "),Ts=e("global query parameters"),ks=e("."),Ps=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),Rs=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),As=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /flows
+`)])])],-1),js=s("hr",null,null,-1),ys=s("h2",{id:"create-a-flow"},[e("Create a Flow "),s("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),bs=s("p",null,"Create a new flow.",-1),qs={class:"two-up"},xs={class:"left"},vs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Es=e("Supports all "),Ts=e("global query parameters"),ks=e("."),Ps=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),Rs=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),As=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /flows
 `)]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
 
 {
@@ -45,7 +45,7 @@ SEARCH /flows
 	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
 	`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
 }
-`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
 	create_flows_item(data: create_directus_flows_input!): directus_flows
 }
@@ -56,7 +56,7 @@ SEARCH /flows
 		status
 	}
 }
-`)])])],-1),Os=s("hr",null,null,-1),Ds=s("h2",{id:"create-multiple-flows"},[e("Create Multiple Flows "),s("a",{class:"header-anchor",href:"#create-multiple-flows"},"#")],-1),Is=s("p",null,"Create multiple new flows.",-1),Ms={class:"two-up"},Cs={class:"left"},Ls=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Gs=e("Supports all "),Qs=e("global query parameters"),Us=e("."),Bs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Hs=s("p",null,[e("An array of partial "),s("a",{href:"#the-flow-object"},"flow objects"),e(".")],-1),Ns=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),$s=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),Vs=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /flows
+`)])])],-1),Os=s("hr",null,null,-1),Ds=s("h2",{id:"create-multiple-flows"},[e("Create Multiple Flows "),s("a",{class:"header-anchor",href:"#create-multiple-flows"},"#")],-1),Is=s("p",null,"Create multiple new flows.",-1),Ms={class:"two-up"},Cs={class:"left"},Ls=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Gs=e("Supports all "),Qs=e("global query parameters"),Us=e("."),Bs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Hs=s("p",null,[e("An array of partial "),s("a",{href:"#the-flow-object"},"flow objects"),e(".")],-1),Ns=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),$s=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),Vs=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`POST /flows
 `)]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
 
 [
@@ -71,7 +71,7 @@ SEARCH /flows
 		`),s("span",{class:"hljs-attr"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"webhook"'),e(`
 	}
 ]
-`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
 	create_flows_items(data: [create_directus_flows_input!]!): [directus_flows]
 }
@@ -95,13 +95,13 @@ SEARCH /flows
 		status
 	}
 }
-`)])])],-1),Zs=s("hr",null,null,-1),zs=s("h2",{id:"update-a-flow"},[e("Update a Flow "),s("a",{class:"header-anchor",href:"#update-a-flow"},"#")],-1),Js=s("p",null,"Update an existing flow.",-1),Ks={class:"two-up"},Ws={class:"left"},Xs=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ys=e("Supports all "),se=e("global query parameters"),ee=e("."),ae=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),te=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),le=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ne=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the updated flow.")],-1),oe=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /flows/:id
+`)])])],-1),Zs=s("hr",null,null,-1),zs=s("h2",{id:"update-a-flow"},[e("Update a Flow "),s("a",{class:"header-anchor",href:"#update-a-flow"},"#")],-1),Js=s("p",null,"Update an existing flow.",-1),Ks={class:"two-up"},Ws={class:"left"},Xs=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ys=e("Supports all "),se=e("global query parameters"),ee=e("."),le=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),te=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),ae=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ne=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the updated flow.")],-1),oe=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`PATCH /flows/:id
 `)]),s("h5",{id:"example-8"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2"),e(`
 
 {
 	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(`
 }
-`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
 	update_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_flows_input): directus_flows
 }
@@ -111,7 +111,7 @@ SEARCH /flows
 		name
 	}
 }
-`)])])],-1),re=s("hr",null,null,-1),ce=s("h2",{id:"update-multiple-flows"},[e("Update Multiple Flows "),s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#")],-1),he=s("p",null,"Update multiple existing flows.",-1),de={class:"two-up"},ie={class:"left"},pe=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ue=e("Supports all "),fe=e("global query parameters"),_e=e("."),ge=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),we=s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the flows you\u2019d like to update.")]),s("p",null,[s("code",{class:""},"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-flow-object"},"the flow object"),e("\u2019s properties.")])],-1),me=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),je=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow objects"),e(" for the updated flows.")],-1),ye=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /flows
+`)])])],-1),re=s("hr",null,null,-1),he=s("h2",{id:"update-multiple-flows"},[e("Update Multiple Flows "),s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#")],-1),ce=s("p",null,"Update multiple existing flows.",-1),de={class:"two-up"},ie={class:"left"},pe=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ue=e("Supports all "),fe=e("global query parameters"),_e=e("."),ge=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),we=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the flows you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-flow-object"},"the flow object"),e("\u2019s properties.")])],-1),me=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),je=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow objects"),e(" for the updated flows.")],-1),ye=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`PATCH /flows
 `)]),s("h5",{id:"example-10"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows"),e(`
 
 {
@@ -120,7 +120,7 @@ SEARCH /flows
 		`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"inactive"'),e(`
 	}
 }
-`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
 	update_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_flows_input): [directus_flows]
 }
@@ -134,9 +134,9 @@ SEARCH /flows
 		status
 	}
 }
-`)])])],-1),be=s("hr",null,null,-1),qe=s("h2",{id:"delete-a-flow"},[e("Delete a Flow "),s("a",{class:"header-anchor",href:"#delete-a-flow"},"#")],-1),xe=s("p",null,"Delete an existing flow.",-1),ve=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /flows/:id
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
-`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])])],-1),be=s("hr",null,null,-1),qe=s("h2",{id:"delete-a-flow"},[e("Delete a Flow "),s("a",{class:"header-anchor",href:"#delete-a-flow"},"#")],-1),xe=s("p",null,"Delete an existing flow.",-1),ve=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`DELETE /flows/:id
+`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",null,`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
+`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
 	delete_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
 }
@@ -145,10 +145,10 @@ SEARCH /flows
 		id
 	}
 }
-`)])])])],-1),Ee=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-flows"},[e("Delete Multiple Flows "),s("a",{class:"header-anchor",href:"#delete-multiple-flows"},"#")],-1),ke=s("p",null,"Delete multiple existing flows.",-1),Pe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of flows primary keys"),s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /flows
+`)])])])],-1),Ee=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-flows"},[e("Delete Multiple Flows "),s("a",{class:"header-anchor",href:"#delete-multiple-flows"},"#")],-1),ke=s("p",null,"Delete multiple existing flows.",-1),Pe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of flows primary keys"),s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",null,`DELETE /flows
 `)]),s("h5",{id:"example-14"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /flows"),e(`
 [`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),e(", "),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),e(", "),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(`]
-`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
+`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
 `)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
 	delete_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
 }
@@ -163,10 +163,10 @@ SEARCH /flows
 		ids
 	}
 }
-`)])])])],-1),Se=s("h2",{id:"flow-with-get-webhook-trigger"},[e("Flow with GET webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-get-webhook-trigger"},"#")],-1),Re=s("p",null,"Start a flow with GET webhook trigger.",-1),Fe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",{class:""},`GET /flows/trigger/:flow_uuid
+`)])])])],-1),Se=s("h2",{id:"flow-with-get-webhook-trigger"},[e("Flow with GET webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-get-webhook-trigger"},"#")],-1),Re=s("p",null,"Start a flow with GET webhook trigger.",-1),Fe=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",null,`GET /flows/trigger/:flow_uuid
 `)]),s("h5",{id:"example-16"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// GET /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
 `),s("span",{class:"hljs-comment"},"// Payload here"),e(`
-`)])])])],-1),Ae=s("h2",{id:"flow-with-post-webhook-trigger"},[e("Flow with POST webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#")],-1),Oe=s("p",null,"Start a flow with POST webhook trigger.",-1),De=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")]),s("p",null,"Payload for the POST request."),s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",{class:""},`POST /flows/trigger/:flow_uuid
+`)])])])],-1),Ae=s("h2",{id:"flow-with-post-webhook-trigger"},[e("Flow with POST webhook trigger "),s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#")],-1),Oe=s("p",null,"Start a flow with POST webhook trigger.",-1),De=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")]),s("p",null,"Payload for the POST request."),s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",null,`POST /flows/trigger/:flow_uuid
 `)]),s("h5",{id:"example-17"},[e("Example "),s("a",{class:"header-anchor",href:"#example-17"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
 `),s("span",{class:"hljs-comment"},"// Payload here"),e(`
-`)])])])],-1),Ie={title:"Flows",modularExtension:!1,pageClass:"page-reference"},Me={name:"flows",setup(Ce,{expose:r}){return r({frontmatter:{title:"Flows",modularExtension:!1,pageClass:"page-reference"}}),(Le,Ge)=>{const t=n("router-link"),c=n("docswrapper");return h(),d(c,{frontmatter:Ie},{default:a(()=>[s("div",i,[p,u,f,s("div",_,[s("div",g,[s("div",w,[m,j,y,b,q,x,v,E,T,k,s("p",null,[P,S,R,F,A,l(t,{to:"/docs/reference/system/users/#the-users-object"},{default:a(()=>[O]),_:1}),D]),I])]),M]),C,L,G,s("div",Q,[s("div",U,[B,s("p",null,[H,l(t,{to:"/docs/reference/query"},{default:a(()=>[N]),_:1}),$]),V,s("p",null,[Z,l(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[z]),_:1}),J,K,W])]),s("div",X,[Y,ss,s("p",null,[l(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[es]),_:1})]),as,ts,ls,ns,os])]),rs,cs,hs,s("div",ds,[s("div",is,[ps,s("p",null,[us,l(t,{to:"/docs/reference/query"},{default:a(()=>[fs]),_:1}),_s]),gs,ws]),ms]),js,ys,bs,s("div",qs,[s("div",xs,[vs,s("p",null,[Es,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ts]),_:1}),ks]),Ps,Ss,Rs,Fs]),As]),Os,Ds,Is,s("div",Ms,[s("div",Cs,[Ls,s("p",null,[Gs,l(t,{to:"/docs/reference/query"},{default:a(()=>[Qs]),_:1}),Us]),Bs,Hs,Ns,$s]),Vs]),Zs,zs,Js,s("div",Ks,[s("div",Ws,[Xs,s("p",null,[Ys,l(t,{to:"/docs/reference/query"},{default:a(()=>[se]),_:1}),ee]),ae,te,le,ne]),oe]),re,ce,he,s("div",de,[s("div",ie,[pe,s("p",null,[ue,l(t,{to:"/docs/reference/query"},{default:a(()=>[fe]),_:1}),_e]),ge,we,me,je]),ye]),be,qe,xe,ve,Ee,Te,ke,Pe,Se,Re,Fe,Ae,Oe,De])]),_:1})}}};typeof o=="function"&&o(Me);export{Me as default,Ie as frontmatter};
+`)])])])],-1),Ge="Flows",Qe=!1,Ue="page-reference",Be={name:"flows",setup(Ie,{expose:r}){const n={title:"Flows",modularExtension:!1,pageClass:"page-reference"};return r({frontmatter:n}),(Me,Ce)=>{const t=o("router-link"),h=o("docs-wrapper");return c(),d(h,{frontmatter:n},{default:l(()=>[s("div",i,[p,u,f,s("div",_,[s("div",g,[s("div",w,[m,j,y,b,q,x,v,E,T,k,s("p",null,[P,S,R,F,A,a(t,{to:"/docs/reference/system/users/#the-users-object"},{default:l(()=>[O]),_:1}),D]),I])]),M]),C,L,G,s("div",Q,[s("div",U,[B,s("p",null,[H,a(t,{to:"/docs/reference/query"},{default:l(()=>[N]),_:1}),$]),V,s("p",null,[Z,a(t,{to:"/docs/reference/query/#limit"},{default:l(()=>[z]),_:1}),J,K,W])]),s("div",X,[Y,ss,s("p",null,[a(t,{to:"/docs/reference/introduction/#search-http-method"},{default:l(()=>[es]),_:1})]),ls,ts,as,ns,os])]),rs,hs,cs,s("div",ds,[s("div",is,[ps,s("p",null,[us,a(t,{to:"/docs/reference/query"},{default:l(()=>[fs]),_:1}),_s]),gs,ws]),ms]),js,ys,bs,s("div",qs,[s("div",xs,[vs,s("p",null,[Es,a(t,{to:"/docs/reference/query"},{default:l(()=>[Ts]),_:1}),ks]),Ps,Ss,Rs,Fs]),As]),Os,Ds,Is,s("div",Ms,[s("div",Cs,[Ls,s("p",null,[Gs,a(t,{to:"/docs/reference/query"},{default:l(()=>[Qs]),_:1}),Us]),Bs,Hs,Ns,$s]),Vs]),Zs,zs,Js,s("div",Ks,[s("div",Ws,[Xs,s("p",null,[Ys,a(t,{to:"/docs/reference/query"},{default:l(()=>[se]),_:1}),ee]),le,te,ae,ne]),oe]),re,he,ce,s("div",de,[s("div",ie,[pe,s("p",null,[ue,a(t,{to:"/docs/reference/query"},{default:l(()=>[fe]),_:1}),_e]),ge,we,me,je]),ye]),be,qe,xe,ve,Ee,Te,ke,Pe,Se,Re,Fe,Ae,Oe,De])]),_:1})}}};export{Be as default,Qe as modularExtension,Ue as pageClass,Ge as title};