@directus/app 9.22.0 → 9.22.2

package/dist/assets/flows.0d69a4cc.js

@@ -1,46 +0,0 @@
-import{a as l,o as r,e as d,y as n,u as t,q as e,z as s}from"./runtime-core.esm-bundler.22ec0346.js";const u={class:"markdown-body"},h=t("blockquote",null,[t("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"},g=t("div",{class:"hint-title"},"Before You Begin",-1),f={class:"tip hint"},w=t("div",{class:"hint-title"},"Learn More",-1),_=t("h2",{id:"what%E2%80%99s-a-flow%3F",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#"),e(" What\u2019s a Flow?")],-1),m=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp",alt:"What's a Flow?"})],-1),y=t("p",null,"Each flow is made up of three elements: A trigger, operations, and a data chain.",-1),b=t("h3",{id:"triggers",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#triggers"},"#"),e(),t("strong",null,"Triggers")],-1),v=t("h3",{id:"operations",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#operations"},"#"),e(" Operations")],-1),j=t("em",null,"send off emails, push in-app notifications, send webhooks, and beyond",-1),k=t("p",null,"To put it in conceptual terms, operations do three things:",-1),x=t("ul",null,[t("li",null,[t("strong",null,"Get data"),e(" from Directus or another outside service.")]),t("li",null,[t("strong",null,"Process data"),e(" a.k.a. transform it, validate it, or whatever.")]),t("li",null,[t("strong",null,"Send data"),e(" to Directus or another outside service.")])],-1),T={class:"tip hint"},C=t("div",{class:"hint-title"},"Developers",-1),F=t("h3",{id:"data-chains",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#data-chains"},"#"),e(" Data Chains")],-1),A=t("p",null,[e("In order for a flow\u2019s operations to track and access the same data, each flow creates its own "),t("a",{href:"#the-data-chain"},"data chain"),e(". Every operation has access to this data chain and each operation appends some value onto this object after it runs. This means you can dynamically access data from a previous operation in the current operation with "),t("a",{href:"#data-chain-variables"},"data chain variables"),e(".")],-1),$=t("h3",{id:"control-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#control-flow"},"#"),e(" Control Flow")],-1),D=t("em",null,"fails by design",-1),E=t("p",null,[e("These kinds of failed operations do not immediately stop your flow. Instead, flows let you implement "),t("a",{href:"https://en.wikipedia.org/wiki/Control_flow",target:"_blank",rel:"noopener noreferrer"},"control flow"),e(", by providing "),t("strong",null,"success paths"),e(" and "),t("strong",null,"failure paths"),e(" within a flow:")],-1),N=t("ul",null,[t("li",null,[t("strong",null,"Success"),e(" \u2014 If "),t("code",null,"operation1"),e(" executes successfully, then "),t("code",null,"operation2"),e(" executes.")]),t("li",null,[t("strong",null,"Failure"),e(" \u2014 Else if "),t("code",null,"operation1"),e(" fails on execution, then "),t("code",null,"operation3"),e(" executes.")])],-1),O=t("p",null,[t("em",null,"And there we have it!"),e(" These are the conceptual cornerstones of any flow. Now you\u2019ll need to know how to actually create a flow, which we discuss in the next section.")],-1),S=t("h2",{id:"configure-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-flow"},"#"),e(" Configure A Flow")],-1),I=t("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Create a Flow"},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4",type:"video/mp4"})],-1),L=t("h3",{id:"create-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#create-a-flow"},"#"),e(" Create a Flow")],-1),Y=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click "),t("span",{mi:"",btn:""},"add"),e(" in the page header. A drawer will open.")]),t("li",null,[e("Under "),t("strong",null,"Flow Setup"),e(", fill in a "),t("strong",null,"Name"),e(" for the flow and the following "),t("em",null,"optional"),e(" details: "),t("ul",null,[t("li",null,[t("strong",null,"Status"),e(" \u2014 Sets the flow to active or inactive.")]),t("li",null,[t("strong",null,"Icon"),e(" \u2014 Adds an icon to help quickly identify the flow.")]),t("li",null,[t("strong",null,"Description"),e(" \u2014 Sets a brief verbal description of the flow.")]),t("li",null,[t("strong",null,"Color"),e(" \u2014 Sets a color to help identify the flow.")]),t("li",null,[t("strong",null,"Activity and Logs Tracking"),e(" \u2014 Lets you "),t("strong",null,"Track Activity and Logs"),e(", "),t("strong",null,"Activity"),e(", or "),t("strong",null,"Neither"),e(".")])])])],-1),K={class:"tip hint"},q=t("a",{href:"#logs"},"Logs",-1),R=t("h3",{id:"configure-a-trigger",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-trigger"},"#"),e(" Configure a Trigger")],-1),P={start:"3"},W=t("span",{mi:"",btn:""},"arrow_forward",-1),B=t("strong",null,"Trigger Setup",-1),V=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" in the menu header to confirm.")],-1),H=t("p",null,"You\u2019ll now see your trigger in an empty grid area. Its time to start adding operations.",-1),J=t("h3",{id:"configure-an-operation",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-an-operation"},"#"),e(" Configure an Operation")],-1),z={start:"5"},G=t("li",null,[e("On the trigger panel, click "),t("span",{mi:""},"add"),e(" and the "),t("strong",null,"Create Operation"),e(" side drawer will open.")],-1),M=t("strong",null,"Name",-1),U=t("br",null,null,-1),Q=t("a",{href:"#the-data-chain"},"data chain",-1),X=t("br",null,null,-1),Z=t("li",null,[e("Next, click "),t("span",{mi:"",btn:""},"done"),e(" in the page header to confirm and return to the flow grid area.")],-1),tt=t("li",null,[e("From here, you can make the following optional configurations: "),t("ul",null,[t("li",null,[t("strong",null,"Reposition"),e(" \u2014 You can drag and drop panels to reposition as desired.")]),t("li",null,[t("strong",null,"Unlink/Relink"),e(" \u2014 Click and drag "),t("span",{mi:"",icon:"",prmry:""},"adjust"),e(" or "),t("span",{mi:"",icon:"",prmry:""},"arrow_forward"),e(" to unlink/relink flows.")]),t("li",null,[t("strong",null,"Duplicate an Operation"),e(" \u2014 To duplicate an operation, click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open its context menu. Click "),t("span",{mi:"",icon:""},"control_point_duplicate"),e(" and a duplicate of the operation (and its configuration details) will be created.")]),t("li",null,[t("strong",null,"Copy an Operation"),e(" \u2014 To copy and paste an operation into another flow, click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open its context menu. Click "),t("span",{mi:"",icon:""},"input"),e(" and a popup menu will open. Choose the desired flow from the dropdown and click "),t("strong",null,"Copy"),e(".")]),t("li",null,[t("strong",null,[t("span",{mi:"",icon:""},"data_object"),e(" Toggle Raw Editor")]),e(" \u2014 Click "),t("span",{mi:"",icon:""},"data_object"),e(" on an operations\u2019 form input fields to toggle the input type between standard and raw value. This is allows you to add a raw value or "),t("a",{href:"#data-chain-variables"},"Data Chain Variables"),e(" within any type of configuration option, even dropdown menus, checkboxes, and radio buttons.")]),t("li",null,[t("strong",null,"Delete an Operation"),e(" \u2014 To delete an operation, click "),t("span",{mi:"",icon:""},"more_vert"),e(" then "),t("span",{mi:"",icon:"",dngr:""},"delete"),e(". A popup menu will appear. Click "),t("strong",null,"Delete"),e(" to confirm.")])])],-1),et=t("li",null,[e("On the newly created operation panel: "),t("ul",null,[t("li",null,[e("Click "),t("span",{mi:"",icon:""},"add"),e(" to add an operation to the "),t("strong",null,"success path"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:""},"remove"),e(" to add an operation to the "),t("strong",null,"failure path"),e(".")])])],-1),nt=t("li",null,"Repeat steps 5-10 to build out your flow as desired.",-1),ot=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" to confirm and create your flow.")],-1),st=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"arrow_back"),e(" to return to the flows list.")],-1),at=t("li",null,"Once created, you may need to re-edit your flow, toggle it to inactive, or delete it.",-1),lt=t("h3",{id:"edit-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#edit-a-flow"},"#"),e(" Edit a Flow")],-1),it=t("ol",null,[t("li",null,"Navigate to the desired flow."),t("li",null,[e("Click "),t("span",{mi:"",btn:"",muted:""},"edit"),e(" in the flow page header and make reconfigurations as desired.")]),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" to confirm.")])],-1),ct=t("h3",{id:"toggle-a-flow-to-inactive",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#toggle-a-flow-to-inactive"},"#"),e(" Toggle a Flow to Inactive")],-1),rt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click "),t("span",{mi:"",icon:""},"more_vert"),e(" on the desired flow.")]),t("li",null,[e("Click "),t("strong",null,[t("span",{mi:"",icon:""},"check"),e(" Set Flow to Active")]),e(" or "),t("strong",null,[t("span",{mi:"",icon:""},"block"),e(" Set Flow to Inactive")]),e(".")])],-1),dt=t("h3",{id:"delete-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#delete-a-flow"},"#"),e(" Delete a Flow")],-1),ut=t("ol",null,[t("li",null,[e("Click "),t("span",{mi:"",icon:""},"more_vert"),e(" on the desired flow to open its context menu.")]),t("li",null,[e("Click "),t("span",{mi:"",icon:"",dngr:""},"delete"),e(" and a popup menu will appear. Click "),t("strong",null,"Delete"),e(" to confirm.")])],-1),ht=t("p",null,"Now that we know how to create and configure a flow, it\u2019s time to get a firmer understanding of the data chain.",-1),pt=t("h2",{id:"the-data-chain",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#the-data-chain"},"#"),e(" The Data Chain")],-1),gt=t("p",null,"Remember, each flow creates its own JSON object to store any data generated.",-1),ft=t("p",null,[e("When the flow begins, three keys are appended to the data chain: "),t("code",null,"$trigger"),e(", "),t("code",null,"$accountability"),e(", and "),t("code",null,"$last"),e(". Then, as each operation runs, it has access to this data chain. Once an operation finishes, its data is appended under its "),t("code",null,"<operationKey>"),e(". When the operation doesn\u2019t generate data, "),t("code",null,"null"),e(" is appended under its key.")],-1),wt=t("p",null,"The following is a highly generic example of a data chain.",-1),_t=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),e(`
-	`),t("span",{class:"hljs-attr"},'"$trigger"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"{"),e(`
-		`),t("span",{class:"hljs-comment"},"// Contains data generated by the flow's trigger."),e(`
-		`),t("span",{class:"hljs-comment"},"// This could include headers, access tokens, payloads, etc."),e(`
-		`),t("span",{class:"hljs-comment"},"// Every data chain has a $trigger key."),e(`
-	`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"$accountability"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"{"),e(`
-		`),t("span",{class:"hljs-comment"},"// Provides details on who/what started the flow."),e(`
-		`),t("span",{class:"hljs-comment"},"// This could include user's id, role, ip address, etc..."),e(`
-		`),t("span",{class:"hljs-comment"},"// Every data chain has an $accountability key."),e(`
-	`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"$last"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"{"),e(`
-		`),t("span",{class:"hljs-comment"},"// The value appended under $last changes after each operation."),e(`
-		`),t("span",{class:"hljs-comment"},"// It stores data of the last operation that executed in the flow."),e(`
-		`),t("span",{class:"hljs-comment"},"// That way, you don't have to remember the previous operation's unique keyname."),e(`
-		`),t("span",{class:"hljs-comment"},"// It's a handy little convenience tool!"),e(`
-		`),t("span",{class:"hljs-comment"},"// Every data chain has a $last key."),e(`
-	`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"operationKey1"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"A value"'),t("span",{class:"hljs-punctuation"},","),e(),t("span",{class:"hljs-comment"},"// The data (if any) generated by the first operation."),e(`
-	`),t("span",{class:"hljs-attr"},'"operationKey2"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"{"),e(`
-		`),t("span",{class:"hljs-attr"},'"nestedKey"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"["),t("span",{class:"hljs-string"},'"nested val"'),t("span",{class:"hljs-punctuation"},","),e(),t("span",{class:"hljs-string"},'"nested val 2"'),t("span",{class:"hljs-punctuation"},"]"),e(),t("span",{class:"hljs-comment"},"// It will be common to have nested JSON data."),e(`
-	`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"operationKey3"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-literal"},[t("span",{class:"hljs-keyword"},"null")]),e(),t("span",{class:"hljs-comment"},"// A null value is appended if no data generated."),e(`
-`),t("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),mt=t("p",null,[e("As you can see, the example above doesn\u2019t have any substantial data inside each key. In reality, there\u2019s going to be a lot of data and it will always be slightly different, based on your flow\u2019s unique configuration. During configuration and debugging, you\u2019ll need to use a tool like "),t("a",{href:"#logs"},"The Log"),e(" to view your data chain and make sure each operation is accessing and generating data as you intended.")],-1),yt=t("div",{class:"tip hint"},[t("p",null,[e("In our examples, we are using generic "),t("em",null,"placeholders"),e(" for operation keys, like "),t("code",null,"<operationKey>"),e(", which might look funny to low-code users. In practice, operation keys will actually have unique and descriptive names, like "),t("code",null,"send_email_7538"),e(".")])],-1),bt=t("div",{class:"tip hint"},[t("p",null,[e("Remember, "),t("code",null,"$trigger"),e(", "),t("code",null,"$accountability"),e(", and "),t("code",null,"$last"),e(" begin with "),t("code",null,"$"),e(", but not "),t("code",null,"operationKeys"),e(".")])],-1),vt=t("h2",{id:"data-chain-variables",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#data-chain-variables"},"#"),e(" Data Chain Variables")],-1),jt=t("p",null,[e("While "),t("a",{href:"#configure-an-operation"},"configuring your operations"),e(", you can use keys from the data chain as variables to access data. Simply wrap the variable with quotes and "),t("em",null,"double mustaches"),e(". For example:")],-1),kt=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-string"},'"{{ $accountability }}"'),e(`
-`)])],-1),xt=t("p",null,[e("will get the data nested under the "),t("code",null,"$accountability"),e(" key, producing something like this:")],-1),Tt=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),e(`
-	`),t("span",{class:"hljs-attr"},'"user"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"4b11492d-631d-4b8a-bca7-2beasdfadf58b"'),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"role"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"12c79228-5361-4905-929b-d69d3w46trs6b"'),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"admin"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-literal"},[t("span",{class:"hljs-keyword"},"true")]),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"app"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-literal"},[t("span",{class:"hljs-keyword"},"true")]),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"ip"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"127.0.0.1"'),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"userAgent"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"Amazon CloudFront"'),e(`
-`),t("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Ct=t("p",null,[e("You can mix your own hard-coded JSON alongside variables."),t("br"),e(" You can also use dot-notation and array indexing to retrieve sub-nested values.")],-1),Ft=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),e(`
-	`),t("span",{class:"hljs-attr"},'"key0"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"a hard-coded value"'),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"key1"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"{{ $trigger.payload }}"'),t("span",{class:"hljs-punctuation"},","),e(`
-	`),t("span",{class:"hljs-attr"},'"key2"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"{{ operationKey.payload.friend_list[0] }}"'),e(`
-`),t("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),At=t("p",null,[e("You "),t("strong",null,"cannot"),e(" pass any type of computation using double-moustache syntax.")],-1),$t=t("pre",null,[t("code",{class:"language-js"},[e(`{
-	`),t("span",{class:"hljs-string"},'"key"'),e(": "),t("span",{class:"hljs-string"},'"{{ 2 + 2 }}"'),e(`,
-	`),t("span",{class:"hljs-string"},'"key2"'),e(": "),t("span",{class:"hljs-string"},'"{{ $trigger.payload.toLowerCase() }}"'),e(`
-}
-`)])],-1),Dt={class:"tip hint"},Et=t("p",null,[e("Certain operations use dropdowns, toggles, checkboxes, and other input options. However, you can bypass this entirely to input raw values directly with "),t("a",{href:"#configure-an-operation"},"Toggle to Raw Editor"),e(". You can use double-moustache syntax to access data dynamically in these input options as well.")],-1),Nt=t("h2",{id:"logs",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logs"},"#"),e(" Logs")],-1),Ot=t("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/logs-20220603A.mp4",type:"video/mp4"})],-1),St=t("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),It=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click the desired flow.")]),t("li",null,[e("Click "),t("strong",null,[t("span",{mi:"",icon:"",prmry:""},"fact_check"),e(" Logs")]),e(" in the sidebar. A side drawer will open, displaying the flow\u2019s logs.")]),t("li",null,"Click a log and another side drawer will open, allowing you to peer through its data."),t("li",null,[e("When finished, click "),t("span",{mi:"",btn:"",muted:""},"close"),e(" to close the drawer.")])],-1),Lt=t("p",null,"Logs are not a 1:1 mapping to the data chain. Each trigger and operation gets its own dropdown, which stores its relevant data. Here\u2019s what you\u2019ll get from each of these:",-1),Yt=t("p",null,[t("strong",null,"Trigger")],-1),Kt=t("ul",null,[t("li",null,[t("strong",null,"Options"),e(" \u2014 The values you input when you configured the trigger."),t("br"),t("em",null,"(These configuration options are not stored on the data chain)"),e(".")]),t("li",null,[t("strong",null,"Payload"),e(" \u2014 Displays the data appended under "),t("code",null,"$trigger"),e(".")]),t("li",null,[t("strong",null,"Accountability"),e(" \u2014 Displays data appended under "),t("code",null,"$accountability"),e(".")])],-1),qt=t("p",null,[e("Note that "),t("code",null,"$accountability"),e(" is not nested under the "),t("code",null,"$trigger"),e(" key. However, it is listed under the Trigger in the Log because "),t("code",null,"$accountability"),e(" is generated by the trigger.")],-1),Rt=t("p",null,[t("strong",null,[t("code",null,"<OperationKey>")])],-1),Pt=t("ul",null,[t("li",null,[t("strong",null,"Options"),e(" \u2014 The values you input when you configured the operation."),t("br"),t("em",null,"(These configuration options are not stored on the data chain)"),e(".")]),t("li",null,[t("strong",null,"Payload"),e(" \u2014 Displays the data appended under this "),t("code",null,"<operationKey>"),e(".")])],-1),Wt=t("strong",null,"Options",-1),Bt=t("code",null,"message",-1),Vt=t("code",null,'"The last operation was a success"',-1),Ht=t("pre",null,[t("code",null,`{
-	"message": "The last operation was a success"
-}
-`)],-1),Jt=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Logs are stored in the database"),t("p",null,"Keep in mind that if you\u2019ve configured a flow to track logs, all this information is stored in the database. You may need to periodically delete this data.")],-1),zt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Where is `$last`?"),t("p",null,[e("You may notice "),t("code",null,"$last"),e(" is not in the Logs. Remember, "),t("code",null,"$last"),e(" constantly updates to store the data of the most recently executed operation. The log shows the results of the entire flow. Therefore "),t("code",null,"$last"),e(" would simply be the very last operation in the flow.")])],-1),Gt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"More on Debugging"),t("p",null,[e("You may find a tool like "),t("a",{href:"https://www.postman.com/",target:"_blank",rel:"noopener noreferrer"},"Postman"),e(" quite helpful for viewing data and debugging flows.")])],-1),Zt="Flows",te=!1,ee="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.",ne="5 min read",oe={__name:"flows",setup(Mt,{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}),(Ut,Qt)=>{const o=l("router-link"),c=l("docs-wrapper");return r(),d(c,{frontmatter:a},{default:n(()=>[t("div",u,[h,t("div",p,[g,t("p",null,[e("Please be sure to see the "),s(o,{to:"/docs/getting-started/quickstart.md"},{default:n(()=>[e("Quickstart Guide")]),_:1}),e(" to get a basic overview of the platform.")])]),t("div",f,[w,t("p",null,[e("There is also dedicated API documentation on "),s(o,{to:"/docs/reference/system/flows"},{default:n(()=>[e("Flows")]),_:1}),e(" and "),s(o,{to:"/docs/reference/system/operations"},{default:n(()=>[e("Operations")]),_:1}),e(".")])]),_,m,y,b,t("p",null,[e("Each flow begins with a "),s(o,{to:"/docs/configuration/flows/triggers"},{default:n(()=>[e("trigger")]),_:1}),e(", which defines the action or event that starts the Flow. This action or event could be some type of transaction within the app, an incoming webhook, a cron job, etc.")]),v,t("p",null,[e("An "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("operation")]),_:1}),e(" is an action or process performed within the flow. These enable you to manage data: "),j,e(".")]),k,x,t("div",T,[C,t("p",null,[e("You can even develop your own "),s(o,{to:"/docs/extensions/operations.md"},{default:n(()=>[e("custom operations")]),_:1}),e(" to fit any use-case.")])]),F,A,$,t("p",null,[e("Not every operation that executes in a flow does so successfully. In some cases, your operations are going to fail. Perhaps an operation tried to access data that doesn\u2019t exist, or a webhook operation fails for some reason, or perhaps you set a "),s(o,{to:"/docs/configuration/flows/operations.md#condition"},{default:n(()=>[e("condition")]),_:1}),e(" operation, which "),D,e(" when its condition is not met.")]),E,N,O,S,I,L,Y,t("div",K,[t("p",null,[e("To learn more, see the section below on "),q,e(" as well as the "),s(o,{to:"/docs/configuration/activity-log.html"},{default:n(()=>[e("Activity Log")]),_:1}),e(" documentation.")])]),R,t("ol",P,[t("li",null,[e("Click "),W,e(" to navigate to "),B,e(". Select a "),s(o,{to:"/docs/configuration/flows/triggers"},{default:n(()=>[e("trigger")]),_:1}),e(" type and configure as desired.")]),V]),H,J,t("ol",z,[G,t("li",null,[e("Choose a "),M,e(", an "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("operation")]),_:1}),e(" type, and configure as desired."),U,e(" Directus will convert the name into a unique operation key, used on the "),Q,e("."),X,e(" If you don\u2019t choose a name, the system will auto-generate a name and key for you.")]),Z,tt,et,nt,ot,st,at]),lt,it,ct,rt,dt,ut,ht,pt,gt,ft,wt,_t,mt,yt,bt,vt,jt,kt,xt,Tt,Ct,Ft,At,$t,t("div",Dt,[t("p",null,[e("To perform computations on flow data, use the "),s(o,{to:"/docs/configuration/flows/operations.md#script"},{default:n(()=>[e("script operation")]),_:1}),e(" or a "),s(o,{to:"/docs/configuration/flows/operations.md#webhook"},{default:n(()=>[e("webhook")]),_:1}),e(".")])]),Et,Nt,Ot,St,It,Lt,Yt,Kt,qt,Rt,Pt,t("p",null,[e("Remember, the "),s(o,{to:"/docs/configuration/flows/operations.md#log-to-console"},{default:n(()=>[e("Log to Console")]),_:1}),e(" operation is a key debugging tool. It does not append data to the data chain. You will view your log message under "),Wt,e(". Therefore, anything you log will always be displayed as nested under a "),Bt,e(" key. For example, if you decide to log "),Vt,e(", it will be displayed as:")]),Ht,Jt,zt,Gt])]),_:1})}}};export{oe as default,ee as description,te as modularExtension,ne as readTime,Zt as title};

package/dist/assets/flows.86b01647.js

@@ -1,172 +0,0 @@
-import{a as o,o as h,e as i,y as e,u as s,q as a,z as n}from"./runtime-core.esm-bundler.22ec0346.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-data-chain",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-data-chain"},"#"),a(" The Data Chain")],-1),f=s("p",null,[s("code",null,"id"),a(),s("strong",null,"uuid"),s("br"),a(" Primary key of the flow.")],-1),g=s("p",null,[s("code",null,"name"),a(),s("strong",null,"string"),s("br"),a(" Name for the flow.")],-1),m=s("p",null,[s("code",null,"icon"),a(),s("strong",null,"string"),s("br"),a(" Icon displayed in the Admin App for the flow.")],-1),j=s("p",null,[s("code",null,"color"),a(),s("strong",null,"string"),s("br"),a(" Color of the icon displayed in the Admin App for the flow.")],-1),w=s("p",null,[s("code",null,"note"),a(),s("strong",null,"text"),s("br"),a(" Short description displayed in the Admin App.")],-1),b=s("p",null,[s("code",null,"status"),a(),s("strong",null,"string"),s("br"),a(" Current status of the flow. One of "),s("code",null,"active"),a(", "),s("code",null,"inactive"),a(". Defaults to "),s("code",null,"active"),a(" when not specified.")],-1),y=s("p",null,[s("code",null,"trigger"),a(),s("strong",null,"string"),s("br"),a(" Type of trigger for the flow. One of "),s("code",null,"hook"),a(", "),s("code",null,"webhook"),a(", "),s("code",null,"operation"),a(", "),s("code",null,"schedule"),a(", "),s("code",null,"manual"),a(".")],-1),x=s("p",null,[s("code",null,"options"),a(),s("strong",null,"json"),s("br"),a(" Options of the selected trigger for the flow.")],-1),q=s("p",null,[s("code",null,"accountability"),a(),s("strong",null,"string"),s("br"),a(" The permission used during the flow. One of "),s("code",null,"$public"),a(", "),s("code",null,"$trigger"),a(", "),s("code",null,"$full"),a(", or UUID of a role.")],-1),E=s("p",null,[s("code",null,"date_created"),a(),s("strong",null,"timestamp"),s("br"),a(" 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"),a(),s("strong",null,"string"),s("br"),a(" 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"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"2fab3b9d-0543-4b87-8a30-3c5ee66fedf1"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"bolt"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"color"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"#112233"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Note for my flow"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"manual"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"accountability"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"$trigger"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"date_created"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"2022-05-11T13:14:52Z"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"user_created"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"operation"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"92e82998-e421-412f-a513-13701e83e4ce"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),A=s("hr",null,null,-1),F=s("h2",{id:"list-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-flows"},"#"),a(" List Flows")],-1),I=s("p",null,"List all flows that exist in Directus.",-1),O=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),a(" Query Parameters")],-1),D=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),a(" Returns")],-1),v=s("a",{href:"#the-data-chain"},"data chains",-1),L=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),a(" REST API")],-1),Q=s("pre",null,[s("code",null,`GET /flows
-SEARCH /flows
-`)],-1),C=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),a(" GraphQL")],-1),G=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),M=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),a(` {
-	flows: [directus_flows]
-}
-`)])],-1),U=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),a(" Example")],-1),B=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(` {
-	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"},"#"),a(" 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"},"#"),a(" Query Parameters")],-1),z=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),a(" Returns")],-1),Z=s("p",null,[a("Returns the requested "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),J=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),a(" 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"},"#"),a(" 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"},"#"),a(" GraphQL")],-1),ss=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),as=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),a(` {
-	flows_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),a(`!): directus_flows
-}
-`)])],-1),es=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),a(" Example")],-1),ts=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(` {
-	flows_by_id(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),a(`) {
-		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"},"#"),a(" 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"},"#"),a(" Query Parameters")],-1),cs=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),a(" Request Body")],-1),hs=s("p",null,[a("A partial "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),is=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),a(" Returns")],-1),ds=s("p",null,[a("Returns the "),s("a",{href:"#the-data-chain"},"data chain"),a(" for the created flow.")],-1),ps=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),a(" 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"},"#"),a(" Example")],-1),fs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"manual"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),gs=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),a(" GraphQL")],-1),ms=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),js=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),a(` {
-	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"},"#"),a(" Example")],-1),bs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	create_flows_item(data: { name: `),s("span",{class:"hljs-string"},'"My Flow"'),a(", status: "),s("span",{class:"hljs-string"},'"active"'),a(", trigger: "),s("span",{class:"hljs-string"},'"manual"'),a(` }) {
-		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"},"#"),a(" 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"},"#"),a(" Query Parameters")],-1),Ts=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),a(" Request Body")],-1),Ps=s("p",null,[a("An array of partial "),s("a",{href:"#the-data-chain"},"data chains"),a(".")],-1),ks=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),a(" Returns")],-1),Ss=s("p",null,[a("Returns the "),s("a",{href:"#the-data-chain"},"data chain"),a(" for the created flow.")],-1),Rs=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),a(" 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"},"#"),a(" Example")],-1),Is=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"["),a(`
-	`),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"manual"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Another Flow"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"active"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"trigger"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"webhook"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"]"),a(`
-`)])],-1),Os=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),a(" GraphQL")],-1),Ds=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),vs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),a(` {
-	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"},"#"),a(" Example")],-1),Qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	create_flows_items(
-		data: [
-			{
-				`),s("span",{class:"hljs-string"},'"name"'),a(": "),s("span",{class:"hljs-string"},'"My Flow"'),a(`,
-				`),s("span",{class:"hljs-string"},'"status"'),a(": "),s("span",{class:"hljs-string"},'"active"'),a(`,
-				`),s("span",{class:"hljs-string"},'"trigger"'),a(": "),s("span",{class:"hljs-string"},'"manual"'),a(`
-			},
-			{
-				`),s("span",{class:"hljs-string"},'"name"'),a(": "),s("span",{class:"hljs-string"},'"Another Flow"'),a(`,
-				`),s("span",{class:"hljs-string"},'"status"'),a(": "),s("span",{class:"hljs-string"},'"active"'),a(`,
-				`),s("span",{class:"hljs-string"},'"trigger"'),a(": "),s("span",{class:"hljs-string"},'"webhook"'),a(`
-			}
-		]
-	) {
-		id
-		name
-		status
-	}
-}
-`)])],-1),Cs=s("hr",null,null,-1),Gs=s("h2",{id:"update-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-flow"},"#"),a(" Update a Flow")],-1),Ms=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"},"#"),a(" Query Parameters")],-1),Bs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),a(" Request Body")],-1),Hs=s("p",null,[a("A partial "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),Ns=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),a(" Returns")],-1),$s=s("p",null,[a("Returns the "),s("a",{href:"#the-data-chain"},"data chain"),a(" for the updated flow.")],-1),Vs=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),a(" 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"},"#"),a(" Example")],-1),Js=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Updated Flow"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Ks=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),a(" 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"),a(` {
-	update_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),a(`!, data: update_directus_flows_input): directus_flows
-}
-`)])],-1),Ys=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),a(" Example")],-1),sa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	update_flows_item(id: `),s("span",{class:"hljs-string"},'"2fc325fb-299b-4d20-a9e7-a34349dee8b2"'),a(", data: { name: "),s("span",{class:"hljs-string"},'"My Updated Flow"'),a(` }) {
-		id
-		name
-	}
-}
-`)])],-1),aa=s("hr",null,null,-1),ea=s("h2",{id:"update-multiple-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-flows"},"#"),a(" Update Multiple Flows")],-1),ta=s("p",null,"Update multiple existing flows.",-1),na=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),a(" Query Parameters")],-1),la=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),a(" Request Body")],-1),oa=s("p",null,[s("code",null,"keys"),a(),s("strong",null,"Required"),s("br"),a(" Array of primary keys of the flows you\u2019d like to update.")],-1),ra=s("p",null,[s("code",null,"data"),a(),s("strong",null,"Required"),s("br"),a(" Any of "),s("a",{href:"#the-data-chain"},"the data chain"),a("\u2019s properties.")],-1),ca=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),a(" Returns")],-1),ha=s("p",null,[a("Returns the "),s("a",{href:"#the-data-chain"},"data chains"),a(" for the updated flows.")],-1),ia=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),a(" REST API")],-1),da=s("pre",null,[s("code",null,`PATCH /flows
-`)],-1),pa=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),a(" Example")],-1),ua=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"inactive"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),_a=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),a(" GraphQL")],-1),fa=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ga=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),a(` {
-	update_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),a(`!]!, data: update_directus_flows_input): [directus_flows]
-}
-`)])],-1),ma=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),a(" Example")],-1),ja=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	update_flows_items(
-		ids: [`),s("span",{class:"hljs-string"},'"3f2facab-7f05-4ee8-a7a3-d8b9c634a1fc"'),a(", "),s("span",{class:"hljs-string"},'"7259bfa8-3786-45c6-8c08-cc688e7ba229"'),a(`]
-		data: { status: `),s("span",{class:"hljs-string"},'"inactive"'),a(` }
-	) {
-		id
-		name
-		status
-	}
-}
-`)])],-1),wa=s("hr",null,null,-1),ba=s("h2",{id:"delete-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-flow"},"#"),a(" Delete a Flow")],-1),ya=s("p",null,"Delete an existing flow.",-1),xa=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),a(" Returns")],-1),qa=s("p",null,"Empty body.",-1),Ea=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),a(" REST API")],-1),Ta=s("pre",null,[s("code",null,`DELETE /flows/:id
-`)],-1),Pa=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),a(" Example")],-1),ka=s("pre",null,[s("code",null,`DELETE /flows/12204ee2-2c82-4d9a-b044-2f4842a11dba
-`)],-1),Sa=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),a(" GraphQL")],-1),Ra=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Aa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),a(` {
-	delete_flows_item(id:`),s("span",{class:"hljs-literal"}," ID"),a(`!): delete_one
-}
-`)])],-1),Fa=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),a(" Example")],-1),Ia=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	delete_flows_item(id: `),s("span",{class:"hljs-string"},'"12204ee2-2c82-4d9a-b044-2f4842a11dba"'),a(`) {
-		id
-	}
-}
-`)])],-1),Oa=s("hr",null,null,-1),Da=s("h2",{id:"delete-multiple-flows",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-flows"},"#"),a(" Delete Multiple Flows")],-1),va=s("p",null,"Delete multiple existing flows.",-1),La=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),a(" Request Body")],-1),Qa=s("p",null,"An array of flows primary keys",-1),Ca=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),a(" Returns")],-1),Ga=s("p",null,"Empty body.",-1),Ma=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),a(" REST API")],-1),Ua=s("pre",null,[s("code",null,`DELETE /flows
-`)],-1),Ba=s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),a(" Example")],-1),Ha=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /flows"),a(`
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-`)])],-1),Na=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),a(" GraphQL")],-1),$a=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Va=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),a(` {
-	delete_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),a(`!]!): delete_many
-}
-`)])],-1),za=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),a(" Example")],-1),Za=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	delete_flows_items(
-		ids: [
-			`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),a(`
-			`),s("span",{class:"hljs-string"},'"02b9486e-4273-4fd5-b94b-e18fd923d1ed"'),a(`
-			`),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),a(`
-		]
-	) {
-		ids
-	}
-}
-`)])],-1),Ja=s("h2",{id:"flow-with-get-webhook-trigger",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#flow-with-get-webhook-trigger"},"#"),a(" Flow with GET webhook trigger")],-1),Ka=s("p",null,"Start a flow with GET webhook trigger.",-1),Wa=s("h3",{id:"returns-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-8"},"#"),a(" Returns")],-1),Xa=s("p",null,"Result of the flow, if any.",-1),Ya=s("h3",{id:"rest-api-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-8"},"#"),a(" REST API")],-1),se=s("pre",null,[s("code",null,`GET /flows/trigger/:flow_uuid
-`)],-1),ae=s("h5",{id:"example-15",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-15"},"#"),a(" Example")],-1),ee=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// GET /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),a(`
-`),s("span",{class:"hljs-comment"},"// Payload here"),a(`
-`)])],-1),te=s("h2",{id:"flow-with-post-webhook-trigger",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#"),a(" Flow with POST webhook trigger")],-1),ne=s("p",null,"Start a flow with POST webhook trigger.",-1),le=s("h3",{id:"request-body-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-5"},"#"),a(" Request Body")],-1),oe=s("p",null,"Payload for the POST request.",-1),re=s("h3",{id:"returns-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-9"},"#"),a(" Returns")],-1),ce=s("p",null,"Result of the flow, if any.",-1),he=s("h3",{id:"rest-api-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-9"},"#"),a(" REST API")],-1),ie=s("pre",null,[s("code",null,`POST /flows/trigger/:flow_uuid
-`)],-1),de=s("h5",{id:"example-16",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-16"},"#"),a(" Example")],-1),pe=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),a(`
-`),s("span",{class:"hljs-comment"},"// Payload here"),a(`
-`)])],-1),me="Flows",je=!1,we="REST and GraphQL API documentation on the Flows collection in Directus.",be="5 min read",ye="page-reference",xe={__name:"flows",setup(ue,{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}),(_e,fe)=>{const t=o("router-link"),c=o("docs-wrapper");return h(),i(c,{frontmatter:l},{default:e(()=>[s("div",d,[p,u,_,f,g,m,j,w,b,y,x,q,E,s("p",null,[T,a(),P,k,a(" The user who created the flow. Many-to-one to "),n(t,{to:"/docs/reference/system/users#the-users-object"},{default:e(()=>[a("users")]),_:1}),a(".")]),S,R,A,F,I,O,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),D,s("p",null,[a("An array of up to "),n(t,{to:"/docs/reference/query#limit"},{default:e(()=>[a("limit")]),_:1}),a(),v,a(". If no items are available, data will be an empty array.")]),L,Q,s("p",null,[n(t,{to:"/docs/reference/introduction#search-http-method"},{default:e(()=>[a("Learn more about SEARCH ->")]),_:1})]),C,G,M,U,B,H,N,$,V,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),z,Z,J,K,W,X,Y,ss,as,es,ts,ns,ls,os,rs,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),cs,hs,is,ds,ps,us,_s,fs,gs,ms,js,ws,bs,ys,xs,qs,Es,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Ts,Ps,ks,Ss,Rs,As,Fs,Is,Os,Ds,vs,Ls,Qs,Cs,Gs,Ms,Us,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Bs,Hs,Ns,$s,Vs,zs,Zs,Js,Ks,Ws,Xs,Ys,sa,aa,ea,ta,na,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),la,oa,ra,ca,ha,ia,da,pa,ua,_a,fa,ga,ma,ja,wa,ba,ya,xa,qa,Ea,Ta,Pa,ka,Sa,Ra,Aa,Fa,Ia,Oa,Da,va,La,Qa,Ca,Ga,Ma,Ua,Ba,Ha,Na,$a,Va,za,Za,Ja,Ka,Wa,Xa,Ya,se,ae,ee,te,ne,le,oe,re,ce,he,ie,de,pe])]),_:1})}}};export{xe as default,we as description,je as modularExtension,ye as pageClass,be as readTime,me as title};

package/dist/assets/fo-FO.cc444b75.js

@@ -1 +0,0 @@
-var e={identifier:"Ey\xF0kenni",avatar:"Vangamynd",application:"N\xFDtsluskipan",default_provider:"Standard",published:"\xDAt Givi\xF0",draft:"Kladda",archived:"Skjalasavna",modules:"Modulir",module_bar:"Modul Bj\xE1lki",tile_size:"Fl\xEDsa St\xF8dd",edit_field:"R\xE6tta Teig",conditions:"Treytir",maps:"Kort",switch_user:"Skift Br\xFAkara",item_creation:"Stovna Lut",item_revision:"Endursko\xF0a Lut",enter_a_name:"\xC1set eitt Navn...",duplicate_field:"Tv\xEDfalda Teig",half_width:"H\xE1lv Breidd",full_width:"Full Breidd",group:"B\xF3lkur",and:"Og",or:"Ella",fill_width:"Fyll Breiddina",field_name_translations:"Navna Teiga Umsetingar",enter_password_to_enable_tfa:"Skriva t\xEDtt loynior\xF0 fyri at virkja Tvey-Stigs Samgildi (2FA)",add_field:"Legg afturat Teig",role_name:"Leikluts Heiti",branch:"Grein",leaf:"Bla\xF0",indeterminate:"\xD3vist",edit_collection:"R\xE6tta Savn",exclusive:"Ser\xFArval",children:"B\xF8rn",db_only_click_to_configure:"Einans D\xE1tugrunnur: Klikkja fyri at Stilla",show_active_items:"V\xEDs Virknar Lutir",show_archived_items:"V\xEDs Skjalasavna\xF0ir Lutir",show_all_items:"V\xEDs Allar Lutir",edited:"Vir\xF0i er broytt",required:"Ney\xF0ugt",required_for_app_access:"Ney\xF0ugt til App Atgongd",requires_value:"Ney\xF0ugt vir\xF0i",create_preset:"Stovna Undanstilling",create_panel:"Stovna Talvu",create_role:"Stovna Leiklut",create_user:"Stovna Br\xFAkara",delete_panel:"Strika Talvu",create_webhook:"Stovna Webhook",invite_users:"Bj\xF3\xF0a Br\xFAkarum",invite:"Bj\xF3\xF0a",email_already_invited:'Telduposturin "{email}" hevur longu fingi\xF0 eina innbj\xF3\xF0ing',subject:"Evni",inbox:"Innbakki",emails:"Teldupostar",connection_excellent:"Fr\xE1l\xEDkt Samband",connection_good:"Gott Samband",connection_fair:"Hampiligt Samband",connection_poor:"Ringt Samband",primary:"Primer",rename_folder:"Umdoyp Faldara",delete_folder:"Strika Faldara",prefix:"Forskoyti",suffix:"Eftirskoyti",reset_bookmark:"Nullstilla B\xF3kamerki",update_bookmark:"R\xE6tta B\xF3kamerki",delete_bookmark:"Strika B\xF3kamerki",delete_bookmark_copy:'Ert t\xFA vissur \xED at t\xFA vilt strika "{bookmark}" b\xF3kamerki? Hendan ger\xF0 kann ikki angrast.',logoutReason:{SIGN_OUT:"Rita\xF0ur \xDAt",SESSION_EXPIRED:"Sambandi er \xDAtgingi\xF0"},public_label:"Alment",public_description:"St\xFDrir hvat API d\xE1ta til taks uttan samgildi.",not_allowed:"Ikki loyvt",directus_version:"Directus \xDAtg\xE1va",node_version:"Node \xDAtg\xE1va",node_uptime:"Node N\xFDtslut\xED\xF0",os_type:"OS Slag",os_version:"OS \xDAtg\xE1va",os_uptime:"OS N\xFDtslut\xED\xF0",os_totalmem:"OS Minni",archive:"Skjalasavna",archive_confirm:"Ert t\xFA v\xEDsur \xED at t\xFA vilt skjalasavna hendan lutin?",archive_confirm_count:"Eingir lutir eru valdir | Ert t\xFA v\xEDsur \xED at t\xFA vilt skjalasavna hendan lutin? | Ert t\xFA v\xEDsur \xED at t\xFA vilt skjalasavna hesar {count} lutir?",reset_system_permissions_to:"Nullstilla kervis r\xE6ttindini til:",reset_system_permissions_copy:"Hendan ger\xF0 fer at yvirskriva \xF8ll br\xFAkara sett loyvi sum t\xFA kanst hava n\xFDtt \xE1 kerviss\xF8vnini. Ert t\xFA v\xEDsur?",system:"Kervi",interface_label:"Takf\xF8risflati",creating_collection_system:"Virkjan og n\xFDnevnan av \xF8llum hesum valfr\xED\xF0u Teigum.",no_collections_copy:"T\xFA hevur eingi S\xF8vn enn. Set teg vinarliga \xED samband vi\xF0 kervisfyrisitarin.",system_collections:"Kerviss\xF8vnini",interface_options:"Takf\xF8risflatastillingar",optional_system_fields:"Valfr\xED Kervisteigar",page_help_activity_collection:"**Kaga Virksemi** \u2014 Ein dr\xFAvur listi av \xF8llum t\xEDnum kervisbr\xFAkarum innan kervisvirksemi og innihaldsvirksemi.",page_help_settings_datamodel_collections:"**D\xE1tamynd: S\xF8vn** \u2014 V\xEDsir \xF8ll t\xF8k s\xF8vn. Hettar fevnir um sj\xF3nlig, goymd, og kerviss\xF8vn, harumframt \xF3vi\xF0gj\xF8rd d\xE1tugrunnstalvur, sum kunnu leggjast afturat.",page_help_users_collection:"**Br\xFAkara Directory** \u2014 V\xEDsir ein lista yvir \xF8llum kervisbr\xFAkarum innan hesari verk\xE6tlan.",system_fields_locked:"Kervisteigar eru l\xE6stir og kunnu ikki broytast",directus_collection:{directus_roles:"B\xF3lkar av loyvum fyri kervisbr\xFAkarum",directus_users:"Kervisbr\xFAkarir til verk\xE6tlanina"},fields:{directus_users:{theme_auto:"Sj\xE1lvvirkin (Grunda \xE1 Kervi)"},directus_settings:{module_bar:"Modul Bj\xE1lki"},directus_fields:{translation:"Navna Teiga Umsetingar"},directus_roles:{name:"Leikluts Heiti"}},field_options:{directus_collections:{archive_divider:"Skjalasavna"},directus_users:{dropdown_auto:"Sj\xE1lvvirkin (Grunda \xE1 Kervi)"}},interfaces:{"presentation-links":{primary:"Primer"},"system-collection":{collection:"Savn",description:"Vel millum galdandi S\xF8vn",include_system_collections:"Tel vi\xF0 Kerviss\xF8vnini"},"system-collections":{collections:"S\xF8vn",description:"Vel millum galdandi S\xF8vn",include_system_collections:"Tel vi\xF0 Kerviss\xF8vnini"},"system-display-template":{"display-template":"S\xFDna fram skapil\xF3n",description:"Blanda \xF3broytandi tekst og dynamiskar teigvir\xF0ir",collection_field:"Savnteigur",collection_field_not_setup:"Stillingin til savnteigin skeivt stilla",select_a_collection:"Vel eitt savn"},"system-interface":{interface:"Takf\xF8risflati",description:"Vel ein galdandi takf\xF8risflata",placeholder:"Vel ein takf\xF8risflata..."},"system-interface-options":{"interface-options":"Takf\xF8risflatastillingar"},"system-folder":{folder:"Faldari",description:"Vel ein faldara",field_hint:"Faldari til uppsendum f\xEDlum. \xC1virkar ikki galdandi f\xEDlum.",root_name:"F\xEDlasavns R\xF3t",system_default:"Grundkervi"},"input-rich-text-html":{folder_note:"Faldari til uppsendum f\xEDlum. \xC1virkar ikki galdandi f\xEDlum."}},displays:{datetime:{suffix:"Eftirskoyti"},"formatted-value":{prefix:"Forskoyti",suffix:"Eftirskoyti"}}},i=e.identifier,a=e.avatar,r=e.application,t=e.default_provider,l=e.published,n=e.draft,s=e.archived,o=e.modules,_=e.module_bar,d=e.tile_size,v=e.edit_field,c=e.conditions,u=e.maps,m=e.switch_user,p=e.item_creation,f=e.item_revision,k=e.enter_a_name,g=e.duplicate_field,y=e.half_width,h=e.full_width,b=e.group,S=e.and,w=e.or,j=e.fill_width,T=e.field_name_translations,x=e.enter_password_to_enable_tfa,B=e.add_field,E=e.role_name,V=e.branch,N=e.leaf,F=e.indeterminate,K=e.edit_collection,R=e.exclusive,q=e.children,L=e.db_only_click_to_configure,G=e.show_active_items,H=e.show_archived_items,O=e.show_all_items,A=e.edited,I=e.required,D=e.required_for_app_access,U=e.requires_value,M=e.create_preset,P=e.create_panel,z=e.create_role,W=e.create_user,X=e.delete_panel,C=e.create_webhook,J=e.invite_users,Q=e.invite,Y=e.email_already_invited,Z=e.subject,$=e.inbox,ee=e.emails,ie=e.connection_excellent,ae=e.connection_good,re=e.connection_fair,te=e.connection_poor,le=e.primary,ne=e.rename_folder,se=e.delete_folder,oe=e.prefix,_e=e.suffix,de=e.reset_bookmark,ve=e.update_bookmark,ce=e.delete_bookmark,ue=e.delete_bookmark_copy,me=e.logoutReason,pe=e.public_label,fe=e.public_description,ke=e.not_allowed,ge=e.directus_version,ye=e.node_version,he=e.node_uptime,be=e.os_type,Se=e.os_version,we=e.os_uptime,je=e.os_totalmem,Te=e.archive,xe=e.archive_confirm,Be=e.archive_confirm_count,Ee=e.reset_system_permissions_to,Ve=e.reset_system_permissions_copy,Ne=e.system,Fe=e.interface_label,Ke=e.creating_collection_system,Re=e.no_collections_copy,qe=e.system_collections,Le=e.interface_options,Ge=e.optional_system_fields,He=e.page_help_activity_collection,Oe=e.page_help_settings_datamodel_collections,Ae=e.page_help_users_collection,Ie=e.system_fields_locked,De=e.directus_collection,Ue=e.fields,Me=e.field_options,Pe=e.interfaces,ze=e.displays;export{B as add_field,S as and,r as application,Te as archive,xe as archive_confirm,Be as archive_confirm_count,s as archived,a as avatar,V as branch,q as children,c as conditions,ie as connection_excellent,re as connection_fair,ae as connection_good,te as connection_poor,P as create_panel,M as create_preset,z as create_role,W as create_user,C as create_webhook,Ke as creating_collection_system,L as db_only_click_to_configure,e as default,t as default_provider,ce as delete_bookmark,ue as delete_bookmark_copy,se as delete_folder,X as delete_panel,De as directus_collection,ge as directus_version,ze as displays,n as draft,g as duplicate_field,K as edit_collection,v as edit_field,A as edited,Y as email_already_invited,ee as emails,k as enter_a_name,x as enter_password_to_enable_tfa,R as exclusive,T as field_name_translations,Me as field_options,Ue as fields,j as fill_width,h as full_width,b as group,y as half_width,i as identifier,$ as inbox,F as indeterminate,Fe as interface_label,Le as interface_options,Pe as interfaces,Q as invite,J as invite_users,p as item_creation,f as item_revision,N as leaf,me as logoutReason,u as maps,_ as module_bar,o as modules,Re as no_collections_copy,he as node_uptime,ye as node_version,ke as not_allowed,Ge as optional_system_fields,w as or,je as os_totalmem,be as os_type,we as os_uptime,Se as os_version,He as page_help_activity_collection,Oe as page_help_settings_datamodel_collections,Ae as page_help_users_collection,oe as prefix,le as primary,fe as public_description,pe as public_label,l as published,ne as rename_folder,I as required,D as required_for_app_access,U as requires_value,de as reset_bookmark,Ve as reset_system_permissions_copy,Ee as reset_system_permissions_to,E as role_name,G as show_active_items,O as show_all_items,H as show_archived_items,Z as subject,_e as suffix,m as switch_user,Ne as system,qe as system_collections,Ie as system_fields_locked,d as tile_size,ve as update_bookmark};

package/dist/assets/folders.9f7079f9.js

@@ -1,132 +0,0 @@
-import{a as r,o as c,e as h,y as a,u as e,q as s,z as n}from"./runtime-core.esm-bundler.22ec0346.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),P=e("h3",{id:"rest-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api"},"#"),s(" REST API")],-1),w=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),Pe=e("h5",{id:"example-6",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example-6"},"#"),s(" Example")],-1),we=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),Ps=e("p",null,"Delete multiple existing folders.",-1),ws=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.")]),P,w,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,Pe,we,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,Ps,ws,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.d793c760.js

@@ -1 +0,0 @@
-import{z as S}from"./index.9250c6d1.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};