@directus/app 9.14.5 → 9.16.0

package/dist/assets/flows.03ed1b32.js

@@ -1,15 +0,0 @@
-import{a as l,o as r,b as d,w as s,g as e,e as n,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.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=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#what%E2%80%99s-a-flow%3F"},"What\u2019s 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),_={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"),j=t("."),y=e("h2",{id:"what%E2%80%99s-a-flow%3F",tabindex:"-1"},[t("What\u2019s a Flow? "),e("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#")],-1),O=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),F=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 "),v=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 "),x=e("em",null,"in-app",-1),A=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",tabindex:"-1"},[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),se=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),oe=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 "),ce=e("a",{href:"#the-flow-object"},"Flow Object",-1),re=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."),ue=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),pe=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),_e=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",tabindex:"-1"},[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),je=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"'),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."'),e("span",{class:"hljs-punctuation"},","),t(`
-    `),e("span",{class:"hljs-punctuation"},"}"),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-punctuation"},"}"),t(`
-`)])],-1),ye=e("h3",{id:"flow-variables",tabindex:"-1"},[t("Flow Variables "),e("a",{class:"header-anchor",href:"#flow-variables"},"#")],-1),Oe=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),Fe=e("pre",null,[e("code",{class:"language-JSON"},[e("span",{class:"hljs-punctuation"},"{"),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-attr"},'"user"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-string"},'"{{ $accountability.user }}"'),e("span",{class:"hljs-punctuation"},","),t(`
-	 `),e("span",{class:"hljs-punctuation"},"}"),t(`
-`),e("span",{class:"hljs-punctuation"},"}"),t(`
-`)])],-1),ve=e("h2",{id:"logs",tabindex:"-1"},[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(xe,{expose:i}){const a={title:"Flows",modularExtension:!1};return i({frontmatter:a}),(Ae,Ce)=>{const o=l("router-link"),c=l("docs-wrapper");return r(),d(c,{frontmatter:a},{default:s(()=>[e("div",h,[u,p,e("div",_,[w,e("p",null,[f,n(o,{to:"/docs/reference/system/flows"},{default:s(()=>[g]),_:1}),m,n(o,{to:"/docs/reference/system/operations"},{default:s(()=>[b]),_:1}),j])]),y,O,e("p",null,[F,n(o,{to:"/docs/configuration/flows/triggers"},{default:s(()=>[v]),_:1}),k]),e("p",null,[T,x,A,n(o,{to:"/docsconfiguration/flows/operations/#log-to-console"},{default:s(()=>[C]),_:1}),S,n(o,{to:"/docs/configuration/flows/operations"},{default:s(()=>[P]),_:1}),N]),E,$,D,L,e("ol",null,[V,W,e("li",null,[B,J,G,H,I,n(o,{to:"/docs/reference/system/activity/"},{default:s(()=>[Y]),_:1}),q,n(o,{to:"/docs/#logs"},{default:s(()=>[M]),_:1}),K]),e("li",null,[R,U,z,Q,X,n(o,{to:"/docsconfiguration/flows/triggers"},{default:s(()=>[Z]),_:1}),ee]),te,se,e("li",null,[oe,n(o,{to:"/docsconfiguration/flows/operations"},{default:s(()=>[ne]),_:1}),ae,le,ie,ce,re,de,he]),ue,pe,_e,we,fe]),ge,me,be,je,ye,Oe,Fe,ve,ke,Te])]),_:1})}}};export{Ee as default,Ne as modularExtension,Pe as title};

package/dist/assets/flows.19c6599f.js

@@ -1,172 +0,0 @@
-import{a as o,o as h,b as i,w as a,g as s,e as l,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={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",tabindex:"-1"},[e("The Flow Object "),s("a",{class:"header-anchor",href:"#the-flow-object"},"#")],-1),_={class:"two-up"},g={class:"left"},w={class:"definitions"},j=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the flow.")],-1),b=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the flow.")],-1),m=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),y=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),x=s("p",null,[s("code",null,"note"),e(),s("strong",null,"text"),s("br"),e(" Short description displayed in the Admin App.")],-1),q=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"},[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),C=s("hr",null,null,-1),L=s("h2",{id:"list-flows",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[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",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),ts=s("pre",null,[s("code",null,`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(` {
-	flows: [directus_flows]
-}
-`)])],-1),ns=s("h5",{id:"example",tabindex:"-1"},[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(` {
-	flows {
-		id
-		name
-		status
-	}
-}
-`)])],-1),rs=s("hr",null,null,-1),cs=s("h2",{id:"retrieve-a-flow",tabindex:"-1"},[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),is={class:"two-up"},ds={class:"left"},ps=s("h3",{id:"query-parameters-1",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),us=e("Supports all "),fs=e("global query parameters"),_s=e("."),gs=s("h3",{id:"returns-1",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),ws=s("p",null,[e("Returns the requested "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),js=s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /flows/:id
-`)]),s("h5",{id:"example-1",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",null,`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
-`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),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
-}
-`)])]),s("h5",{id:"example-2",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),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),bs=s("hr",null,null,-1),ms=s("h2",{id:"create-a-flow",tabindex:"-1"},[e("Create a Flow "),s("a",{class:"header-anchor",href:"#create-a-flow"},"#")],-1),ys=s("p",null,"Create a new flow.",-1),xs={class:"two-up"},qs={class:"left"},vs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Es=e("Supports all "),Ts=e("global query parameters"),ks=e("."),Ps=s("h3",{id:"request-body",tabindex:"-1"},[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-2",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-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-2",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`POST /flows
-`)]),s("h5",{id:"example-3",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),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(`
-`)])]),s("h3",{id:"graphql-2",tabindex:"-1"},[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"}," Mutation"),e(` {
-	create_flows_item(data: create_directus_flows_input!): directus_flows
-}
-`)])]),s("h5",{id:"example-4",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),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),Os=s("hr",null,null,-1),Ds=s("h2",{id:"create-multiple-flows",tabindex:"-1"},[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-3",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Gs=e("Supports all "),Qs=e("global query parameters"),Us=e("."),Bs=s("h3",{id:"request-body-1",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")],-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-3",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-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-3",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /flows
-`)]),s("h5",{id:"example-5",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),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(`
-`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[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_items(data: [create_directus_flows_input!]!): [directus_flows]
-}
-`)])]),s("h5",{id:"example-6",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),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),Zs=s("hr",null,null,-1),zs=s("h2",{id:"update-a-flow",tabindex:"-1"},[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-4",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Ys=e("Supports all "),se=e("global query parameters"),ee=e("."),ae=s("h3",{id:"request-body-2",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),te=s("p",null,[e("A partial "),s("a",{href:"#the-flow-object"},"flow object"),e(".")],-1),le=s("h3",{id:"returns-4",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-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-4",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`PATCH /flows/:id
-`)]),s("h5",{id:"example-7",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),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(`
-`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[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(` {
-	update_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_flows_input): directus_flows
-}
-`)])]),s("h5",{id:"example-8",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),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),re=s("hr",null,null,-1),ce=s("h2",{id:"update-multiple-flows",tabindex:"-1"},[e("Update Multiple Flows "),s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#")],-1),he=s("p",null,"Update multiple existing flows.",-1),ie={class:"two-up"},de={class:"left"},pe=s("h3",{id:"query-parameters-5",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ue=e("Supports all "),fe=e("global query parameters"),_e=e("."),ge=s("h3",{id:"request-body-3",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-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),je=s("h3",{id:"returns-5",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),be=s("p",null,[e("Returns the "),s("a",{href:"#the-flow-object"},"flow objects"),e(" for the updated flows.")],-1),me=s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`PATCH /flows
-`)]),s("h5",{id:"example-9",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),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(`
-`)])]),s("h3",{id:"graphql-5",tabindex:"-1"},[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_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_flows_input): [directus_flows]
-}
-`)])]),s("h5",{id:"example-10",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),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),ye=s("hr",null,null,-1),xe=s("h2",{id:"delete-a-flow",tabindex:"-1"},[e("Delete a Flow "),s("a",{class:"header-anchor",href:"#delete-a-flow"},"#")],-1),qe=s("p",null,"Delete an existing flow.",-1),ve=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-6",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-6",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`DELETE /flows/:id
-`)]),s("h5",{id:"example-11",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",null,`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
-`)]),s("h3",{id:"graphql-6",tabindex:"-1"},[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(` {
-	delete_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
-}
-`)])]),s("h5",{id:"example-12",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),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),Ee=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-flows",tabindex:"-1"},[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-4",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")]),s("p",null,"An array of flows primary keys"),s("h3",{id:"returns-7",tabindex:"-1"},[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",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`DELETE /flows
-`)]),s("h5",{id:"example-13",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),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(`
-`)])]),s("h3",{id:"graphql-7",tabindex:"-1"},[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_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
-}
-`)])]),s("h5",{id:"example-14",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),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),Se=s("h2",{id:"flow-with-get-webhook-trigger",tabindex:"-1"},[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-8",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Result of the flow, if any.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",null,`GET /flows/trigger/:flow_uuid
-`)]),s("h5",{id:"example-15",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),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",tabindex:"-1"},[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-5",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"Payload for the POST request."),s("h3",{id:"returns-9",tabindex:"-1"},[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",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",null,`POST /flows/trigger/:flow_uuid
-`)]),s("h5",{id:"example-16",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),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),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"),c=o("docs-wrapper");return h(),i(c,{frontmatter:n},{default:a(()=>[s("div",d,[p,u,f,s("div",_,[s("div",g,[s("div",w,[j,b,m,y,x,q,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",is,[s("div",ds,[ps,s("p",null,[us,l(t,{to:"/docs/reference/query"},{default:a(()=>[fs]),_:1}),_s]),gs,ws]),js]),bs,ms,ys,s("div",xs,[s("div",qs,[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",ie,[s("div",de,[pe,s("p",null,[ue,l(t,{to:"/docs/reference/query"},{default:a(()=>[fe]),_:1}),_e]),ge,we,je,be]),me]),ye,xe,qe,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};

package/dist/assets/folders.e417fd8b.js

@@ -1,132 +0,0 @@
-import{a as r,o as c,b as h,w as a,g as e,e as t,B as s}from"./runtime-core.esm-bundler.e3d5f5b7.js";const i={class:"markdown-body"},p=e("div",{class:"two-up"},[e("div",{class:"left"},[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.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-folder-object"},"The Folder Object ")]),e("li",null,[e("a",{href:"#list-folders"},"List Folders ")]),e("li",null,[e("a",{href:"#retrieve-a-folder"},"Retrieve a Folder ")]),e("li",null,[e("a",{href:"#create-a-folder"},"Create a Folder ")]),e("li",null,[e("a",{href:"#create-multiple-folders"},"Create Multiple Folders ")]),e("li",null,[e("a",{href:"#update-a-folder"},"Update a Folder ")]),e("li",null,[e("a",{href:"#update-multiple-folders"},"Update Multiple Folders ")]),e("li",null,[e("a",{href:"#delete-a-folder"},"Delete a Folder ")]),e("li",null,[e("a",{href:"#delete-multiple-folders"},"Delete Multiple Folders ")])])])])])],-1),u=e("hr",null,null,-1),_=e("h2",{id:"the-folder-object",tabindex:"-1"},[s("The Folder Object "),e("a",{class:"header-anchor",href:"#the-folder-object"},"#")],-1),f=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),s(),e("strong",null,"uuid"),e("br"),s(" Primary key of the folder.")]),e("p",null,[e("code",null,"name"),s(),e("strong",null,"string"),e("br"),s(" Name of the folder.")]),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).")])])]),e("div",{class:"right"},[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),b=e("hr",null,null,-1),m=e("h2",{id:"list-folders",tabindex:"-1"},[s("List Folders "),e("a",{class:"header-anchor",href:"#list-folders"},"#")],-1),g=e("p",null,"List all folders that exist in Directus.",-1),j={class:"two-up"},y={class:"left"},x=e("h3",{id:"query-parameters",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),q=s("Supports all "),v=s("global query parameters"),w=s("."),E=e("h3",{id:"returns",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")],-1),T=s("An array of up to "),P=s("limit"),R=s(),k=e("a",{href:"#the-folder-object"},"folder objects",-1),S=s(". If no items are available, data will be an empty array."),F={class:"right"},A=e("h3",{id:"rest-api",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),C=e("pre",null,[e("code",null,`GET /folders
-SEARCH /folders
-`)],-1),D=s("Learn more about SEARCH ->"),L=e("h3",{id:"graphql",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Q=e("pre",null,[e("code",null,`POST /graphql/system
-`)],-1),I=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),O=e("h5",{id:"example",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),M=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	folders {
-		name
-	}
-}
-`)])],-1),G=e("hr",null,null,-1),B=e("h2",{id:"retrieve-a-folder",tabindex:"-1"},[s("Retrieve a Folder "),e("a",{class:"header-anchor",href:"#retrieve-a-folder"},"#")],-1),N=e("p",null,"List all folders that exist in Directus.",-1),H={class:"two-up"},U={class:"left"},V=e("h3",{id:"query-parameters-1",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),z=s("Supports all "),J=s("global query parameters"),K=s("."),W=e("h3",{id:"returns-1",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),X=e("p",null,[s("Returns a "),e("a",{href:"#the-folder-object"},"folder object"),s(" if a valid primary key was provided.")],-1),Y=e("div",{class:"right"},[e("h3",{id:"rest-api-1",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),e("pre",null,[e("code",null,`GET /folders/:id
-`)]),e("h5",{id:"example-1",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-1"},"#")]),e("pre",null,[e("code",null,`GET /folders/fc02d733-95b8-4e27-bd4b-08a32cbe4e66
-`)]),e("h3",{id:"graphql-1",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-1"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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
-}
-`)])]),e("h5",{id:"example-2",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),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),Z=e("hr",null,null,-1),$=e("h2",{id:"create-a-folder",tabindex:"-1"},[s("Create a Folder "),e("a",{class:"header-anchor",href:"#create-a-folder"},"#")],-1),ee=e("p",null,"Create a new (virtual) folder.",-1),se={class:"two-up"},ae={class:"left"},le=e("h3",{id:"query-parameters-2",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),te=s("Supports all "),ne=s("global query parameters"),re=s("."),de=e("h3",{id:"request-body",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),oe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(". "),e("code",null,"name"),s(" is required.")],-1),ce=e("h3",{id:"returns-2",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),he=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),ie=e("div",{class:"right"},[e("h3",{id:"rest-api-2",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /folders
-`)]),e("h5",{id:"example-3",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),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(`
-`)])]),e("h3",{id:"graphql-2",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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
-}
-`)])]),e("h5",{id:"example-4",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),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),pe=e("hr",null,null,-1),ue=e("h2",{id:"create-multiple-folders",tabindex:"-1"},[s("Create Multiple Folders "),e("a",{class:"header-anchor",href:"#create-multiple-folders"},"#")],-1),_e=e("p",null,"Create multiple new (virtual) folders.",-1),fe={class:"two-up"},be={class:"left"},me=e("h3",{id:"query-parameters-3",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),ge=s("Supports all "),je=s("global query parameters"),ye=s("."),xe=e("h3",{id:"request-body-1",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),qe=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),ve=e("h3",{id:"returns-3",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),we=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was created.")],-1),Ee=e("div",{class:"right"},[e("h3",{id:"rest-api-3",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /folders
-`)]),e("h5",{id:"example-5",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),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(`
-`)])]),e("h3",{id:"graphql-3",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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]
-}
-`)])]),e("h5",{id:"example-6",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),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),Te=e("hr",null,null,-1),Pe=e("h2",{id:"update-a-folder",tabindex:"-1"},[s("Update a Folder "),e("a",{class:"header-anchor",href:"#update-a-folder"},"#")],-1),Re=e("p",null,"Update an existing folder.",-1),ke={class:"two-up"},Se={class:"left"},Fe=e("h3",{id:"query-parameters-4",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Ae=s("Supports all "),Ce=s("global query parameters"),De=s("."),Le=e("h3",{id:"request-body-2",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Qe=e("p",null,[s("A partial "),e("a",{href:"#the-folder-object"},"folder object"),s(".")],-1),Ie=e("h3",{id:"returns-4",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Oe=e("p",null,[s("Returns the "),e("a",{href:"#the-folder-object"},"folder object"),s(" of the folder that was updated.")],-1),Me=e("div",{class:"right"},[e("h3",{id:"rest-api-4",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`PATCH /folders/:id
-`)]),e("h5",{id:"example-7",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),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(`
-`)])]),e("h3",{id:"graphql-4",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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
-}
-`)])]),e("h5",{id:"example-8",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),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),Ge=e("hr",null,null,-1),Be=e("h2",{id:"update-multiple-folders",tabindex:"-1"},[s("Update Multiple Folders "),e("a",{class:"header-anchor",href:"#update-multiple-folders"},"#")],-1),Ne=e("p",null,"Update multiple existing folders.",-1),He={class:"two-up"},Ue={class:"left"},Ve=e("h3",{id:"query-parameters-5",tabindex:"-1"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ze=s("Supports all "),Je=s("global query parameters"),Ke=s("."),We=e("h3",{id:"request-body-3",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Xe=e("div",{class:"definitions"},[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.")]),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"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-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("div",{class:"right"},[e("h3",{id:"rest-api-5",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /folders
-`)]),e("h5",{id:"example-9",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),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(`
-`)])]),e("h3",{id:"graphql-5",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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]
-}
-`)])]),e("h5",{id:"example-10",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),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),es=e("hr",null,null,-1),ss=e("h2",{id:"delete-a-folder",tabindex:"-1"},[s("Delete a Folder "),e("a",{class:"header-anchor",href:"#delete-a-folder"},"#")],-1),as=e("p",null,"Delete an existing folder.",-1),ls=e("div",{class:"two-up"},[e("div",{class:"left"},[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.")]),e("h3",{id:"returns-6",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /folders/:id
-`)]),e("h5",{id:"example-11",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",null,`// DELETE /folders/a5bdb793-dd85-4ac9-882a-b42862092983
-`)]),e("h3",{id:"graphql-6",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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
-}
-`)])]),e("h5",{id:"example-12",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),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),ts=e("hr",null,null,-1),ns=e("h2",{id:"delete-multiple-folders",tabindex:"-1"},[s("Delete Multiple Folders "),e("a",{class:"header-anchor",href:"#delete-multiple-folders"},"#")],-1),rs=e("p",null,"Delete multiple existing folders.",-1),ds=e("div",{class:"two-up"},[e("div",{class:"left"},[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.")]),e("h3",{id:"request-body-4",tabindex:"-1"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")]),e("p",null,"An array of folder primary keys."),e("h3",{id:"returns-7",tabindex:"-1"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-7"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-7",tabindex:"-1"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /folders
-`)]),e("h5",{id:"example-13",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),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(`
-`)])]),e("h3",{id:"graphql-7",tabindex:"-1"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),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
-}
-`)])]),e("h5",{id:"example-14",tabindex:"-1"},[s("Example "),e("a",{class:"header-anchor",href:"#example-14"},"#")]),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),ps="Folders",us=!1,_s="page-reference",fs={name:"folders",setup(os,{expose:d}){const n={title:"Folders",modularExtension:!1,pageClass:"page-reference"};return d({frontmatter:n}),(cs,hs)=>{const l=r("router-link"),o=r("docs-wrapper");return c(),h(o,{frontmatter:n},{default:a(()=>[e("div",i,[p,u,_,f,b,m,g,e("div",j,[e("div",y,[x,e("p",null,[q,t(l,{to:"/docs/reference/query"},{default:a(()=>[v]),_:1}),w]),E,e("p",null,[T,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[P]),_:1}),R,k,S])]),e("div",F,[A,C,e("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[D]),_:1})]),L,Q,I,O,M])]),G,B,N,e("div",H,[e("div",U,[V,e("p",null,[z,t(l,{to:"/docs/reference/query"},{default:a(()=>[J]),_:1}),K]),W,X]),Y]),Z,$,ee,e("div",se,[e("div",ae,[le,e("p",null,[te,t(l,{to:"/docs/reference/query"},{default:a(()=>[ne]),_:1}),re]),de,oe,ce,he]),ie]),pe,ue,_e,e("div",fe,[e("div",be,[me,e("p",null,[ge,t(l,{to:"/docs/reference/query"},{default:a(()=>[je]),_:1}),ye]),xe,qe,ve,we]),Ee]),Te,Pe,Re,e("div",ke,[e("div",Se,[Fe,e("p",null,[Ae,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ce]),_:1}),De]),Le,Qe,Ie,Oe]),Me]),Ge,Be,Ne,e("div",He,[e("div",Ue,[Ve,e("p",null,[ze,t(l,{to:"/docs/reference/query"},{default:a(()=>[Je]),_:1}),Ke]),We,Xe,Ye,Ze]),$e]),es,ss,as,ls,ts,ns,rs,ds])]),_:1})}}};export{fs as default,us as modularExtension,_s as pageClass,ps as title};