@directus/app 9.14.5 → 9.16.0

package/dist/assets/operations.9b3b2514.js

@@ -1,169 +0,0 @@
-import{a as o,o as c,b as p,w as a,g as s,e as n,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},d=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Operations are the building blocks of Data Flows 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-operation-object"},"The Operation Object ")]),s("li",null,[s("a",{href:"#list-operations"},"List Operations ")]),s("li",null,[s("a",{href:"#retrieve-an-operation"},"Retrieve an operation ")]),s("li",null,[s("a",{href:"#create-an-operation"},"Create an Operation ")]),s("li",null,[s("a",{href:"#create-multiple-operations"},"Create Multiple Operations ")]),s("li",null,[s("a",{href:"#update-an-operation"},"Update an Operation ")]),s("li",null,[s("a",{href:"#update-multiple-operations"},"Update Multiple Operations ")]),s("li",null,[s("a",{href:"#delete-an-operation"},"Delete an Operation ")]),s("li",null,[s("a",{href:"#delete-multiple-operations"},"Delete Multiple Operations ")]),s("li",null,[s("a",{href:"#triggering-an-operation"},"Triggering an operation ")])])])])])],-1),u=s("hr",null,null,-1),_=s("h2",{id:"the-operation-object",tabindex:"-1"},[e("The Operation Object "),s("a",{class:"header-anchor",href:"#the-operation-object"},"#")],-1),g={class:"two-up"},j={class:"left"},f={class:"definitions"},m=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the operation.")],-1),b=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name for the operation.")],-1),y=s("p",null,[s("code",null,"key"),e(),s("strong",null,"string"),s("br"),e(" Key for the operation. Must be unique within a given flow.")],-1),x=s("p",null,[s("code",null,"type"),e(),s("strong",null,"string"),s("br"),e(" Type of operation. One of "),s("code",null,"log"),e(", "),s("code",null,"mail"),e(", "),s("code",null,"notification"),e(", "),s("code",null,"create"),e(", "),s("code",null,"read"),e(", "),s("code",null,"request"),e(", "),s("code",null,"sleep"),e(", "),s("code",null,"transform"),e(", "),s("code",null,"trigger"),e(", "),s("code",null,"condition"),e(", or any type of custom operation extensions.")],-1),q=s("p",null,[s("code",null,"options"),e(),s("strong",null,"json"),s("br"),e(" Options depending on the type of the operation.")],-1),w=s("p",null,[s("code",null,"position_x"),e(),s("strong",null,"integer"),s("br"),e(" Position of the operation on the X axis within the flow workspace.")],-1),k=s("p",null,[s("code",null,"position_y"),e(),s("strong",null,"integer"),s("br"),e(" Position of the operation on the Y axis within the flow workspace.")],-1),v=s("p",null,[s("code",null,"date_created"),e(),s("strong",null,"timestamp"),s("br"),e(" Timestamp in ISO8601 when the operation was created.")],-1),T=s("code",null,"user_created",-1),E=e(),O=s("strong",null,"many-to-one",-1),P=s("br",null,null,-1),R=e(" The user who created the operation. Many-to-one to "),S=e("users"),A=e("."),L=s("p",null,[s("code",null,"resolve"),e(),s("strong",null,"uuid"),s("br"),e(" The operation triggered when the current operation succeeds (or "),s("code",null,"then"),e(" logic of a condition operation). Primary key of an "),s("a",{href:"#the-operation-object"},"operation"),e(".")],-1),M=s("p",null,[s("code",null,"reject"),e(),s("strong",null,"uuid"),s("br"),e(" The operation triggered when the current operation fails (or "),s("code",null,"otherwise"),e(" logic of a condition operation). Primary key of an "),s("a",{href:"#the-operation-object"},"operation"),e(".")],-1),D=s("code",null,"flow",-1),C=e(),I=s("strong",null,"many-to-one",-1),Q=s("br",null,null,-1),G=e(" The flow containing this operation. Many-to-one to "),B=e("flows"),U=e("."),H=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"},'"585b04cd-2821-4dcc-a563-ae5d29ecace2"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Log a Message"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log_message"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"position_x"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"12"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"position_y"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"24"),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"},'"resolve"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"bf4099c0-c54c-4736-ab4e-95e2487595e4"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"reject"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"flow"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"22544db5-93f7-48e2-a028-7ae02c8fe49a"'),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])])],-1),N=s("hr",null,null,-1),V=s("h2",{id:"list-operations",tabindex:"-1"},[e("List Operations "),s("a",{class:"header-anchor",href:"#list-operations"},"#")],-1),F=s("p",null,"List all operations that exist in Directus.",-1),K={class:"two-up"},X={class:"left"},Y=s("h3",{id:"query-parameters",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),Z=e("Supports all "),z=e("global query parameters"),J=e("."),W=s("h3",{id:"returns",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),$=e("An array of up to "),ss=e("limit"),es=e(),as=s("a",{href:"#the-operation-object"},"operation objects",-1),ts=e(". If no items are available, data will be an empty array."),ns={class:"right"},ls=s("h3",{id:"rest-api",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),os=s("pre",null,[s("code",null,`GET /operations
-SEARCH /operations
-`)],-1),rs=e("Learn more about SEARCH ->"),is=s("h3",{id:"graphql",tabindex:"-1"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),cs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ps=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	operations: [directus_operations]
-}
-`)])],-1),hs=s("h5",{id:"example",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),ds=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	operations {
-		id
-		name
-		key
-	}
-}
-`)])],-1),us=s("hr",null,null,-1),_s=s("h2",{id:"retrieve-an-operation",tabindex:"-1"},[e("Retrieve an operation "),s("a",{class:"header-anchor",href:"#retrieve-an-operation"},"#")],-1),gs=s("p",null,"List an existing operation by primary key.",-1),js={class:"two-up"},fs={class:"left"},ms=s("h3",{id:"query-parameters-1",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),bs=e("Supports all "),ys=e("global query parameters"),xs=e("."),qs=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-operation-object"},"operation object"),e(".")],-1),ks=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 /operations/: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 /operations/3c636d1c-4eb2-49cd-8a6d-3ec571ab3390
-`)]),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(` {
-	operations_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_operations
-}
-`)])]),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(` {
-	operations_by_id(id: `),s("span",{class:"hljs-number"},"42"),e(`) {
-		id
-		name
-		key
-	}
-}
-`)])])],-1),vs=s("hr",null,null,-1),Ts=s("h2",{id:"create-an-operation",tabindex:"-1"},[e("Create an Operation "),s("a",{class:"header-anchor",href:"#create-an-operation"},"#")],-1),Es=s("p",null,"Create a new operation.",-1),Os={class:"two-up"},Ps={class:"left"},Rs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Ss=e("Supports all "),As=e("global query parameters"),Ls=e("."),Ms=s("h3",{id:"request-body",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ds=s("p",null,[e("A partial "),s("a",{href:"#the-operation-object"},"operation object"),e(".")],-1),Cs=s("h3",{id:"returns-2",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Is=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),e(" for the created operation.")],-1),Qs=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 /operations
-`)]),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 /operations"),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 Log"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"my_log"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log"'),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_operations_item(data: create_directus_operations_input!): directus_operations
-}
-`)])]),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_operations_item(data: { name: `),s("span",{class:"hljs-string"},'"My Log"'),e(", key: "),s("span",{class:"hljs-string"},'"my_log"'),e(", "),s("span",{class:"hljs-keyword"},"type"),e(": "),s("span",{class:"hljs-string"},'"log"'),e(` }) {
-		id
-		name
-		key
-	}
-}
-`)])])],-1),Gs=s("hr",null,null,-1),Bs=s("h2",{id:"create-multiple-operations",tabindex:"-1"},[e("Create Multiple Operations "),s("a",{class:"header-anchor",href:"#create-multiple-operations"},"#")],-1),Us=s("p",null,"Create multiple new operations.",-1),Hs={class:"two-up"},Ns={class:"left"},Vs=s("h3",{id:"query-parameters-3",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Fs=e("Supports all "),Ks=e("global query parameters"),Xs=e("."),Ys=s("h3",{id:"request-body-1",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),Zs=s("p",null,[e("An array of partial "),s("a",{href:"#the-operation-object"},"operation objects"),e(".")],-1),zs=s("h3",{id:"returns-3",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Js=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),e(" for the created operation.")],-1),Ws=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 /operations
-`)]),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 /operations"),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 Log"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"my_log"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"log"'),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"},'"Send Notification"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"key"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"send_notification"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"notification"'),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_operations_items(data: [create_directus_operations_input!]!): [directus_operations]
-}
-`)])]),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_operations_items(
-		data: [
-			{
-				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"My Log"'),e(`,
-				`),s("span",{class:"hljs-string"},'"key"'),e(": "),s("span",{class:"hljs-string"},'"my_log"'),e(`,
-				`),s("span",{class:"hljs-string"},'"type"'),e(": "),s("span",{class:"hljs-string"},'"log"'),e(`
-			},
-			{
-				`),s("span",{class:"hljs-string"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Send Notification"'),e(`,
-				`),s("span",{class:"hljs-string"},'"key"'),e(": "),s("span",{class:"hljs-string"},'"send_notification"'),e(`,
-				`),s("span",{class:"hljs-string"},'"type"'),e(": "),s("span",{class:"hljs-string"},'"notification"'),e(`
-			}
-		]
-	) {
-		id
-		name
-		key
-	}
-}
-`)])])],-1),$s=s("hr",null,null,-1),se=s("h2",{id:"update-an-operation",tabindex:"-1"},[e("Update an Operation "),s("a",{class:"header-anchor",href:"#update-an-operation"},"#")],-1),ee=s("p",null,"Update an existing operation.",-1),ae={class:"two-up"},te={class:"left"},ne=s("h3",{id:"query-parameters-4",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),le=e("Supports all "),oe=e("global query parameters"),re=e("."),ie=s("h3",{id:"request-body-2",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ce=s("p",null,[e("A partial "),s("a",{href:"#the-operation-object"},"operation object"),e(".")],-1),pe=s("h3",{id:"returns-4",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),he=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation object"),e(" for the updated operation.")],-1),de=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 /operation/: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 /operation/7d62f1e9-a83f-407b-84f8-1c184f014501"),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 Operation"'),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_operations_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_operations_input): directus_operations
-}
-`)])]),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_operations_item(id: `),s("span",{class:"hljs-string"},'"7d62f1e9-a83f-407b-84f8-1c184f014501"'),e(", data: { name: "),s("span",{class:"hljs-string"},'"My Updated Operation"'),e(` }) {
-		id
-		name
-	}
-}
-`)])])],-1),ue=s("hr",null,null,-1),_e=s("h2",{id:"update-multiple-operations",tabindex:"-1"},[e("Update Multiple Operations "),s("a",{class:"header-anchor",href:"#update-multiple-operations"},"#")],-1),ge=s("p",null,"Update multiple existing operations.",-1),je={class:"two-up"},fe={class:"left"},me=s("h3",{id:"query-parameters-5",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),be=e("Supports all "),ye=e("global query parameters"),xe=e("."),qe=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 operations 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-operation-object"},"the operation object"),e("\u2019s properties.")])],-1),ke=s("h3",{id:"returns-5",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ve=s("p",null,[e("Returns the "),s("a",{href:"#the-operation-object"},"operation objects"),e(" for the updated operations.")],-1),Te=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 /operations
-`)]),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 /operations"),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"},'"6a25fb7c-26a4-4dcb-a474-d47b6a203a38"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),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"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Updated Operations"'),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_operations_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_operations_input): [directus_operations]
-}
-`)])]),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_operations_items(
-		ids: [`),s("span",{class:"hljs-string"},'"6a25fb7c-26a4-4dcb-a474-d47b6a203a38"'),e(", "),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),e(`]
-		data: { name: `),s("span",{class:"hljs-string"},'"Updated Operations"'),e(` }
-	) {
-		id
-		name
-		key
-	}
-}
-`)])])],-1),Ee=s("hr",null,null,-1),Oe=s("h2",{id:"delete-an-operation",tabindex:"-1"},[e("Delete an Operation "),s("a",{class:"header-anchor",href:"#delete-an-operation"},"#")],-1),Pe=s("p",null,"Delete an existing operation.",-1),Re=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 /operations/: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 /operations/07ac467e-1900-4c62-9637-8dac2ab97f71
-`)]),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_operations_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_operations_item(id: `),s("span",{class:"hljs-string"},'"07ac467e-1900-4c62-9637-8dac2ab97f71"'),e(`) {
-		id
-	}
-}
-`)])])])],-1),Se=s("hr",null,null,-1),Ae=s("h2",{id:"delete-multiple-operations",tabindex:"-1"},[e("Delete Multiple Operations "),s("a",{class:"header-anchor",href:"#delete-multiple-operations"},"#")],-1),Le=s("p",null,"Delete multiple existing operations.",-1),Me=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 operations 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 /operations
-`)]),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 /operations"),e(`
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"a791ce73-41a2-4fb7-8f67-c7ba176cc719"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"4e57ab0e-f4ec-47b5-9dad-e36f08a25642"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"5fe0a6f6-18ad-4bb3-94c6-2e033246c784"'),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_operations_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_operations_items(
-		ids: [
-			`),s("span",{class:"hljs-string"},'"a791ce73-41a2-4fb7-8f67-c7ba176cc719"'),e(`
-			`),s("span",{class:"hljs-string"},'"4e57ab0e-f4ec-47b5-9dad-e36f08a25642"'),e(`
-			`),s("span",{class:"hljs-string"},'"5fe0a6f6-18ad-4bb3-94c6-2e033246c784"'),e(`
-		]
-	) {
-		ids
-	}
-}
-`)])])])],-1),De=s("h2",{id:"triggering-an-operation",tabindex:"-1"},[e("Triggering an operation "),s("a",{class:"header-anchor",href:"#triggering-an-operation"},"#")],-1),Ce=s("p",null,"Trigger an operation based on primary key.",-1),Ie=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 operation, if needed."),s("h3",{id:"returns-8",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Result of the operation, 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,`POST /operations/trigger/:operation_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"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),e(`
-`),s("span",{class:"hljs-comment"},"// Payload here"),e(`
-`)])])])],-1),He="Operations",Ne=!1,Ve="page-reference",Fe={name:"operations",setup(Qe,{expose:r}){const l={title:"Operations",modularExtension:!1,pageClass:"page-reference"};return r({frontmatter:l}),(Ge,Be)=>{const t=o("router-link"),i=o("docs-wrapper");return c(),p(i,{frontmatter:l},{default:a(()=>[s("div",h,[d,u,_,s("div",g,[s("div",j,[s("div",f,[m,b,y,x,q,w,k,v,s("p",null,[T,E,O,P,R,n(t,{to:"/docs/reference/system/users/#the-users-object"},{default:a(()=>[S]),_:1}),A]),L,M,s("p",null,[D,C,I,Q,G,n(t,{to:"/docs/reference/system/flows/#the-flow-object"},{default:a(()=>[B]),_:1}),U])])]),H]),N,V,F,s("div",K,[s("div",X,[Y,s("p",null,[Z,n(t,{to:"/docs/reference/query"},{default:a(()=>[z]),_:1}),J]),W,s("p",null,[$,n(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[ss]),_:1}),es,as,ts])]),s("div",ns,[ls,os,s("p",null,[n(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[rs]),_:1})]),is,cs,ps,hs,ds])]),us,_s,gs,s("div",js,[s("div",fs,[ms,s("p",null,[bs,n(t,{to:"/docs/reference/query"},{default:a(()=>[ys]),_:1}),xs]),qs,ws]),ks]),vs,Ts,Es,s("div",Os,[s("div",Ps,[Rs,s("p",null,[Ss,n(t,{to:"/docs/reference/query"},{default:a(()=>[As]),_:1}),Ls]),Ms,Ds,Cs,Is]),Qs]),Gs,Bs,Us,s("div",Hs,[s("div",Ns,[Vs,s("p",null,[Fs,n(t,{to:"/docs/reference/query"},{default:a(()=>[Ks]),_:1}),Xs]),Ys,Zs,zs,Js]),Ws]),$s,se,ee,s("div",ae,[s("div",te,[ne,s("p",null,[le,n(t,{to:"/docs/reference/query"},{default:a(()=>[oe]),_:1}),re]),ie,ce,pe,he]),de]),ue,_e,ge,s("div",je,[s("div",fe,[me,s("p",null,[be,n(t,{to:"/docs/reference/query"},{default:a(()=>[ye]),_:1}),xe]),qe,we,ke,ve]),Te]),Ee,Oe,Pe,Re,Se,Ae,Le,Me,De,Ce,Ie])]),_:1})}}};export{Fe as default,Ne as modularExtension,Ve as pageClass,He as title};

package/dist/assets/operations.f00b8c11.js

@@ -1 +0,0 @@
-import{a as l,o as d,b as c,w as o,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,"When a Flow is triggered, it performs an Operation. Whether you need to manage data within Directus, send information off to outside services, set conditional logic or even trigger other Flows, these simple but powerful Operations can make it happen.")],-1),_=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#condition"},"Condition ")]),e("li",null,[e("a",{href:"#create-data"},"Create Data ")]),e("li",null,[e("a",{href:"#delete-data"},"Delete Data ")]),e("li",null,[e("a",{href:"#read-data"},"Read Data ")]),e("li",null,[e("a",{href:"#update-data"},"Update Data ")]),e("li",null,[e("a",{href:"#log-to-console"},"Log to Console ")]),e("li",null,[e("a",{href:"#send-email"},"Send Email ")]),e("li",null,[e("a",{href:"#send-notification"},"Send Notification ")]),e("li",null,[e("a",{href:"#webhook-%2F-request-url"},"Webhook / Request URL ")]),e("li",null,[e("a",{href:"#sleep"},"Sleep ")]),e("li",null,[e("a",{href:"#transform-payload"},"Transform Payload ")]),e("li",null,[e("a",{href:"#trigger-flow"},"Trigger Flow ")])])])],-1),p={class:"tip hint"},f=e("div",{class:"hint-title"},"Before You Begin",-1),m=t("Please be sure to read the documentation on "),g=t("Flows"),w=t(" and "),y=t("Triggers"),b=t("."),I=e("h2",{id:"condition",tabindex:"-1"},[t("Condition "),e("a",{class:"header-anchor",href:"#condition"},"#")],-1),O=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/condition-20220603A.webp",alt:"Condition"})],-1),D=e("p",null,[t("A Condition routes to the next success or failure Operation based on some conditional "),e("code",null,"if"),t(" / "),e("code",null,"else"),t(" logic defined by a Filter query. That means if the query condition is met, the Flow will move forward with the success Operation. Otherwise, the failure Operation will initiate.")],-1),v=e("strong",null,"Condition Rules",-1),C=t(" \u2014 Create conditions with "),k=t("Filter Rules"),T=t("."),S=e("h2",{id:"create-data",tabindex:"-1"},[t("Create Data "),e("a",{class:"header-anchor",href:"#create-data"},"#")],-1),F=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/create-data-20220603A.webp",alt:"Create Data"})],-1),A=e("p",null,"This Operation creates Item(s) in a Collection.",-1),x=e("li",null,[e("strong",null,"Collection"),t(" \u2014 Use the dropdown menu to select the Collection you\u2019d like to create Items in.")],-1),q=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Select the scope of permissions used for this Operation.")],-1),R=e("li",null,[e("strong",null,"Emit Events"),t(" \u2014 Toggle whether the event is emitted.")],-1),U=e("strong",null,"Payload",-1),P=t(" \u2014 Create Item(s) in a Collection. To learn more, see "),E=t("API > Items"),L=t("."),N={class:"tip hint"},j=t("Make sure the Operation is scoped with the "),B=t("permissions"),W=t(" necessary to create Items."),M=e("h2",{id:"delete-data",tabindex:"-1"},[t("Delete Data "),e("a",{class:"header-anchor",href:"#delete-data"},"#")],-1),J=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/delete-data-20220603A.webp",alt:"Delete Data"})],-1),Y=e("p",null,"This Operation deletes Item(s) from a Collection by ID or query.",-1),H=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Set the scope of permissions used for this Operation.")],-1),Q=e("li",null,[e("strong",null,"Collection"),t(" \u2014 Use the dropdown menu to select the Collection you\u2019d like to delete Items from.")],-1),V=e("li",null,[e("strong",null,"IDs"),t(" \u2014 Set Item IDs and press enter to confirm. Click the ID to remove.")],-1),G=e("strong",null,"Query",-1),z=t(" \u2014 Select Items to delete with a query. To learn more, see "),K=t("Filter Rules"),X=t("."),Z={class:"tip hint"},$=t("Make sure the Operation is scoped with the "),ee=t("permissions"),te=t(" necessary to delete Items."),oe=e("h2",{id:"read-data",tabindex:"-1"},[t("Read Data "),e("a",{class:"header-anchor",href:"#read-data"},"#")],-1),se=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/read-data-20220603A.webp",alt:"Read Data"})],-1),ne=e("p",null,"This Operation reads Item(s) from a Collection and adds them onto the Flow Object. You may select Items by their ID or run a query to select the Items you wish to update.",-1),ie=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Set the scope of permissions used for this Operation.")],-1),le=e("li",null,[e("strong",null,"Collections"),t(" \u2014 Select the Collection from which you\u2019d like to read Items.")],-1),ae=e("li",null,[e("strong",null,"IDs"),t(" \u2014 Input the ID for Items you wish to read and press enter. Click the ID to remove.")],-1),re=e("strong",null,"Query",-1),de=t(" \u2014 Select the Items with a query. To learn more, see "),ce=t("Filter Rules"),he=t("."),ue=e("h2",{id:"update-data",tabindex:"-1"},[t("Update Data "),e("a",{class:"header-anchor",href:"#update-data"},"#")],-1),_e=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/update-data-20220603A.webp",alt:"Update Data"})],-1),pe=e("p",null,"This Operation updates Item(s) in a Collection. Similar to Read Data, you may select Items by their ID or run a query to select the Items you wish to update.",-1),fe=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Set the Role that this Operation will inherit permissions from.")],-1),me=e("li",null,[e("strong",null,"Collections"),t(" \u2014 Select the Collection from which you\u2019d like to read Items.")],-1),ge=e("li",null,[e("strong",null,"IDs"),t(" \u2014 Input the ID for Item(s) you wish to read and press enter. Click the ID to remove.")],-1),we=e("strong",null,"Payload",-1),ye=t(" \u2014 Update Items in a Collection. To learn more, see "),be=t("API > Items"),Ie=t("."),Oe=e("strong",null,"Query",-1),De=t(" \u2014 Select Items to update with a query. To learn more, see "),ve=t("Filter Rules"),Ce=t("."),ke=e("h2",{id:"log-to-console",tabindex:"-1"},[t("Log to Console "),e("a",{class:"header-anchor",href:"#log-to-console"},"#")],-1),Te=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/log-to-console-20220603A.webp",alt:"Log to Console"})],-1),Se=t("This Operation outputs something to the server-side console as well as the "),Fe=t("Log Panel"),Ae=t(". This is a key tool for troubleshooting Flow configuration."),xe=e("strong",null,"Message",-1),qe=t(" \u2014 Sets a "),Re=t("log message"),Ue=t("."),Pe=e("h2",{id:"send-email",tabindex:"-1"},[t("Send Email "),e("a",{class:"header-anchor",href:"#send-email"},"#")],-1),Ee=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/send-email-20220603A.webp",alt:"Send Email"})],-1),Le=e("p",null,"This Operation sends an email. Flow Object keys can be used as variables, which means you can use an array of emails from a previous step in Flows.",-1),Ne=e("ul",null,[e("li",null,[e("strong",null,"To"),t(" \u2014 Set the email addresses. Hit "),e("code",null,"\u21B5"),t(" to save the email. Click an email to remove it.")]),e("li",null,[e("strong",null,"Subject"),t(" \u2014 Set the subject line.")]),e("li",null,[e("strong",null,"Body"),t(" \u2014 Use a WYSIWYG editor to create the email body.")])],-1),je=e("div",{class:"tip hint"},[e("p",null,[t("If you are testing out this Operation locally from "),e("code",null,"localhost:8080"),t(", be sure to check your spam box, as your email provider may send it there automatically.")])],-1),Be=e("h2",{id:"send-notification",tabindex:"-1"},[t("Send Notification "),e("a",{class:"header-anchor",href:"#send-notification"},"#")],-1),We=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/send-notification-20220603A.webp",alt:"Send Notification"})],-1),Me=e("p",null,"This Operation sends a notification to an app user.",-1),Je=e("strong",null,"Users",-1),Ye=t(" \u2014 Define a User by their primary key UUID. Use "),He=t("Flow keys"),Qe=t(" to set this dynamically."),Ve=e("li",null,[e("strong",null,"Permissions"),t(" \u2014 Define the Role that this Operation will inherit permissions from.")],-1),Ge=e("li",null,[e("strong",null,"Title"),t(" \u2014 Set the notification title.")],-1),ze=e("li",null,[e("strong",null,"Message"),t(" \u2014 Set the main body of the notification.")],-1),Ke=e("h2",{id:"webhook-%2F-request-url",tabindex:"-1"},[t("Webhook / Request URL "),e("a",{class:"header-anchor",href:"#webhook-%2F-request-url"},"#")],-1),Xe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/webhook-20220603A.webp",alt:"Webhok / Request URL"})],-1),Ze=e("p",null,"This Operation makes a request to another URL.",-1),$e=e("ul",null,[e("li",null,[e("strong",null,"Method"),t(" \u2014 Choose to make a GET, POST, PATCH, DELETE, or other type of request.")]),e("li",null,[e("strong",null,"URL"),t(" \u2014 Define the URL to send the request to.")]),e("li",null,[e("strong",null,"Headers"),t(" \u2014 Create a new "),e("code",null,"header:value"),t(" to pass along with the request.")]),e("li",null,[e("strong",null,"Request Body"),t(" \u2014 Set the request body data, using any string or JSON.")])],-1),et=e("h2",{id:"sleep",tabindex:"-1"},[t("Sleep "),e("a",{class:"header-anchor",href:"#sleep"},"#")],-1),tt=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/sleep-20220603A.webp",alt:"Sleep"})],-1),ot=e("p",null,"This Operation pauses Operation Execution on the Flow for a given amount of milliseconds, then continues to the next Operation.",-1),st=e("ul",null,[e("li",null,[e("strong",null,"Milliseconds"),t(" \u2014 Define the number of milliseconds the Operation will pause.")])],-1),nt=e("h2",{id:"transform-payload",tabindex:"-1"},[t("Transform Payload "),e("a",{class:"header-anchor",href:"#transform-payload"},"#")],-1),it=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/transform-payload-20220603A.webp",alt:"Transform Payload"})],-1),lt=e("p",null,[t("Transform Payload simply creates a new key on the Flow Object with nested JSON data to provide a clean space where you can combine data from multiple Flow keys into a single object. For example, if you need to use the same data multiple times "),e("em",null,"(e.g. send it in a web request and also use it to create an Item in a Collection)"),t(", you can combine the data with Transform Payload once, then access its Operation key repeatedly.")],-1),at=e("ul",null,[e("li",null,[e("strong",null,"JSON"),t(" \u2014 Define JSON to insert into the Flow Object.")])],-1),rt=e("h2",{id:"trigger-flow",tabindex:"-1"},[t("Trigger Flow "),e("a",{class:"header-anchor",href:"#trigger-flow"},"#")],-1),dt=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/operations/operations-20220603A/trigger-flow-20220603A.webp",alt:"Trigger Flow"})],-1),ct=t("This Operation starts another Flow and passes data to it. It should be used in combination with the "),ht=t("Another Flow"),ut=t(" Trigger."),_t=e("ul",null,[e("li",null,[e("strong",null,"Flow"),t(" \u2014 Define a Flow by its primary key UUID.")]),e("li",null,[e("strong",null,"Payload"),t(" \u2014 Define JSON to insert into the Flow Object.")])],-1),wt="Operations",yt=!1,bt={name:"operations",setup(pt,{expose:a}){const i={title:"Operations",modularExtension:!1};return a({frontmatter:i}),(ft,mt)=>{const s=l("router-link"),r=l("docs-wrapper");return d(),c(r,{frontmatter:i},{default:o(()=>[e("div",h,[u,_,e("div",p,[f,e("p",null,[m,n(s,{to:"/docs/configuration/flows"},{default:o(()=>[g]),_:1}),w,n(s,{to:"/docs/configuration/flows/triggers"},{default:o(()=>[y]),_:1}),b])]),I,O,D,e("ul",null,[e("li",null,[v,C,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[k]),_:1}),T])]),S,F,A,e("ul",null,[x,q,R,e("li",null,[U,P,n(s,{to:"/docs/reference/items/"},{default:o(()=>[E]),_:1}),L])]),e("div",N,[e("p",null,[j,n(s,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[B]),_:1}),W])]),M,J,Y,e("ul",null,[H,Q,V,e("li",null,[G,z,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[K]),_:1}),X])]),e("div",Z,[e("p",null,[$,n(s,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[ee]),_:1}),te])]),oe,se,ne,e("ul",null,[ie,le,ae,e("li",null,[re,de,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[ce]),_:1}),he])]),ue,_e,pe,e("ul",null,[fe,me,ge,e("li",null,[we,ye,n(s,{to:"/docsreference/items/"},{default:o(()=>[be]),_:1}),Ie]),e("li",null,[Oe,De,n(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[ve]),_:1}),Ce])]),ke,Te,e("p",null,[Se,n(s,{to:"/docs/configuration/flows/#logs"},{default:o(()=>[Fe]),_:1}),Ae]),e("ul",null,[e("li",null,[xe,qe,n(s,{to:"/docs/configuration/flows/#logs"},{default:o(()=>[Re]),_:1}),Ue])]),Pe,Ee,Le,Ne,je,Be,We,Me,e("ul",null,[e("li",null,[Je,Ye,n(s,{to:"/docs/configuration/flows/flows/#the-flow-object"},{default:o(()=>[He]),_:1}),Qe]),Ve,Ge,ze]),Ke,Xe,Ze,$e,et,tt,ot,st,nt,it,lt,at,rt,dt,e("p",null,[ct,n(s,{to:"/docs/configuration/triggers/#another-flow"},{default:o(()=>[ht]),_:1}),ut]),_t])]),_:1})}}};export{bt as default,yt as modularExtension,wt as title};

package/dist/assets/overview.288d5f54.js

@@ -1 +0,0 @@
-import{a,o as r,b as d,w as o,g as t,e as s,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";var u="assets/app-overview.6445a201.svg";const h={class:"markdown-body"},p=t("blockquote",null,[t("p",null,"The App is a no-code presentation layer for your data, content, and assets. It uses an intuitive left-to-right visual hierarchy for general organization and navigation.")],-1),_=t("img",{src:u,alt:"Directus Application Overview",class:"no-shadow"},null,-1),g=t("h2",{id:"1.-module-bar",tabindex:"-1"},[e("1. Module Bar "),t("a",{class:"header-anchor",href:"#1.-module-bar"},"#")],-1),f=t("p",null,"The leftmost section of the App is the module bar, which includes the:",-1),m=t("li",null,[t("strong",null,"Project Logo"),e(" \u2014 Displays your configured project logo and project color (defaults to the Directus logo and color). If configured, clicking this component will navigate to the Project URL. During platform activity, an indeterminate progress indicator will also be shown here.")],-1),b=t("strong",null,"Module Navigation",-1),v=e(" \u2014 Allows navigating between the different modules your user has access to. Customizing the Module Navigation is done within the "),y=e("Project Settings"),w=e(", but the default module list includes: "),x=e("Content"),A=e(" \u2014 The primary way to view and interact with database content"),k=e("User Directory"),T=e(" \u2014 A dedicated section for the platform\u2019s system Users"),P=e("File Library"),N=e(" \u2014 An aggregate of all files uploaded and managed within the platform"),C=e("Insights"),j=e(" \u2014 Access to infinitely customizable data dashboards"),B=e("App Guide"),I=e(" \u2014 A tailored, in-app portal for the platform\u2019s concepts, guides, and reference"),S=e("Settings"),D=e(" \u2014 An admin-only section for configuring the project and system settings"),M=t("strong",null,"Notifications",-1),L=e(" - Opens a drawer of notifications, such as from "),U=e("mentions"),z=e("."),O=t("li",null,[t("strong",null,"Current User Menu"),e(" \u2014 This component displays the authenticated user\u2019s name and avatar. "),t("ul",null,[t("li",null,"Sign Out \u2014 Hovering over the User Menu exposes the button to log out of the platform.")])],-1),V=t("h2",{id:"2.-navigation-bar",tabindex:"-1"},[e("2. Navigation Bar "),t("a",{class:"header-anchor",href:"#2.-navigation-bar"},"#")],-1),E=t("p",null,"The navigation bar is based on the current module, and includes:",-1),F=t("strong",null,"Project Name",-1),H=e(" \u2014 Shows an icon and tooltip indicating the API\u2019s connection strength, and the name of your current project, which can be configured under "),R=e("Project Settings"),q=e("."),G=t("strong",null,"Navigation",-1),X=e(" \u2014 This is a dynamic navigation based on your current module. Some modules also support "),J=e("Bookmark Presets"),K=e(", which are a customizable links to specific data-sets."),Q=t("h2",{id:"3.-page",tabindex:"-1"},[e("3. Page "),t("a",{class:"header-anchor",href:"#3.-page"},"#")],-1),W=t("p",null,"This is where the current page\u2019s content is shown, including:",-1),Y=t("ul",null,[t("li",null,[t("strong",null,"Header"),e(" \u2014 A fixed section at the top of each page, the header includes: "),t("ul",null,[t("li",null,"Page Icon \u2014 Clicking this navigates back to the previous page."),t("li",null,"Module Name \u2014 Clicking this navigates to the parent module/section."),t("li",null,"Page Title \u2014 Displays dynamic title of the current page."),t("li",null,"Action Buttons \u2014 Right-aligned contextual buttons for specific page actions.")])]),t("li",null,[t("strong",null,"Page Content"),e(" \u2014 This displays the content of the page you navigated to.")])],-1),Z=t("h2",{id:"4.-sidebar",tabindex:"-1"},[e("4. Sidebar "),t("a",{class:"header-anchor",href:"#4.-sidebar"},"#")],-1),$=t("p",null,"The sidebar provides additional context and options for the current page, including:",-1),tt=t("ul",null,[t("li",null,[t("strong",null,"Page Components"),e(" \u2014 Lists any contextual page components available. The \u201CInfo\u201D component is available on every page, explaining the page\u2019s general purpose and relevant details. Clicking any sidebar component will accordion it open. If the App window is large enough, the sidebar will automatically open, and can be closed by clicking the \u201CX\u201D in the top-right.")]),t("li",null,[t("strong",null,"Notifications Tray"),e(" \u2014 Fixed to the bottom of the page sidebar, this button opens a tray of recent user notifications, and provides a link to your Activity Log page.")])],-1),it="The Application",at=!1,lt={name:"overview",setup(et,{expose:l}){const i={title:"The Application",modularExtension:!1};return l({frontmatter:i}),(ot,nt)=>{const n=a("router-link"),c=a("docs-wrapper");return r(),d(c,{frontmatter:i},{default:o(()=>[t("div",h,[p,_,g,f,t("ul",null,[m,t("li",null,[b,v,s(n,{to:"/docs/app/settings"},{default:o(()=>[y]),_:1}),w,t("ul",null,[t("li",null,[s(n,{to:"/docs/app/content-collections/"},{default:o(()=>[x]),_:1}),A]),t("li",null,[s(n,{to:"/docs/app/user-directory"},{default:o(()=>[k]),_:1}),T]),t("li",null,[s(n,{to:"/docs/app/file-library"},{default:o(()=>[P]),_:1}),N]),t("li",null,[s(n,{to:"/docs/app/insights"},{default:o(()=>[C]),_:1}),j]),t("li",null,[s(n,{to:"/docs/app/overview/"},{default:o(()=>[B]),_:1}),I]),t("li",null,[s(n,{to:"/docs/app/settings"},{default:o(()=>[S]),_:1}),D])])]),t("li",null,[M,L,s(n,{to:"/docs/app/content-items/#mentions"},{default:o(()=>[U]),_:1}),z]),O]),V,E,t("ul",null,[t("li",null,[F,H,s(n,{to:"/docs/app/settings"},{default:o(()=>[R]),_:1}),q]),t("li",null,[G,X,s(n,{to:"/docs/getting-started/glossary/#presets"},{default:o(()=>[J]),_:1}),K])]),Q,W,Y,Z,$,tt])]),_:1})}}};export{lt as default,at as modularExtension,it as title};

package/dist/assets/overview.c3e64ee1.js

@@ -1 +0,0 @@
-import{a as c,o as d,b as r,w as o,g as e,e as a,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Whether you\u2019re a hobbyist, startup or Fortune 500 enterprise, our flexible Cloud service lets you get up and running with Directus quickly. We do all the heavy lifting of managing your infrastructure and software updates - and you also benefit from fair and predictable usage-based pricing.")],-1),_=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/hero-image-20220402A.webp",alt:"Hero Image"})],-1),m=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#getting-started"},"Getting Started ")]),e("li",null,[e("a",{href:"#accounts"},"Accounts ")]),e("li",null,[e("a",{href:"#teams"},"Teams ")]),e("li",null,[e("a",{href:"#projects"},"Projects ")])])])],-1),p=e("a",{href:"https://directus.cloud/",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),g=t(" is a hosting platform for "),f=t("Directus Projects"),b=t(" which handles data storage, hosting, updates and scalability so you can focus on building your digital apps and experiences. There are three "),y=t("tiers of Cloud Projects"),v=t(": Community, Standard and Enterprise. All three tiers come with all the great features of Directus Core, as well as all "),T=t("Cloud Exclusive"),w=t(" extensions."),j=t("The Cloud Dashboard is constructed to manage three key components: "),P=t("Accounts"),A=t(", "),x=t("Teams"),C=t(" and "),k=t("Projects"),D=t(". First, create an Account. Once logged in, create or join a Team, and your Account will become a Member of that Team. Once that\u2019s complete, you can create Projects within a Team."),M=t("Accounts can be Members on multiple Teams. All Team Members have SuperAdmin privileges to manage the Team\u2019s Projects, Project "),S=t("billing"),V=t(", other Team Members and the Team itself. Teams can have multiple Team Members and multiple Projects. Projects can only be managed by one Team and cannot be transferred to new Teams."),O=e("h2",{id:"getting-started",tabindex:"-1"},[t("Getting Started "),e("a",{class:"header-anchor",href:"#getting-started"},"#")],-1),B=t("To make life easy, you have the option to "),E=t("create and login to your free Cloud Account"),H=t(" automatically with GitHub. If you don\u2019t have a GitHub account or prefer not to use this login method, email-and-password login is available, as well. Once logged in, create a new Team or select an existing Team. Then you can access and manage the Team\u2019s associated Projects, billing details, Team Members, Activity and Settings."),N=e("video",{alt:"Cloud Dashboard Overview",loop:"",muted:"",controls:"",autoplay:""},[e("source",{src:"https://cdn.directus.io/docs/v9/cloud/overview/overview-20220322A/cloud-dashboard-overview-20220329A.mp4",type:"video/mp4"})],-1),G=t("Remember: The Dashboard layout itself is designed to manage "),q=t("Accounts"),F=t(", "),I=t("Teams"),R=t(" and "),W=t("Projects"),z=t(". Here\u2019s how the Dashboard layout relates to each of these components:"),J=e("h2",{id:"accounts",tabindex:"-1"},[t("Accounts "),e("a",{class:"header-anchor",href:"#accounts"},"#")],-1),K=e("h3",{id:"cloud-dashboard-header",tabindex:"-1"},[t("Cloud Dashboard Header "),e("a",{class:"header-anchor",href:"#cloud-dashboard-header"},"#")],-1),L=e("ul",null,[e("li",null,[e("span",{mi:"",icon:""},"check"),t(" \u2014 View Directus Cloud [system status](/cloud/glossary/#system-status). ")]),e("li",null,[e("span",{mi:"",icon:""},"notifications"),t(" \u2014 Notifications such as version upgrades, platform upgrades, etc. ")]),e("li",null,[e("span",{mi:"",icon:""},"help_outline"),t(" \u2014 Documentation, Community Support and Request for Premium Support. ")]),e("li",null,[e("span",{mi:"",icon:""},"expand_more"),t(" \u2014 [Create new Teams](/cloud/teams/#create-a-team) and navigate between Teams you are on. ")]),e("li",null,[e("span",{mi:"",icon:""},"account_circle"),t(" \u2014 [Access, edit or destroy Account](/cloud/accounts). ")])],-1),Q=e("h2",{id:"teams",tabindex:"-1"},[t("Teams "),e("a",{class:"header-anchor",href:"#teams"},"#")],-1),U=t("Team Members"),X=t(" \u2014 View, invite and remove other Team Members or leave a Team."),Y=t("Team Activity"),Z=t(" \u2014 View Team activity such as Project creation and deletion, billing information changes, Member invitations and removals, etc."),$=t("Team Settings"),ee=t(" \u2014 Edit the Team Name and Team Slug, as well as "),te=t("destroy a Team"),oe=t("."),se=e("h2",{id:"projects",tabindex:"-1"},[t("Projects "),e("a",{class:"header-anchor",href:"#projects"},"#")],-1),ae=t("Team Projects"),ne=t(" \u2014 View and access all Projects managed within a Team. Click a Project to enter the Product Details Page and access, monitor, edit or delete a Project."),ce=t("Team Billing"),ie=t(" \u2014 View and manage billing details such as credit card information, usage, subscriptions and receipts."),he="Overview",_e=!1,me={name:"overview",setup(le,{expose:i}){const n={title:"Overview",modularExtension:!1};return i({frontmatter:n}),(de,re)=>{const s=c("router-link"),l=c("docs-wrapper");return d(),r(l,{frontmatter:n},{default:o(()=>[e("div",u,[h,_,m,e("p",null,[p,g,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[f]),_:1}),b,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[y]),_:1}),v,a(s,{to:"/docs/cloud/glossary/#cloud-exclusives"},{default:o(()=>[T]),_:1}),w]),e("p",null,[j,a(s,{to:"/docs/cloud/glossary/#accounts"},{default:o(()=>[P]),_:1}),A,a(s,{to:"/docs/cloud/glossary/#teams"},{default:o(()=>[x]),_:1}),C,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[k]),_:1}),D]),e("p",null,[M,a(s,{to:"/docs/cloud/teams/#manage-billing"},{default:o(()=>[S]),_:1}),V]),O,e("p",null,[B,a(s,{to:"/docs/cloud/accounts/#create-account-and-login"},{default:o(()=>[E]),_:1}),H]),N,e("p",null,[G,a(s,{to:"/docs/cloud/glossary/#accounts"},{default:o(()=>[q]),_:1}),F,a(s,{to:"/docs/cloud/glossary/#teams"},{default:o(()=>[I]),_:1}),R,a(s,{to:"/docs/cloud/glossary/#projects"},{default:o(()=>[W]),_:1}),z]),J,K,L,Q,e("ul",null,[e("li",null,[a(s,{to:"/docs/cloud/teams"},{default:o(()=>[U]),_:1}),X]),e("li",null,[a(s,{to:"/docs/cloud/teams/#view-team-activity"},{default:o(()=>[Y]),_:1}),Z]),e("li",null,[a(s,{to:"/docs/cloud/teams/#update-team-settings"},{default:o(()=>[$]),_:1}),ee,a(s,{to:"/docs/cloud/teams/#destroy-a-team"},{default:o(()=>[te]),_:1}),oe])]),se,e("ul",null,[e("li",null,[a(s,{to:"/docs/cloud/projects"},{default:o(()=>[ae]),_:1}),ne]),e("li",null,[a(s,{to:"/docs/cloud/teams/#manage-billing"},{default:o(()=>[ce]),_:1}),ie])])])]),_:1})}}};export{me as default,_e as modularExtension,he as title};

package/dist/assets/permissions.de41ff3d.js

@@ -1,178 +0,0 @@
-import{a as i,o as c,b as p,w as n,g as s,e as t,B as a}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},u={class:"two-up"},d={class:"left"},_=a("Permissions are assigned to Roles, and control data access throughout the platform. "),j=a("Learn more about Permissions"),m=a("."),g=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-permission-object"},"The Permission Object ")]),s("li",null,[s("a",{href:"#list-permissions"},"List Permissions ")]),s("li",null,[s("a",{href:"#retrieve-a-permission"},"Retrieve a Permission ")]),s("li",null,[s("a",{href:"#create-a-permission-rule"},"Create a Permission Rule ")]),s("li",null,[s("a",{href:"#create-multiple-permission-rules"},"Create Multiple Permission Rules ")]),s("li",null,[s("a",{href:"#update-permissions"},"Update Permissions ")]),s("li",null,[s("a",{href:"#update-multiple-permissions"},"Update Multiple Permissions ")]),s("li",null,[s("a",{href:"#delete-permissions"},"Delete Permissions ")]),s("li",null,[s("a",{href:"#delete-multiple-permissions"},"Delete Multiple Permissions ")])])])])],-1),f=s("hr",null,null,-1),b=s("h2",{id:"the-permission-object",tabindex:"-1"},[a("The Permission Object "),s("a",{class:"header-anchor",href:"#the-permission-object"},"#")],-1),y={class:"two-up"},x={class:"left"},q={class:"definitions"},P=s("p",null,[s("code",null,"id"),a(),s("strong",null,"uuid"),s("br"),a(" Primary key of the permission rule.")],-1),v=s("code",null,"role",-1),w=a(),E=s("strong",null,"many-to-one",-1),R=s("br",null,null,-1),k=a(" Role this permission applies to. Many-to-one to "),T=a("roles"),S=a(". "),A=s("code",null,"null",-1),D=a(" is used for public permissions."),C=s("p",null,[s("code",null,"collection"),a(),s("strong",null,"string"),s("br"),a(" Collection this permission rule applies to.")],-1),L=s("p",null,[s("code",null,"action"),a(),s("strong",null,"string"),s("br"),a(" What CRUD operation this permission rule applies to. One of "),s("code",null,"create"),a(", "),s("code",null,"read"),a(", "),s("code",null,"update"),a(", "),s("code",null,"delete"),a(".")],-1),Q=s("code",null,"permissions",-1),I=a(),M=s("strong",null,"object",-1),O=s("br",null,null,-1),G=a(" What rules the item must pass before the role is allowed to alter it. Follows "),B=a("the Filter Rules spec"),U=a("."),H=s("code",null,"validation",-1),F=a(),W=s("strong",null,"object",-1),N=s("br",null,null,-1),V=a(" What rules the provided values must pass before the role is allowed to submit them for insertion/update. Follows "),z=a("the Filter Rules spec"),J=a("."),K=s("p",null,[s("code",null,"preset"),a(),s("strong",null,"object"),s("br"),a(" Additional default values for the role.")],-1),X=s("p",null,[s("code",null,"fields"),a(),s("strong",null,"array"),s("br"),a(" What fields the user is allowed to alter.")],-1),Y=s("div",{class:"right"},[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-number"},"34"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"action"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"create"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"permissions"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"validation"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-			`),s("span",{class:"hljs-attr"},'"_contains"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Directus"'),a(`
-		`),s("span",{class:"hljs-punctuation"},"}"),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"presets"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"published"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"translations"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])])],-1),Z=s("hr",null,null,-1),$=s("h2",{id:"list-permissions",tabindex:"-1"},[a("List Permissions "),s("a",{class:"header-anchor",href:"#list-permissions"},"#")],-1),ss=s("p",null,"List all permissions that exist in Directus.",-1),as={class:"two-up"},ns={class:"left"},es=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, permissions for a role other than the current user\u2019s role won\u2019t be returned.")],-1),ts=s("h3",{id:"query-parameters",tabindex:"-1"},[a("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),ls=a("Supports all "),is=a("global query parameters"),os=a("."),rs=s("h3",{id:"returns",tabindex:"-1"},[a("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),cs=a("An array of up to "),ps=a("limit"),hs=a(),us=s("a",{href:"#the-permission-object"},"permission objects",-1),ds=a(". If no items are available, data will be an empty array."),_s={class:"right"},js=s("h3",{id:"rest-api",tabindex:"-1"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),ms=s("pre",null,[s("code",null,`GET /permissions
-SEARCH /permissions
-`)],-1),gs=a("Learn more about SEARCH ->"),fs=s("h3",{id:"graphql",tabindex:"-1"},[a("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),bs=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),ys=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),a(` {
-	permissions: directus_permissions
-}
-`)])],-1),xs=s("h5",{id:"example",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(` {
-	permissions {
-		action
-		role
-		collection
-	}
-}
-`)])],-1),Ps=s("hr",null,null,-1),vs=s("h2",{id:"retrieve-a-permission",tabindex:"-1"},[a("Retrieve a Permission "),s("a",{class:"header-anchor",href:"#retrieve-a-permission"},"#")],-1),ws=s("p",null,"List an existing permission by primary key.",-1),Es={class:"two-up"},Rs={class:"left"},ks=s("h3",{id:"query-parameters-1",tabindex:"-1"},[a("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),Ts=a("Supports all "),Ss=a("global query parameters"),As=a("."),Ds=s("h3",{id:"returns-1",tabindex:"-1"},[a("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),Cs=s("p",null,[a("Returns the requested "),s("a",{href:"#the-permission-object"},"permission object"),a(".")],-1),Ls=s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /permissions/:id
-`)]),s("h5",{id:"example-1",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// GET /permissions/34"),a(`
-
-`),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"},'"id"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"34"),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"action"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"create"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"permissions"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"validation"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-			`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-				`),s("span",{class:"hljs-attr"},'"_contains"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Directus"'),a(`
-			`),s("span",{class:"hljs-punctuation"},"}"),a(`
-		`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"presets"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-			`),s("span",{class:"hljs-attr"},'"published"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),a(`
-		`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"translations"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])]),s("h3",{id:"graphql-1",tabindex:"-1"},[a("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"),a(` {
-	permissions_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),a(`!): directus_permissions
-}
-`)])]),s("h5",{id:"example-2",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(` {
-	permissions_by_id(id: `),s("span",{class:"hljs-number"},"34"),a(`) {
-		role
-		collection
-		action
-	}
-}
-`)])])],-1),Qs=s("hr",null,null,-1),Is=s("h2",{id:"create-a-permission-rule",tabindex:"-1"},[a("Create a Permission Rule "),s("a",{class:"header-anchor",href:"#create-a-permission-rule"},"#")],-1),Ms=s("p",null,"Create a new permission rule",-1),Os={class:"two-up"},Gs={class:"left"},Bs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[a("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Us=a("Supports all "),Hs=a("global query parameters"),Fs=a("."),Ws=s("h3",{id:"request-body",tabindex:"-1"},[a("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ns=s("p",null,[a("A partial "),s("a",{href:"#the-permission-object"},"permissions object"),a(". "),s("code",null,"action"),a(" and "),s("code",null,"collection"),a(" are required.")],-1),Vs=s("h3",{id:"returns-2",tabindex:"-1"},[a("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),zs=s("p",null,[a("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),a(" for the created permission.")],-1),Js=s("div",{class:"right"},[s("h3",{id:"rest-api-2",tabindex:"-1"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`POST /permissions
-`)]),s("h5",{id:"example-3",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Request"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"action"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"read"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])]),s("h3",{id:"graphql-2",tabindex:"-1"},[a("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"),a(` {
-	create_permissions_item(data: create_directus_permissions_input!): directus_permissions
-}
-`)])]),s("h5",{id:"example-4",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	create_permissions_item(
-		data: { collection: `),s("span",{class:"hljs-string"},'"pages"'),a(", action: "),s("span",{class:"hljs-string"},'"read"'),a(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),a(", fields: ["),s("span",{class:"hljs-string"},'"id"'),a(", "),s("span",{class:"hljs-string"},'"title"'),a(`] }
-	) {
-		id
-		collection
-		action
-	}
-}
-`)])])],-1),Ks=s("hr",null,null,-1),Xs=s("h2",{id:"create-multiple-permission-rules",tabindex:"-1"},[a("Create Multiple Permission Rules "),s("a",{class:"header-anchor",href:"#create-multiple-permission-rules"},"#")],-1),Ys=s("p",null,"Create multiple new permission rules",-1),Zs={class:"two-up"},$s={class:"left"},sa=s("h3",{id:"query-parameters-3",tabindex:"-1"},[a("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),aa=a("Supports all "),na=a("global query parameters"),ea=a("."),ta=s("h3",{id:"request-body-1",tabindex:"-1"},[a("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),la=s("p",null,[a("An array of partial "),s("a",{href:"#the-permission-object"},"permissions objects"),a(". "),s("code",null,"action"),a(" and "),s("code",null,"collection"),a(" are required.")],-1),ia=s("h3",{id:"returns-3",tabindex:"-1"},[a("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),oa=s("p",null,[a("Returns the "),s("a",{href:"#the-permission-object"},"permission objects"),a(" for the created permissions.")],-1),ra=s("div",{class:"right"},[s("h3",{id:"rest-api-3",tabindex:"-1"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`POST /permissions
-`)]),s("h5",{id:"example-5",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Request"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"["),a(`
-	`),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"action"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"read"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"action"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"create"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"role"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),a(`
-		`),s("span",{class:"hljs-attr"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"]"),a(`
-`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[a("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"),a(` {
-	create_permissions_items(data: [create_directus_permissions_input!]!): [directus_permissions]
-}
-`)])]),s("h5",{id:"example-6",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	create_permissions_items(
-		data: [
-			{ collection: `),s("span",{class:"hljs-string"},'"pages"'),a(", action: "),s("span",{class:"hljs-string"},'"read"'),a(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),a(", fields: ["),s("span",{class:"hljs-string"},'"id"'),a(", "),s("span",{class:"hljs-string"},'"title"'),a(`] }
-			{ collection: `),s("span",{class:"hljs-string"},'"pages"'),a(", action: "),s("span",{class:"hljs-string"},'"create"'),a(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),a(", fields: ["),s("span",{class:"hljs-string"},'"id"'),a(", "),s("span",{class:"hljs-string"},'"title"'),a(`] }
-		]
-	) {
-		id
-		collection
-		action
-	}
-}
-`)])])],-1),ca=s("hr",null,null,-1),pa=s("h2",{id:"update-permissions",tabindex:"-1"},[a("Update Permissions "),s("a",{class:"header-anchor",href:"#update-permissions"},"#")],-1),ha=s("p",null,"Update an existing permissions rule.",-1),ua={class:"two-up"},da={class:"left"},_a=s("h3",{id:"query-parameters-4",tabindex:"-1"},[a("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),ja=a("Supports all "),ma=a("global query parameters"),ga=a("."),fa=s("h3",{id:"request-body-2",tabindex:"-1"},[a("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),ba=s("p",null,[a("A partial "),s("a",{href:"#the-permission-object"},"permissions object"),a(".")],-1),ya=s("h3",{id:"returns-4",tabindex:"-1"},[a("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),xa=s("p",null,[a("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),a(" for the updated permission.")],-1),qa=s("div",{class:"right"},[s("h3",{id:"rest-api-4",tabindex:"-1"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`PATCH /permissions/:id
-`)]),s("h5",{id:"example-7",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /permissions/34"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"body"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])]),s("h3",{id:"graphql-4",tabindex:"-1"},[a("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"),a(` {
-	update_permissions_item(id:`),s("span",{class:"hljs-literal"}," ID"),a(`!, data: update_directus_permissions_input!): directus_permissions
-}
-`)])]),s("h5",{id:"example-8",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	update_permissions_item(id: `),s("span",{class:"hljs-number"},"34"),a(", data: { fields: ["),s("span",{class:"hljs-string"},'"id"'),a(", "),s("span",{class:"hljs-string"},'"title"'),a(", "),s("span",{class:"hljs-string"},'"body"'),a(`] }) {
-		id
-		action
-		collection
-	}
-}
-`)])])],-1),Pa=s("hr",null,null,-1),va=s("h2",{id:"update-multiple-permissions",tabindex:"-1"},[a("Update Multiple Permissions "),s("a",{class:"header-anchor",href:"#update-multiple-permissions"},"#")],-1),wa=s("p",null,"Update multiple existing permissions rules.",-1),Ea={class:"two-up"},Ra={class:"left"},ka=s("h3",{id:"query-parameters-5",tabindex:"-1"},[a("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),Ta=a("Supports all "),Sa=a("global query parameters"),Aa=a("."),Da=s("h3",{id:"request-body-3",tabindex:"-1"},[a("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Ca=s("h3",{id:"request-body-4",tabindex:"-1"},[a("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),La=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),a(),s("strong",null,"Required"),s("br"),a(" Array of primary keys of the permissions you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),a(),s("strong",null,"Required"),s("br"),a(" Any of "),s("a",{href:"#the-permission-object"},"the permission object"),a("\u2019s properties.")])],-1),Qa=s("h3",{id:"returns-5",tabindex:"-1"},[a("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Ia=s("p",null,[a("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),a(" for the updated permissions.")],-1),Ma=s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`PATCH /permissions
-`)]),s("h5",{id:"example-9",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /permissions"),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-number"},"34"),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-number"},"65"),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"},'"fields"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"body"'),s("span",{class:"hljs-punctuation"},"]"),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])]),s("h3",{id:"graphql-5",tabindex:"-1"},[a("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"),a(` {
-	update_permissions_items(id: `),s("span",{class:"hljs-literal"},"[ID"),a(`!]!, data: update_directus_permissions_input!): [directus_permissions]
-}
-`)])]),s("h5",{id:"example-10",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	update_permissions_items(ids: [`),s("span",{class:"hljs-number"},"34"),a(", "),s("span",{class:"hljs-number"},"64"),a("], data: { fields: ["),s("span",{class:"hljs-string"},'"id"'),a(", "),s("span",{class:"hljs-string"},'"title"'),a(", "),s("span",{class:"hljs-string"},'"body"'),a(`] }) {
-		id
-		action
-		collection
-	}
-}
-`)])])],-1),Oa=s("hr",null,null,-1),Ga=s("h2",{id:"delete-permissions",tabindex:"-1"},[a("Delete Permissions "),s("a",{class:"header-anchor",href:"#delete-permissions"},"#")],-1),Ba=s("p",null,"Delete an existing permissions rule",-1),Ua=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-6",tabindex:"-1"},[a("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"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`DELETE /permissions/:id
-`)]),s("h5",{id:"example-11",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",null,`DELETE /permissions/34
-`)]),s("h3",{id:"graphql-6",tabindex:"-1"},[a("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"),a(` {
-	delete_permissions_item(id:`),s("span",{class:"hljs-literal"}," ID"),a(`!): delete_one
-}
-`)])]),s("h5",{id:"example-12",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	delete_permissions_item(id: `),s("span",{class:"hljs-number"},"34"),a(`) {
-		id
-	}
-}
-`)])])])],-1),Ha=s("hr",null,null,-1),Fa=s("h2",{id:"delete-multiple-permissions",tabindex:"-1"},[a("Delete Multiple Permissions "),s("a",{class:"header-anchor",href:"#delete-multiple-permissions"},"#")],-1),Wa=s("p",null,"Delete multiple existing permissions rules",-1),Na=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5",tabindex:"-1"},[a("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of permission primary keys"),s("h3",{id:"returns-7",tabindex:"-1"},[a("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"},[a("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`DELETE /permissions
-`)]),s("h5",{id:"example-13",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /permissions"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-number"},"34"),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-number"},"64"),s("span",{class:"hljs-punctuation"},"]"),a(`
-`)])]),s("h3",{id:"graphql-7",tabindex:"-1"},[a("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"),a(` {
-	delete_permissions_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),a(`!]!): delete_many
-}
-`)])]),s("h5",{id:"example-14",tabindex:"-1"},[a("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
-	delete_permissions_items(ids: [`),s("span",{class:"hljs-number"},"34"),a(", "),s("span",{class:"hljs-number"},"64"),a(`]) {
-		ids
-	}
-}
-`)])])])],-1),Va=s("hr",null,null,-1),Ya="Permissions",Za=!1,$a="page-reference",sn={name:"permissions",setup(za,{expose:o}){const l={title:"Permissions",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:l}),(Ja,Ka)=>{const e=i("router-link"),r=i("docs-wrapper");return c(),p(r,{frontmatter:l},{default:n(()=>[s("div",h,[s("div",u,[s("div",d,[s("blockquote",null,[s("p",null,[_,t(e,{to:"/docs/getting-started/glossary/#permissions"},{default:n(()=>[j]),_:1}),m])])]),g]),f,b,s("div",y,[s("div",x,[s("div",q,[P,s("p",null,[v,w,E,R,k,t(e,{to:"/docs/reference/system/roles/"},{default:n(()=>[T]),_:1}),S,A,D]),C,L,s("p",null,[Q,I,M,O,G,t(e,{to:"/docs/reference/filter-rules"},{default:n(()=>[B]),_:1}),U]),s("p",null,[H,F,W,N,V,t(e,{to:"/docs/reference/filter-rules"},{default:n(()=>[z]),_:1}),J]),K,X])]),Y]),Z,$,ss,s("div",as,[s("div",ns,[es,ts,s("p",null,[ls,t(e,{to:"/docs/reference/query"},{default:n(()=>[is]),_:1}),os]),rs,s("p",null,[cs,t(e,{to:"/docs/reference/query/#limit"},{default:n(()=>[ps]),_:1}),hs,us,ds])]),s("div",_s,[js,ms,s("p",null,[t(e,{to:"/docs/reference/introduction/#search-http-method"},{default:n(()=>[gs]),_:1})]),fs,bs,ys,xs,qs])]),Ps,vs,ws,s("div",Es,[s("div",Rs,[ks,s("p",null,[Ts,t(e,{to:"/docs/reference/query"},{default:n(()=>[Ss]),_:1}),As]),Ds,Cs]),Ls]),Qs,Is,Ms,s("div",Os,[s("div",Gs,[Bs,s("p",null,[Us,t(e,{to:"/docs/reference/query"},{default:n(()=>[Hs]),_:1}),Fs]),Ws,Ns,Vs,zs]),Js]),Ks,Xs,Ys,s("div",Zs,[s("div",$s,[sa,s("p",null,[aa,t(e,{to:"/docs/reference/query"},{default:n(()=>[na]),_:1}),ea]),ta,la,ia,oa]),ra]),ca,pa,ha,s("div",ua,[s("div",da,[_a,s("p",null,[ja,t(e,{to:"/docs/reference/query"},{default:n(()=>[ma]),_:1}),ga]),fa,ba,ya,xa]),qa]),Pa,va,wa,s("div",Ea,[s("div",Ra,[ka,s("p",null,[Ta,t(e,{to:"/docs/reference/query"},{default:n(()=>[Sa]),_:1}),Aa]),Da,Ca,La,Qa,Ia]),Ma]),Oa,Ga,Ba,Ua,Ha,Fa,Wa,Na,Va])]),_:1})}}};export{sn as default,Za as modularExtension,$a as pageClass,Ya as title};