@directus/app 9.18.0 → 9.19.0

package/dist/assets/flows.2353e1e2.js

@@ -0,0 +1,172 @@
+import{a as o,o as h,b as i,w as t,l as s,E as e,e as n}from"./runtime-core.esm-bundler.fe249c5c.js";const d={class:"markdown-body"},p=s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")],-1),u=s("hr",null,null,-1),_=s("h2",{id:"the-flow-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-flow-object"},"#"),e(" The Flow Object")],-1),f=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the flow.")],-1),g=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the flow.")],-1),j=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),m=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),w=s("p",null,[s("code",null,"note"),e(),s("strong",null,"text"),s("br"),e(" Short description displayed in the Admin App.")],-1),b=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),y=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),x=s("p",null,[s("code",null,"options"),e(),s("strong",null,"json"),s("br"),e(" Options of the selected trigger for the flow.")],-1),q=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),E=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),T=s("code",null,"user_created",-1),P=s("strong",null,"many-to-one",-1),k=s("br",null,null,-1),S=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),R=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2fab3b9d-0543-4b87-8a30-3c5ee66fedf1"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"bolt"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"color"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"#112233"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Note for my flow"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"manual"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"accountability"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"$trigger"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"date_created"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2022-05-11T13:14:52Z"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"user_created"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"operation"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"92e82998-e421-412f-a513-13701e83e4ce"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),A=s("hr",null,null,-1),F=s("h2",{id:"list-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-flows"},"#"),e(" List Flows")],-1),O=s("p",null,"List all flows that exist in Directus.",-1),I=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),e(" Query Parameters")],-1),v=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),e(" Returns")],-1),D=s("a",{href:"#the-flow-object"},"flow objects",-1),L=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),e(" REST API")],-1),Q=s("pre",null,[s("code",null,`GET /flows
+SEARCH /flows
+`)],-1),G=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),e(" GraphQL")],-1),M=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),C=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),U=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),e(" Example")],-1),B=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	flows {
+		id
+		name
+		status
+	}
+}
+`)])],-1),H=s("hr",null,null,-1),N=s("h2",{id:"retrieve-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#"),e(" Retrieve a flow")],-1),$=s("p",null,"List an existing flow by primary key.",-1),V=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),e(" Query Parameters")],-1),Z=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),e(" Returns")],-1),z=s("p",null,[e("Returns the requested "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),J=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),e(" REST API")],-1),K=s("pre",null,[s("code",null,`GET /flows/:id
+`)],-1),W=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),e(" Example")],-1),X=s("pre",null,[s("code",null,`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
+`)],-1),Y=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),e(" GraphQL")],-1),ss=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),es=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
+}
+`)])],-1),ts=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),e(" Example")],-1),as=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	flows_by_id(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),e(`) {
+		id
+		name
+		status
+	}
+}
+`)])],-1),ns=s("hr",null,null,-1),ls=s("h2",{id:"create-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-flow"},"#"),e(" Create a Flow")],-1),os=s("p",null,"Create a new flow.",-1),rs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),e(" Query Parameters")],-1),cs=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),e(" Request Body")],-1),hs=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),is=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),e(" Returns")],-1),ds=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),ps=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),e(" REST API")],-1),us=s("pre",null,[s("code",null,`POST /flows
+`)],-1),_s=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),e(" Example")],-1),fs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"manual"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),gs=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),e(" GraphQL")],-1),js=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),ms=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
+}
+`)])],-1),ws=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),e(" Example")],-1),bs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_flows_item(data: { name: `),s("span",{class:"hljs-string"},'"My Flow"'),e(", status: "),s("span",{class:"hljs-string"},'"active"'),e(", trigger: "),s("span",{class:"hljs-string"},'"manual"'),e(` }) {
+		id
+		name
+		status
+	}
+}
+`)])],-1),ys=s("hr",null,null,-1),xs=s("h2",{id:"create-multiple-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-flows"},"#"),e(" Create Multiple Flows")],-1),qs=s("p",null,"Create multiple new flows.",-1),Es=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),e(" Query Parameters")],-1),Ts=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),e(" Request Body")],-1),Ps=s("p",null,[e("An array of partial "),s("a",{href:"#the-flow-object"},"flow objects"),e(".")],-1),ks=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),e(" Returns")],-1),Ss=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the created flow.")],-1),Rs=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),e(" REST API")],-1),As=s("pre",null,[s("code",null,`POST /flows
+`)],-1),Fs=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),e(" Example")],-1),Os=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"["),e(`
+	`),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"manual"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Another Flow"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),e(`
+		`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"webhook"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"]"),e(`
+`)])],-1),Is=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),e(" GraphQL")],-1),vs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ds=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]
+}
+`)])],-1),Ls=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),e(" Example")],-1),Qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_flows_items(
+		data: [
+			{
+				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Flow"'),e(`,
+				`),s("span",{class:"hljs-string"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+				`),s("span",{class:"hljs-string"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"manual"'),e(`
+			},
+			{
+				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Another Flow"'),e(`,
+				`),s("span",{class:"hljs-string"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+				`),s("span",{class:"hljs-string"},'"trigger"'),e(": "),s("span",{class:"hljs-string"},'"webhook"'),e(`
+			}
+		]
+	) {
+		id
+		name
+		status
+	}
+}
+`)])],-1),Gs=s("hr",null,null,-1),Ms=s("h2",{id:"update-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-flow"},"#"),e(" Update a Flow")],-1),Cs=s("p",null,"Update an existing flow.",-1),Us=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),e(" Query Parameters")],-1),Bs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),e(" Request Body")],-1),Hs=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),Ns=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),e(" Returns")],-1),$s=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow object"),e(" for the updated flow.")],-1),Vs=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),e(" REST API")],-1),Zs=s("pre",null,[s("code",null,`PATCH /flows/:id
+`)],-1),zs=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),e(" Example")],-1),Js=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-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),Ks=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),e(" GraphQL")],-1),Ws=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Xs=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
+}
+`)])],-1),Ys=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),e(" Example")],-1),se=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_flows_item(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),e(", data: { name: "),s("span",{class:"hljs-string"},'"My Updated Flow"'),e(` }) {
+		id
+		name
+	}
+}
+`)])],-1),ee=s("hr",null,null,-1),te=s("h2",{id:"update-multiple-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#"),e(" Update Multiple Flows")],-1),ae=s("p",null,"Update multiple existing flows.",-1),ne=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),e(" Query Parameters")],-1),le=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),e(" Request Body")],-1),oe=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.")],-1),re=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),ce=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),e(" Returns")],-1),he=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow objects"),e(" for the updated flows.")],-1),ie=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),e(" REST API")],-1),de=s("pre",null,[s("code",null,`PATCH /flows
+`)],-1),pe=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),e(" Example")],-1),ue=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows"),e(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),e(`
+	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
+	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
+		`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"inactive"'),e(`
+	`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`),s("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),_e=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),e(" GraphQL")],-1),fe=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),ge=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]
+}
+`)])],-1),je=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),e(" Example")],-1),me=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_flows_items(
+		ids: [`),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),e(", "),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),e(`]
+		data: { status: `),s("span",{class:"hljs-string"},'"inactive"'),e(` }
+	) {
+		id
+		name
+		status
+	}
+}
+`)])],-1),we=s("hr",null,null,-1),be=s("h2",{id:"delete-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-flow"},"#"),e(" Delete a Flow")],-1),ye=s("p",null,"Delete an existing flow.",-1),xe=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),e(" Returns")],-1),qe=s("p",null,"Empty body.",-1),Ee=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),e(" REST API")],-1),Te=s("pre",null,[s("code",null,`DELETE /flows/:id
+`)],-1),Pe=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),e(" Example")],-1),ke=s("pre",null,[s("code",null,`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
+`)],-1),Se=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),e(" GraphQL")],-1),Re=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ae=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
+}
+`)])],-1),Fe=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),e(" Example")],-1),Oe=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_flows_item(id: `),s("span",{class:"hljs-string"},'"12204ee2-2c82-4d9a-b044-2f4842a11dba"'),e(`) {
+		id
+	}
+}
+`)])],-1),Ie=s("hr",null,null,-1),ve=s("h2",{id:"delete-multiple-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-flows"},"#"),e(" Delete Multiple Flows")],-1),De=s("p",null,"Delete multiple existing flows.",-1),Le=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),e(" Request Body")],-1),Qe=s("p",null,"An array of flows primary keys",-1),Ge=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),e(" Returns")],-1),Me=s("p",null,"Empty body.",-1),Ce=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),e(" REST API")],-1),Ue=s("pre",null,[s("code",null,`DELETE /flows
+`)],-1),Be=s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),e(" Example")],-1),He=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /flows"),e(`
+`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),s("span",{class:"hljs-punctuation"},"]"),e(`
+`)])],-1),Ne=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),e(" GraphQL")],-1),$e=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ve=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
+}
+`)])],-1),Ze=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),e(" Example")],-1),ze=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_flows_items(
+		ids: [
+			`),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(`
+		]
+	) {
+		ids
+	}
+}
+`)])],-1),Je=s("h2",{id:"flow-with-get-webhook-trigger",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#flow-with-get-webhook-trigger"},"#"),e(" Flow with GET webhook trigger")],-1),Ke=s("p",null,"Start a flow with GET webhook trigger.",-1),We=s("h3",{id:"returns-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-8"},"#"),e(" Returns")],-1),Xe=s("p",null,"Result of the flow, if any.",-1),Ye=s("h3",{id:"rest-api-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-8"},"#"),e(" REST API")],-1),st=s("pre",null,[s("code",null,`GET /flows/trigger/:flow_uuid
+`)],-1),et=s("h5",{id:"example-15",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-15"},"#"),e(" Example")],-1),tt=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),at=s("h2",{id:"flow-with-post-webhook-trigger",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#"),e(" Flow with POST webhook trigger")],-1),nt=s("p",null,"Start a flow with POST webhook trigger.",-1),lt=s("h3",{id:"request-body-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-5"},"#"),e(" Request Body")],-1),ot=s("p",null,"Payload for the POST request.",-1),rt=s("h3",{id:"returns-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-9"},"#"),e(" Returns")],-1),ct=s("p",null,"Result of the flow, if any.",-1),ht=s("h3",{id:"rest-api-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-9"},"#"),e(" REST API")],-1),it=s("pre",null,[s("code",null,`POST /flows/trigger/:flow_uuid
+`)],-1),dt=s("h5",{id:"example-16",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-16"},"#"),e(" Example")],-1),pt=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),jt="Flows",mt=!1,wt="REST and GraphQL API documentation on the Flows collection in Directus.",bt="5 min read",yt="page-reference",xt={__name:"flows",setup(ut,{expose:r}){const l={title:"Flows",modularExtension:!1,description:"REST and GraphQL API documentation on the Flows collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return r({frontmatter:l}),(_t,ft)=>{const a=o("router-link"),c=o("docs-wrapper");return h(),i(c,{frontmatter:l},{default:t(()=>[s("div",d,[p,u,_,f,g,j,m,w,b,y,x,q,E,s("p",null,[T,e(),P,k,e(" The user who created the flow. Many-to-one to "),n(a,{to:"/docs/reference/system/users#the-users-object"},{default:t(()=>[e("users")]),_:1}),e(".")]),S,R,A,F,O,I,s("p",null,[e("Supports all "),n(a,{to:"/docs/reference/query"},{default:t(()=>[e("global query parameters")]),_:1}),e(".")]),v,s("p",null,[e("An array of up to "),n(a,{to:"/docs/reference/query#limit"},{default:t(()=>[e("limit")]),_:1}),e(),D,e(". If no items are available, data will be an empty array.")]),L,Q,s("p",null,[n(a,{to:"/docs/reference/introduction#search-http-method"},{default:t(()=>[e("Learn more about SEARCH ->")]),_:1})]),G,M,C,U,B,H,N,$,V,s("p",null,[e("Supports all "),n(a,{to:"/docs/reference/query"},{default:t(()=>[e("global query parameters")]),_:1}),e(".")]),Z,z,J,K,W,X,Y,ss,es,ts,as,ns,ls,os,rs,s("p",null,[e("Supports all "),n(a,{to:"/docs/reference/query"},{default:t(()=>[e("global query parameters")]),_:1}),e(".")]),cs,hs,is,ds,ps,us,_s,fs,gs,js,ms,ws,bs,ys,xs,qs,Es,s("p",null,[e("Supports all "),n(a,{to:"/docs/reference/query"},{default:t(()=>[e("global query parameters")]),_:1}),e(".")]),Ts,Ps,ks,Ss,Rs,As,Fs,Os,Is,vs,Ds,Ls,Qs,Gs,Ms,Cs,Us,s("p",null,[e("Supports all "),n(a,{to:"/docs/reference/query"},{default:t(()=>[e("global query parameters")]),_:1}),e(".")]),Bs,Hs,Ns,$s,Vs,Zs,zs,Js,Ks,Ws,Xs,Ys,se,ee,te,ae,ne,s("p",null,[e("Supports all "),n(a,{to:"/docs/reference/query"},{default:t(()=>[e("global query parameters")]),_:1}),e(".")]),le,oe,re,ce,he,ie,de,pe,ue,_e,fe,ge,je,me,we,be,ye,xe,qe,Ee,Te,Pe,ke,Se,Re,Ae,Fe,Oe,Ie,ve,De,Le,Qe,Ge,Me,Ce,Ue,Be,He,Ne,$e,Ve,Ze,ze,Je,Ke,We,Xe,Ye,st,et,tt,at,nt,lt,ot,rt,ct,ht,it,dt,pt])]),_:1})}}};export{xt as default,wt as description,mt as modularExtension,yt as pageClass,bt as readTime,jt as title};

package/dist/assets/flows.436d5fdd.js

@@ -0,0 +1,17 @@
+import{a as l,o as r,b as d,w as s,l as e,E as t,e as n}from"./runtime-core.esm-bundler.fe249c5c.js";const h={class:"markdown-body"},u=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),p={class:"tip hint"},w=e("div",{class:"hint-title"},"Before You Begin",-1),g={class:"tip hint"},f=e("div",{class:"hint-title"},"Learn More",-1),_=e("h2",{id:"what%E2%80%99s-a-flow%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#"),t(" What\u2019s a Flow?")],-1),m=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),b=e("em",null,"in-app",-1),j=e("p",null,[t("Once a Flow begins, Directus creates a "),e("a",{href:"#the-flow-object"},"Flow Object"),t(". This stores any data generated from the Trigger event. When an Operation in the flow executes successfully, its data is appended onto the Flow Object. Every Operation has access to the entire Flow Object. In other words, each Operation has access to the data from the Flow\u2019s Trigger as well all previously executed Operations in the Flow.")],-1),y=e("h2",{id:"create-a-flow",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-flow"},"#"),t(" Create a Flow")],-1),F=e("video",{autoplay:"",playsinline:"",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),O=e("p",null,"To create a Flow, follow these steps:",-1),v=e("li",null,[t("Navigate to "),e("strong",null,"Settings > Flows"),t(" and click "),e("span",{mi:"",btn:""},"add"),t(" in the Page Header. A drawer menu will open.")],-1),k=e("li",null,[t("Under "),e("strong",null,"Flow Setup"),t(", fill in a "),e("strong",null,"Name"),t(" for the Flow and "),e("em",null,"(optionally)"),t(" the following as desired: "),e("ul",null,[e("li",null,[e("strong",null,"Status"),t(" \u2014 Sets whether the Flow is active or inactive.")]),e("li",null,[e("strong",null,"Icon"),t(" \u2014 Adds a Material Icon used to help quickly identify the Flow.")]),e("li",null,[e("strong",null,"Description"),t(" \u2014 Sets a brief verbal description of the Flow.")]),e("li",null,[e("strong",null,"Color"),t(" \u2014 Sets a color to help identify the Flow.")])])],-1),T=e("strong",null,"Activity and Logs Tracking",-1),x=e("br",null,null,-1),A=e("a",{href:"#logs"},"Logs",-1),S=e("span",{mi:"",btn:""},"arrow_forward",-1),C=e("strong",null,"Trigger Setup",-1),P=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 will now see the Trigger Panel on the Flow Grid Area.")],-1),E=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),N=e("strong",null,"Name",-1),D=e("br",null,null,-1),$=e("a",{href:"#the-flow-object"},"Flow Object",-1),L=e("br",null,null,-1),V=e("li",null,[t("Next, click "),e("span",{mi:"",btn:""},"done"),t(" in the Page Header to confirm and return to the Flow Grid Area.")],-1),W=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 execute if the current Operation is successful.")]),e("li",null,[t("Click "),e("span",{mi:"",icon:""},"remove"),t(" to add an Operation to execute if the current Operation fails.")])])],-1),B=e("li",null,"Repeat steps 8-10 to build out your Flow as desired.",-1),I=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),q=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),G=e("h2",{id:"the-flow-object",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#the-flow-object"},"#"),t(" The Flow Object")],-1),Y=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),H=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),M=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-punctuation"},"{"),t(`
+	`),e("span",{class:"hljs-attr"},'"$trigger"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),e("span",{class:"hljs-punctuation"},"}"),e("span",{class:"hljs-punctuation"},","),t(),e("span",{class:"hljs-comment"},"// Data generated by the Flow's Trigger."),t(`
+	`),e("span",{class:"hljs-attr"},'"$last"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-literal"},[e("span",{class:"hljs-keyword"},"null")]),e("span",{class:"hljs-punctuation"},","),t(),e("span",{class:"hljs-comment"},"// Data from the last Operation in the flow, for easy access!"),t(`
+	`),e("span",{class:"hljs-attr"},'"$accountability"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),e("span",{class:"hljs-punctuation"},"}"),e("span",{class:"hljs-punctuation"},","),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_1"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-string"},'"some_value"'),e("span",{class:"hljs-punctuation"},","),t(`
+	`),e("span",{class:"hljs-attr"},'"operation_key_2"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-literal"},[e("span",{class:"hljs-keyword"},"null")]),e("span",{class:"hljs-punctuation"},","),t(),e("span",{class:"hljs-comment"},"// Value is null if no data was generated during an Operation."),t(`
+	`),e("span",{class:"hljs-attr"},'"operation_key_3"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),t(`
+		`),e("span",{class:"hljs-comment"},"// The data (if any) generated by the first Operation."),t(`
+		`),e("span",{class:"hljs-attr"},'"some_nested_key"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-string"},'"Some nested value."'),t(`
+	`),e("span",{class:"hljs-punctuation"},"}"),t(`
+`),e("span",{class:"hljs-punctuation"},"}"),t(`
+`)])],-1),J=e("h3",{id:"flow-variables",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#flow-variables"},"#"),t(" Flow Variables")],-1),K=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 also use dot-notation to extract sub-nested values.",-1),Q=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-punctuation"},"{"),t(`
+	`),e("span",{class:"hljs-attr"},'"operation_key_4"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"{"),t(`
+		`),e("span",{class:"hljs-attr"},'"user"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-string"},'"{{ $accountability.user }}"'),t(`
+	`),e("span",{class:"hljs-punctuation"},"}"),t(`
+`),e("span",{class:"hljs-punctuation"},"}"),t(`
+`)])],-1),R=e("h2",{id:"logs",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#logs"},"#"),t(" Logs")],-1),U=e("video",{autoplay:"",playsinline:"",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),z=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. To access a Flow\u2019s logs, follow these steps.",-1),X=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings > Flows"),t(" and click the desired Flow.")]),e("li",null,[t("Click "),e("strong",null,[e("span",{mi:"",icon:"",prmry:""},"fact_check"),t(" Logs")]),t(" in the Sidebar. A side drawer will open, displaying the Flow\u2019s logs.")]),e("li",null,"Click a log and another side drawer will open, allowing you to peer through its data."),e("li",null,[t("When finished, click "),e("span",{mi:"",btn:"",muted:""},"close"),t(" to close the drawer.")])],-1),oe="Flows",ne=!1,ae="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.",le="5 min read",ie={__name:"flows",setup(Z,{expose:i}){const a={title:"Flows",modularExtension:!1,description:"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.",readTime:"5 min read"};return i({frontmatter:a}),(ee,te)=>{const o=l("router-link"),c=l("docs-wrapper");return r(),d(c,{frontmatter:a},{default:s(()=>[e("div",h,[u,e("div",p,[w,e("p",null,[t("Please be sure to see the "),n(o,{to:"/docs/getting-started/quickstart.md"},{default:s(()=>[t("Quickstart Guide")]),_:1}),t(" to get a basic overview of the platform.")])]),e("div",g,[f,e("p",null,[t("There is also dedicated API documentation on "),n(o,{to:"/docs/reference/system/flows"},{default:s(()=>[t("Flows")]),_:1}),t(" and "),n(o,{to:"/docs/reference/system/operations"},{default:s(()=>[t("Operations")]),_:1}),t(".")])]),_,m,e("p",null,[t("Each Flow begins with one Trigger, which defines the action that starts 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 "),n(o,{to:"/docs/configuration/flows/triggers"},{default:s(()=>[t("Triggers")]),_:1}),t(" for more details.")]),e("p",null,[t("Operations are the actions performed after the Trigger, such as accessing and managing a Collection\u2019s items, sending off emails, pushing "),b,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 the previous Operation passed or failed. A "),n(o,{to:"/docs/configuration/flows/operations#log-to-console"},{default:s(()=>[t("console log")]),_:1}),t(" is also included to help design and troubleshoot your Flows and ensure data is passed on as intended. Please see the documentation on "),n(o,{to:"/docs/configuration/flows/operations"},{default:s(()=>[t("Operations")]),_:1}),t(" for more details.")]),j,y,F,O,e("ol",null,[v,k,e("li",null,[t("Select your "),T,t(" preference as desired."),x,t(" To learn more, please see "),n(o,{to:"/docs/reference/system/activity"},{default:s(()=>[t("Activity")]),_:1}),t(" and "),A,t(".")]),e("li",null,[t("Click "),S,t(" to navigate to "),C,t(". Select a "),n(o,{to:"/docs/configuration/flows/triggers"},{default:s(()=>[t("Trigger")]),_:1}),t(" type and configure as desired.")]),P,E,e("li",null,[t("Choose a "),N,t(", an "),n(o,{to:"/docs/configuration/flows/operations"},{default:s(()=>[t("Operation")]),_:1}),t(" type, and configure as desired."),D,t(" Directus will convert the unique name into an Operation Key, used on the "),$,t("."),L,t(" If you don\u2019t choose a name, the system will auto-generate a name and key.")]),V,W,B,I,q]),G,Y,H,M,J,K,Q,R,U,z,X])]),_:1})}}};export{ie as default,ae as description,ne as modularExtension,le as readTime,oe as title};

package/dist/assets/folders.67859a07.js

@@ -0,0 +1,132 @@
+import{a as r,o as c,b as h,w as a,l as e,E as s,e as n}from"./runtime-core.esm-bundler.fe249c5c.js";const i={class:"markdown-body"},p=e("blockquote",null,[e("p",null,"Folders can be used to organize files within the platform. Folders are virtual, and aren\u2019t mirrored within the storage adapter.")],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#the-folder-object"},"#"),s(" The Folder Object")],-1),f=e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")],-1),b=e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")],-1),m=e("p",null,[e("code",null,"parent"),s(),e("strong",null,"many-to-one"),e("br"),s(" Parent folder. Many-to-one to folders (recursive).")],-1),j=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-punctuation"},"{"),s(`
+	`),e("span",{class:"hljs-attr"},'"data"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-punctuation"},"{"),s(`
+		`),e("span",{class:"hljs-attr"},'"id"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),e("span",{class:"hljs-punctuation"},","),s(`
+		`),e("span",{class:"hljs-attr"},'"name"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"Test"'),e("span",{class:"hljs-punctuation"},","),s(`
+		`),e("span",{class:"hljs-attr"},'"parent"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-literal"},[e("span",{class:"hljs-keyword"},"null")]),s(`
+	`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`)])],-1),g=e("hr",null,null,-1),y=e("h2",{id:"list-folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#list-folders"},"#"),s(" List Folders")],-1),x=e("p",null,"List all folders that exist in Directus.",-1),q=e("h3",{id:"query-parameters",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters"},"#"),s(" Query Parameters")],-1),E=e("h3",{id:"returns",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns"},"#"),s(" Returns")],-1),T=e("a",{href:"#the-folder-object"},"folder objects",-1),w=e("h3",{id:"rest-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api"},"#"),s(" REST API")],-1),P=e("pre",null,[e("code",null,`GET /folders
+SEARCH /folders
+`)],-1),R=e("h3",{id:"graphql",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql"},"#"),s(" GraphQL")],-1),k=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),S=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
+	folders: directus_folders
+}
+`)])],-1),A=e("h5",{id:"example",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example"},"#"),s(" Example")],-1),v=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	folders {
+		name
+	}
+}
+`)])],-1),L=e("hr",null,null,-1),Q=e("h2",{id:"retrieve-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#"),s(" Retrieve a Folder")],-1),D=e("p",null,"List all folders that exist in Directus.",-1),F=e("h3",{id:"query-parameters-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),s(" Query Parameters")],-1),C=e("h3",{id:"returns-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-1"},"#"),s(" Returns")],-1),I=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),G=e("h3",{id:"rest-api-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-1"},"#"),s(" REST API")],-1),O=e("pre",null,[e("code",null,`GET /folders/:id
+`)],-1),M=e("h5",{id:"example-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-1"},"#"),s(" Example")],-1),B=e("pre",null,[e("code",null,`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
+`)],-1),N=e("h3",{id:"graphql-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-1"},"#"),s(" GraphQL")],-1),H=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),U=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
+	folders_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_folders
+}
+`)])],-1),V=e("h5",{id:"example-2",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-2"},"#"),s(" Example")],-1),z=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
+	folders_by_id(id: `),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),s(`) {
+		name
+	}
+}
+`)])],-1),J=e("hr",null,null,-1),K=e("h2",{id:"create-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-folder"},"#"),s(" Create a Folder")],-1),W=e("p",null,"Create a new (virtual) folder.",-1),X=e("h3",{id:"query-parameters-2",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),s(" Query Parameters")],-1),Y=e("h3",{id:"request-body",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#request-body"},"#"),s(" Request Body")],-1),Z=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(". "),e("code",null,"name"),s(" is required.")],-1),$=e("h3",{id:"returns-2",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-2"},"#"),s(" Returns")],-1),ee=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),se=e("h3",{id:"rest-api-2",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-2"},"#"),s(" REST API")],-1),ae=e("pre",null,[e("code",null,`POST /folders
+`)],-1),te=e("h5",{id:"example-3",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-3"},"#"),s(" Example")],-1),ne=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /folders"),s(`
+
+`),e("span",{class:"hljs-punctuation"},"{"),s(`
+	`),e("span",{class:"hljs-attr"},'"name"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"Nature"'),s(`
+`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`)])],-1),le=e("h3",{id:"graphql-2",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-2"},"#"),s(" GraphQL")],-1),re=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),oe=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	create_folders_item(data: create_directus_folders_input): directus_folders
+}
+`)])],-1),de=e("h5",{id:"example-4",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-4"},"#"),s(" Example")],-1),ce=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	create_folders_item(data: { name: `),e("span",{class:"hljs-string"},'"Nature"'),s(` }) {
+		id
+		name
+	}
+}
+`)])],-1),he=e("hr",null,null,-1),ie=e("h2",{id:"create-multiple-folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-multiple-folders"},"#"),s(" Create Multiple Folders")],-1),pe=e("p",null,"Create multiple new (virtual) folders.",-1),ue=e("h3",{id:"query-parameters-3",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),s(" Query Parameters")],-1),_e=e("h3",{id:"request-body-1",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#request-body-1"},"#"),s(" Request Body")],-1),fe=e("p",null,[s("An array of partial "),e("a",{href:"#the-folder-object"},"folder objects"),s(". "),e("code",null,"name"),s(" is required.")],-1),be=e("h3",{id:"returns-3",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-3"},"#"),s(" Returns")],-1),me=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),je=e("h3",{id:"rest-api-3",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-3"},"#"),s(" REST API")],-1),ge=e("pre",null,[e("code",null,`POST /folders
+`)],-1),ye=e("h5",{id:"example-5",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-5"},"#"),s(" Example")],-1),xe=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /folders"),s(`
+
+`),e("span",{class:"hljs-punctuation"},"["),s(`
+	`),e("span",{class:"hljs-punctuation"},"{"),s(`
+		`),e("span",{class:"hljs-attr"},'"name"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"Nature"'),s(`
+	`),e("span",{class:"hljs-punctuation"},"}"),e("span",{class:"hljs-punctuation"},","),s(`
+	`),e("span",{class:"hljs-punctuation"},"{"),s(`
+		`),e("span",{class:"hljs-attr"},'"name"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"Cities"'),s(`
+	`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`),e("span",{class:"hljs-punctuation"},"]"),s(`
+`)])],-1),qe=e("h3",{id:"graphql-3",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-3"},"#"),s(" GraphQL")],-1),Ee=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),Te=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	create_folders_items(data: [create_directus_folders_input]): [directus_folders]
+}
+`)])],-1),we=e("h5",{id:"example-6",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-6"},"#"),s(" Example")],-1),Pe=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	create_folders_items(data: [{ name: `),e("span",{class:"hljs-string"},'"Nature"'),s(" }, { name: "),e("span",{class:"hljs-string"},'"Cities"'),s(` }]) {
+		id
+		name
+	}
+}
+`)])],-1),Re=e("hr",null,null,-1),ke=e("h2",{id:"update-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#update-a-folder"},"#"),s(" Update a Folder")],-1),Se=e("p",null,"Update an existing folder.",-1),Ae=e("h3",{id:"query-parameters-4",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),s(" Query Parameters")],-1),ve=e("h3",{id:"request-body-2",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#request-body-2"},"#"),s(" Request Body")],-1),Le=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Qe=e("h3",{id:"returns-4",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-4"},"#"),s(" Returns")],-1),De=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Fe=e("h3",{id:"rest-api-4",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-4"},"#"),s(" REST API")],-1),Ce=e("pre",null,[e("code",null,`PATCH /folders/:id
+`)],-1),Ie=e("h5",{id:"example-7",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-7"},"#"),s(" Example")],-1),Ge=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders/fac21847-d5ce-4e4b-a288-9abafbdfbc87"),s(`
+
+`),e("span",{class:"hljs-punctuation"},"{"),s(`
+	`),e("span",{class:"hljs-attr"},'"parent"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(`
+`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`)])],-1),Oe=e("h3",{id:"graphql-4",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-4"},"#"),s(" GraphQL")],-1),Me=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),Be=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	update_folders_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_folders_input): directus_folders
+}
+`)])],-1),Ne=e("h5",{id:"example-8",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-8"},"#"),s(" Example")],-1),He=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_folders_item(
+		id: `),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(`
+		data: { parent: `),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(` }
+	) {
+		id
+		name
+	}
+}
+`)])],-1),Ue=e("hr",null,null,-1),Ve=e("h2",{id:"update-multiple-folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#"),s(" Update Multiple Folders")],-1),ze=e("p",null,"Update multiple existing folders.",-1),Je=e("h3",{id:"query-parameters-5",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),s(" Query Parameters")],-1),Ke=e("h3",{id:"request-body-3",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#request-body-3"},"#"),s(" Request Body")],-1),We=e("p",null,[e("code",null,"keys"),s(),e("strong",null,"Required"),e("br"),s(" Array of primary keys of the folders you\u2019d like to update.")],-1),Xe=e("p",null,[e("code",null,"data"),s(),e("strong",null,"Required"),e("br"),s(" Any of "),e("a",{href:"#the-folder-object"},"the folder object"),s("\u2019s properties.")],-1),Ye=e("h3",{id:"returns-5",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-5"},"#"),s(" Returns")],-1),Ze=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder objects"),s(" of the folders that were updated.")],-1),$e=e("h3",{id:"rest-api-5",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-5"},"#"),s(" REST API")],-1),es=e("pre",null,[e("code",null,`PATCH /folders
+`)],-1),ss=e("h5",{id:"example-9",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-9"},"#"),s(" Example")],-1),as=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /folders"),s(`
+
+`),e("span",{class:"hljs-punctuation"},"{"),s(`
+	`),e("span",{class:"hljs-attr"},'"keys"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-punctuation"},"["),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),e("span",{class:"hljs-punctuation"},","),s(),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),e("span",{class:"hljs-punctuation"},"]"),e("span",{class:"hljs-punctuation"},","),s(`
+	`),e("span",{class:"hljs-attr"},'"data"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-punctuation"},"{"),s(`
+		`),e("span",{class:"hljs-attr"},'"parent"'),e("span",{class:"hljs-punctuation"},":"),s(),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(`
+	`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`),e("span",{class:"hljs-punctuation"},"}"),s(`
+`)])],-1),ts=e("h3",{id:"graphql-5",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-5"},"#"),s(" GraphQL")],-1),ns=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),ls=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	update_folders_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_folders_input): [directus_folders]
+}
+`)])],-1),rs=e("h5",{id:"example-10",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-10"},"#"),s(" Example")],-1),os=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	update_folders_items(
+		ids: [`),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`]
+		data: { parent: `),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),s(` }
+	) {
+		id
+		name
+	}
+}
+`)])],-1),ds=e("hr",null,null,-1),cs=e("h2",{id:"delete-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-folder"},"#"),s(" Delete a Folder")],-1),hs=e("p",null,"Delete an existing folder.",-1),is=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in this folder will be moved to the root folder.")],-1),ps=e("h3",{id:"returns-6",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-6"},"#"),s(" Returns")],-1),us=e("p",null,"Empty body.",-1),_s=e("h3",{id:"rest-api-6",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-6"},"#"),s(" REST API")],-1),fs=e("pre",null,[e("code",null,`DELETE /folders/:id
+`)],-1),bs=e("h5",{id:"example-11",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-11"},"#"),s(" Example")],-1),ms=e("pre",null,[e("code",null,`// DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983
+`)],-1),js=e("h3",{id:"graphql-6",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-6"},"#"),s(" GraphQL")],-1),gs=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),ys=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_folders_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
+}
+`)])],-1),xs=e("h5",{id:"example-12",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-12"},"#"),s(" Example")],-1),qs=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_folders_item(id: `),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(`) {
+		id
+	}
+}
+`)])],-1),Es=e("hr",null,null,-1),Ts=e("h2",{id:"delete-multiple-folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-multiple-folders"},"#"),s(" Delete Multiple Folders")],-1),ws=e("p",null,"Delete multiple existing folders.",-1),Ps=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Files"),e("p",null,"Any files in these folders will be moved to the root folder.")],-1),Rs=e("h3",{id:"request-body-4",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#request-body-4"},"#"),s(" Request Body")],-1),ks=e("p",null,"An array of folder primary keys.",-1),Ss=e("h3",{id:"returns-7",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns-7"},"#"),s(" Returns")],-1),As=e("p",null,"Empty body.",-1),vs=e("h3",{id:"rest-api-7",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api-7"},"#"),s(" REST API")],-1),Ls=e("pre",null,[e("code",null,`DELETE /folders
+`)],-1),Qs=e("h5",{id:"example-13",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-13"},"#"),s(" Example")],-1),Ds=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// DELETE /folders"),s(`
+
+`),e("span",{class:"hljs-punctuation"},"["),e("span",{class:"hljs-string"},'"d97c2e0e-293d-4eb5-9e1c-27d3460ad29d"'),e("span",{class:"hljs-punctuation"},","),s(),e("span",{class:"hljs-string"},'"fc02d733-95b8-4e27-bd4b-08a32cbe4e66"'),e("span",{class:"hljs-punctuation"},"]"),s(`
+`)])],-1),Fs=e("h3",{id:"graphql-7",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql-7"},"#"),s(" GraphQL")],-1),Cs=e("pre",null,[e("code",null,`POST /graphql/system
+`)],-1),Is=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	delete_folders_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!): delete_many
+}
+`)])],-1),Gs=e("h5",{id:"example-14",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-14"},"#"),s(" Example")],-1),Os=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	delete_folders_items(ids: [`),e("span",{class:"hljs-string"},'"fac21847-d5ce-4e4b-a288-9abafbdfbc87"'),s(", "),e("span",{class:"hljs-string"},'"a5bdb793-dd85-4ac9-882a-b42862092983"'),s(`]) {
+		ids
+	}
+}
+`)])],-1),Us="Folders",Vs=!1,zs="REST and GraphQL API documentation on the Folders collection in Directus.",Js="4 min read",Ks="page-reference",Ws={__name:"folders",setup(Ms,{expose:o}){const l={title:"Folders",modularExtension:!1,description:"REST and GraphQL API documentation on the Folders collection in Directus.",readTime:"4 min read",pageClass:"page-reference"};return o({frontmatter:l}),(Bs,Ns)=>{const t=r("router-link"),d=r("docs-wrapper");return c(),h(d,{frontmatter:l},{default:a(()=>[e("div",i,[p,u,_,f,b,m,j,g,y,x,q,e("p",null,[s("Supports all "),n(t,{to:"/docs/reference/query"},{default:a(()=>[s("global query parameters")]),_:1}),s(".")]),E,e("p",null,[s("An array of up to "),n(t,{to:"/docs/reference/query#limit"},{default:a(()=>[s("limit")]),_:1}),s(),T,s(". If no items are available, data will be an empty array.")]),w,P,e("p",null,[n(t,{to:"/docs/reference/introduction#search-http-method"},{default:a(()=>[s("Learn more about SEARCH ->")]),_:1})]),R,k,S,A,v,L,Q,D,F,e("p",null,[s("Supports all "),n(t,{to:"/docs/reference/query"},{default:a(()=>[s("global query parameters")]),_:1}),s(".")]),C,I,G,O,M,B,N,H,U,V,z,J,K,W,X,e("p",null,[s("Supports all "),n(t,{to:"/docs/reference/query"},{default:a(()=>[s("global query parameters")]),_:1}),s(".")]),Y,Z,$,ee,se,ae,te,ne,le,re,oe,de,ce,he,ie,pe,ue,e("p",null,[s("Supports all "),n(t,{to:"/docs/reference/query"},{default:a(()=>[s("global query parameters")]),_:1}),s(".")]),_e,fe,be,me,je,ge,ye,xe,qe,Ee,Te,we,Pe,Re,ke,Se,Ae,e("p",null,[s("Supports all "),n(t,{to:"/docs/reference/query"},{default:a(()=>[s("global query parameters")]),_:1}),s(".")]),ve,Le,Qe,De,Fe,Ce,Ie,Ge,Oe,Me,Be,Ne,He,Ue,Ve,ze,Je,e("p",null,[s("Supports all "),n(t,{to:"/docs/reference/query"},{default:a(()=>[s("global query parameters")]),_:1}),s(".")]),Ke,We,Xe,Ye,Ze,$e,es,ss,as,ts,ns,ls,rs,os,ds,cs,hs,is,ps,us,_s,fs,bs,ms,js,gs,ys,xs,qs,Es,Ts,ws,Ps,Rs,ks,Ss,As,vs,Ls,Qs,Ds,Fs,Cs,Is,Gs,Os])]),_:1})}}};export{Ws as default,zs as description,Vs as modularExtension,Ks as pageClass,Js as readTime,Us as title};

package/dist/assets/forth.4d50dd0d.js

@@ -0,0 +1 @@
+import{y as S}from"./index.c4fb8611.entry.js";function T(O,u){for(var n=0;n<u.length;n++){const E=u[n];if(typeof E!="string"&&!Array.isArray(E)){for(const i in E)if(i!=="default"&&!(i in O)){const o=Object.getOwnPropertyDescriptor(E,i);o&&Object.defineProperty(O,i,o.get?o:{enumerable:!0,get:()=>E[i]})}}}return Object.freeze(Object.defineProperty(O,Symbol.toStringTag,{value:"Module"}))}var a={exports:{}};(function(O,u){(function(n){n(S.exports)})(function(n){function E(f){var r=[];return f.split(" ").forEach(function(e){r.push({name:e})}),r}var i=E("INVERT AND OR XOR	 2* 2/ LSHIFT RSHIFT	 0= = 0< < > U< MIN MAX	 2DROP 2DUP 2OVER 2SWAP ?DUP DEPTH DROP DUP OVER ROT SWAP	 >R R> R@	 + - 1+ 1- ABS NEGATE	 S>D * M* UM*	 FM/MOD SM/REM UM/MOD */ */MOD / /MOD MOD	 HERE , @ ! CELL+ CELLS C, C@ C! CHARS 2@ 2!	 ALIGN ALIGNED +! ALLOT	 CHAR [CHAR] [ ] BL	 FIND EXECUTE IMMEDIATE COUNT LITERAL STATE	 ; DOES> >BODY	 EVALUATE	 SOURCE >IN	 <# # #S #> HOLD SIGN BASE >NUMBER HEX DECIMAL	 FILL MOVE	 . CR EMIT SPACE SPACES TYPE U. .R U.R	 ACCEPT	 TRUE FALSE	 <> U> 0<> 0>	 NIP TUCK ROLL PICK	 2>R 2R@ 2R>	 WITHIN UNUSED MARKER	 I J	 TO	 COMPILE, [COMPILE]	 SAVE-INPUT RESTORE-INPUT	 PAD ERASE	 2LITERAL DNEGATE	 D- D+ D0< D0= D2* D2/ D< D= DMAX DMIN D>S DABS	 M+ M*/ D. D.R 2ROT DU<	 CATCH THROW	 FREE RESIZE ALLOCATE	 CS-PICK CS-ROLL	 GET-CURRENT SET-CURRENT FORTH-WORDLIST GET-ORDER SET-ORDER	 PREVIOUS SEARCH-WORDLIST WORDLIST FIND ALSO ONLY FORTH DEFINITIONS ORDER	 -TRAILING /STRING SEARCH COMPARE CMOVE CMOVE> BLANK SLITERAL"),o=E("IF ELSE THEN BEGIN WHILE REPEAT UNTIL RECURSE [IF] [ELSE] [THEN] ?DO DO LOOP +LOOP UNLOOP LEAVE EXIT AGAIN CASE OF ENDOF ENDCASE");n.defineMode("forth",function(){function f(r,e){var t;for(t=r.length-1;t>=0;t--)if(r[t].name===e.toUpperCase())return r[t]}return{startState:function(){return{state:"",base:10,coreWordList:i,immediateWordList:o,wordList:[]}},token:function(r,e){var t;if(r.eatSpace())return null;if(e.state===""){if(r.match(/^(\]|:NONAME)(\s|$)/i))return e.state=" compilation","builtin compilation";if(t=r.match(/^(\:)\s+(\S+)(\s|$)+/),t)return e.wordList.push({name:t[2].toUpperCase()}),e.state=" compilation","def"+e.state;if(t=r.match(/^(VARIABLE|2VARIABLE|CONSTANT|2CONSTANT|CREATE|POSTPONE|VALUE|WORD)\s+(\S+)(\s|$)+/i),t)return e.wordList.push({name:t[2].toUpperCase()}),"def"+e.state;if(t=r.match(/^(\'|\[\'\])\s+(\S+)(\s|$)+/),t)return"builtin"+e.state}else{if(r.match(/^(\;|\[)(\s)/))return e.state="",r.backUp(1),"builtin compilation";if(r.match(/^(\;|\[)($)/))return e.state="","builtin compilation";if(r.match(/^(POSTPONE)\s+\S+(\s|$)+/))return"builtin"}if(t=r.match(/^(\S+)(\s+|$)/),t)return f(e.wordList,t[1])!==void 0?"variable"+e.state:t[1]==="\\"?(r.skipToEnd(),"comment"+e.state):f(e.coreWordList,t[1])!==void 0?"builtin"+e.state:f(e.immediateWordList,t[1])!==void 0?"keyword"+e.state:t[1]==="("?(r.eatWhile(function(R){return R!==")"}),r.eat(")"),"comment"+e.state):t[1]===".("?(r.eatWhile(function(R){return R!==")"}),r.eat(")"),"string"+e.state):t[1]==='S"'||t[1]==='."'||t[1]==='C"'?(r.eatWhile(function(R){return R!=='"'}),r.eat('"'),"string"+e.state):t[1]-68719476735?"number"+e.state:"atom"+e.state}}}),n.defineMIME("text/x-forth","forth")})})();const A=a.exports,D=T({__proto__:null,default:A},[a.exports]);export{D as f};

package/dist/assets/fortran.b5e49e1f.js

@@ -0,0 +1 @@
+import{y as h}from"./index.c4fb8611.entry.js";function x(l,s){for(var i=0;i<s.length;i++){const r=s[i];if(typeof r!="string"&&!Array.isArray(r)){for(const o in r)if(o!=="default"&&!(o in l)){const c=Object.getOwnPropertyDescriptor(r,o);c&&Object.defineProperty(l,o,c.get?c:{enumerable:!0,get:()=>r[o]})}}}return Object.freeze(Object.defineProperty(l,Symbol.toStringTag,{value:"Module"}))}var f={exports:{}};(function(l,s){(function(i){i(h.exports)})(function(i){i.defineMode("fortran",function(){function r(t){for(var n={},e=0;e<t.length;++e)n[t[e]]=!0;return n}var o=r(["abstract","accept","allocatable","allocate","array","assign","asynchronous","backspace","bind","block","byte","call","case","class","close","common","contains","continue","cycle","data","deallocate","decode","deferred","dimension","do","elemental","else","encode","end","endif","entry","enumerator","equivalence","exit","external","extrinsic","final","forall","format","function","generic","go","goto","if","implicit","import","include","inquire","intent","interface","intrinsic","module","namelist","non_intrinsic","non_overridable","none","nopass","nullify","open","optional","options","parameter","pass","pause","pointer","print","private","program","protected","public","pure","read","recursive","result","return","rewind","save","select","sequence","stop","subroutine","target","then","to","type","use","value","volatile","where","while","write"]),c=r(["abort","abs","access","achar","acos","adjustl","adjustr","aimag","aint","alarm","all","allocated","alog","amax","amin","amod","and","anint","any","asin","associated","atan","besj","besjn","besy","besyn","bit_size","btest","cabs","ccos","ceiling","cexp","char","chdir","chmod","clog","cmplx","command_argument_count","complex","conjg","cos","cosh","count","cpu_time","cshift","csin","csqrt","ctime","c_funloc","c_loc","c_associated","c_null_ptr","c_null_funptr","c_f_pointer","c_null_char","c_alert","c_backspace","c_form_feed","c_new_line","c_carriage_return","c_horizontal_tab","c_vertical_tab","dabs","dacos","dasin","datan","date_and_time","dbesj","dbesj","dbesjn","dbesy","dbesy","dbesyn","dble","dcos","dcosh","ddim","derf","derfc","dexp","digits","dim","dint","dlog","dlog","dmax","dmin","dmod","dnint","dot_product","dprod","dsign","dsinh","dsin","dsqrt","dtanh","dtan","dtime","eoshift","epsilon","erf","erfc","etime","exit","exp","exponent","extends_type_of","fdate","fget","fgetc","float","floor","flush","fnum","fputc","fput","fraction","fseek","fstat","ftell","gerror","getarg","get_command","get_command_argument","get_environment_variable","getcwd","getenv","getgid","getlog","getpid","getuid","gmtime","hostnm","huge","iabs","iachar","iand","iargc","ibclr","ibits","ibset","ichar","idate","idim","idint","idnint","ieor","ierrno","ifix","imag","imagpart","index","int","ior","irand","isatty","ishft","ishftc","isign","iso_c_binding","is_iostat_end","is_iostat_eor","itime","kill","kind","lbound","len","len_trim","lge","lgt","link","lle","llt","lnblnk","loc","log","logical","long","lshift","lstat","ltime","matmul","max","maxexponent","maxloc","maxval","mclock","merge","move_alloc","min","minexponent","minloc","minval","mod","modulo","mvbits","nearest","new_line","nint","not","or","pack","perror","precision","present","product","radix","rand","random_number","random_seed","range","real","realpart","rename","repeat","reshape","rrspacing","rshift","same_type_as","scale","scan","second","selected_int_kind","selected_real_kind","set_exponent","shape","short","sign","signal","sinh","sin","sleep","sngl","spacing","spread","sqrt","srand","stat","sum","symlnk","system","system_clock","tan","tanh","time","tiny","transfer","transpose","trim","ttynam","ubound","umask","unlink","unpack","verify","xor","zabs","zcos","zexp","zlog","zsin","zsqrt"]),p=r(["c_bool","c_char","c_double","c_double_complex","c_float","c_float_complex","c_funptr","c_int","c_int16_t","c_int32_t","c_int64_t","c_int8_t","c_int_fast16_t","c_int_fast32_t","c_int_fast64_t","c_int_fast8_t","c_int_least16_t","c_int_least32_t","c_int_least64_t","c_int_least8_t","c_intmax_t","c_intptr_t","c_long","c_long_double","c_long_double_complex","c_long_long","c_ptr","c_short","c_signed_char","c_size_t","character","complex","double","integer","logical","real"]),_=/[+\-*&=<>\/\:]/,m=new RegExp("(.and.|.or.|.eq.|.lt.|.le.|.gt.|.ge.|.ne.|.not.|.eqv.|.neqv.)","i");function g(t,n){if(t.match(m))return"operator";var e=t.next();if(e=="!")return t.skipToEnd(),"comment";if(e=='"'||e=="'")return n.tokenize=b(e),n.tokenize(t,n);if(/[\[\]\(\),]/.test(e))return null;if(/\d/.test(e))return t.eatWhile(/[\w\.]/),"number";if(_.test(e))return t.eatWhile(_),"operator";t.eatWhile(/[\w\$_]/);var a=t.current().toLowerCase();return o.hasOwnProperty(a)?"keyword":c.hasOwnProperty(a)||p.hasOwnProperty(a)?"builtin":"variable"}function b(t){return function(n,e){for(var a=!1,d,u=!1;(d=n.next())!=null;){if(d==t&&!a){u=!0;break}a=!a&&d=="\\"}return(u||!a)&&(e.tokenize=null),"string"}}return{startState:function(){return{tokenize:null}},token:function(t,n){if(t.eatSpace())return null;var e=(n.tokenize||g)(t,n);return e=="comment"||e=="meta",e}}}),i.defineMIME("text/x-fortran","fortran")})})();const y=f.exports,k=x({__proto__:null,default:y},[f.exports]);export{k as f};