@directus/app 9.14.1 → 9.14.2

package/dist/assets/operations.9995851b.js

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

package/dist/assets/permissions.768d1878.js

@@ -1,178 +0,0 @@
-import{a as r,o as c,b as h,w as t,g as s,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=e("Permissions are assigned to Roles, and control data access throughout the platform. "),m=e("Learn more about Permissions"),g=e("."),f=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),j=s("hr",null,null,-1),b=s("h2",{id:"the-permission-object",tabindex:"-1"},[e("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"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the permission rule.")],-1),v=s("code",null,"role",-1),E=e(),R=s("strong",null,"many-to-one",-1),w=s("br",null,null,-1),T=e(" Role this permission applies to. Many-to-one to "),k=e("roles"),S=e(". "),A=s("code",null,"null",-1),D=e(" is used for public permissions."),C=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection this permission rule applies to.")],-1),L=s("p",null,[s("code",null,"action"),e(),s("strong",null,"string"),s("br"),e(" What CRUD operation this permission rule applies to. One of "),s("code",null,"create"),e(", "),s("code",null,"read"),e(", "),s("code",null,"update"),e(", "),s("code",null,"delete"),e(".")],-1),Q=s("code",null,"permissions",-1),I=e(),M=s("strong",null,"object",-1),O=s("br",null,null,-1),G=e(" What rules the item must pass before the role is allowed to alter it. Follows "),B=e("the Filter Rules spec"),U=e("."),H=s("code",null,"validation",-1),F=e(),W=s("strong",null,"object",-1),N=s("br",null,null,-1),V=e(" What rules the provided values must pass before the role is allowed to submit them for insertion/update. Follows "),z=e("the Filter Rules spec"),J=e("."),K=s("p",null,[s("code",null,"preset"),e(),s("strong",null,"object"),s("br"),e(" Additional default values for the role.")],-1),X=s("p",null,[s("code",null,"fields"),e(),s("strong",null,"array"),s("br"),e(" What fields the user is allowed to alter.")],-1),Y=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
-	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"34"),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"create"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"permissions"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"validation"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"title"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"_contains"'),e(": "),s("span",{class:"hljs-string"},'"Directus"'),e(`
-		}
-	},
-	`),s("span",{class:"hljs-attr"},'"presets"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"published"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`
-	},
-	`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"translations"'),e(`]
-}
-`)])])],-1),Z=s("hr",null,null,-1),$=s("h2",{id:"list-permissions",tabindex:"-1"},[e("List Permissions "),s("a",{class:"header-anchor",href:"#list-permissions"},"#")],-1),ss=s("p",null,"List all permissions that exist in Directus.",-1),es={class:"two-up"},ts={class:"left"},as=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),ns=s("h3",{id:"query-parameters",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),ls=e("Supports all "),rs=e("global query parameters"),is=e("."),os=s("h3",{id:"returns",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),cs=e("An array of up to "),hs=e("limit"),ds=e(),ps=s("a",{href:"#the-permission-object"},"permission objects",-1),us=e(". If no items are available, data will be an empty array."),_s={class:"right"},ms=s("h3",{id:"rest-api",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),gs=s("pre",null,[s("code",null,`GET /permissions
-SEARCH /permissions
-`)],-1),fs=e("Learn more about SEARCH ->"),js=s("h3",{id:"graphql",tabindex:"-1"},[e("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"),e(` {
-	permissions: directus_permissions
-}
-`)])],-1),xs=s("h5",{id:"example",tabindex:"-1"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	permissions {
-		action
-		role
-		collection
-	}
-}
-`)])],-1),Ps=s("hr",null,null,-1),vs=s("h2",{id:"retrieve-a-permission",tabindex:"-1"},[e("Retrieve a Permission "),s("a",{class:"header-anchor",href:"#retrieve-a-permission"},"#")],-1),Es=s("p",null,"List an existing permission by primary key.",-1),Rs={class:"two-up"},ws={class:"left"},Ts=s("h3",{id:"query-parameters-1",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")],-1),ks=e("Supports all "),Ss=e("global query parameters"),As=e("."),Ds=s("h3",{id:"returns-1",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")],-1),Cs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-permission-object"},"permission object"),e(".")],-1),Ls=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 /permissions/:id
-`)]),s("h5",{id:"example-1",tabindex:"-1"},[e("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"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"34"),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"create"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"permissions"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-		`),s("span",{class:"hljs-attr"},'"validation"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"title"'),e(`: {
-				`),s("span",{class:"hljs-attr"},'"_contains"'),e(": "),s("span",{class:"hljs-string"},'"Directus"'),e(`
-			}
-		},
-		`),s("span",{class:"hljs-attr"},'"presets"'),e(`: {
-			`),s("span",{class:"hljs-attr"},'"published"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`
-		},
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"translations"'),e(`]
-	}
-}
-`)])]),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(` {
-	permissions_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_permissions
-}
-`)])]),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(` {
-	permissions_by_id(id: `),s("span",{class:"hljs-number"},"34"),e(`) {
-		role
-		collection
-		action
-	}
-}
-`)])])],-1),Qs=s("hr",null,null,-1),Is=s("h2",{id:"create-a-permission-rule",tabindex:"-1"},[e("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"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Us=e("Supports all "),Hs=e("global query parameters"),Fs=e("."),Ws=s("h3",{id:"request-body",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ns=s("p",null,[e("A partial "),s("a",{href:"#the-permission-object"},"permissions object"),e(". "),s("code",null,"action"),e(" and "),s("code",null,"collection"),e(" are required.")],-1),Vs=s("h3",{id:"returns-2",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),zs=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),e(" for the created permission.")],-1),Js=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 /permissions
-`)]),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"},"// Request"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"read"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),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_permissions_item(data: create_directus_permissions_input!): directus_permissions
-}
-`)])]),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_permissions_item(
-		data: { collection: `),s("span",{class:"hljs-string"},'"pages"'),e(", action: "),s("span",{class:"hljs-string"},'"read"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`] }
-	) {
-		id
-		collection
-		action
-	}
-}
-`)])])],-1),Ks=s("hr",null,null,-1),Xs=s("h2",{id:"create-multiple-permission-rules",tabindex:"-1"},[e("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"},se=s("h3",{id:"query-parameters-3",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),ee=e("Supports all "),te=e("global query parameters"),ae=e("."),ne=s("h3",{id:"request-body-1",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")],-1),le=s("p",null,[e("An array of partial "),s("a",{href:"#the-permission-object"},"permissions objects"),e(". "),s("code",null,"action"),e(" and "),s("code",null,"collection"),e(" are required.")],-1),re=s("h3",{id:"returns-3",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),ie=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission objects"),e(" for the created permissions.")],-1),oe=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 /permissions
-`)]),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"},"// Request"),e(`
-
-[
-	{
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"read"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`]
-	},
-	{
-		`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"pages"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"action"'),e(": "),s("span",{class:"hljs-string"},'"create"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),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_permissions_items(data: [create_directus_permissions_input!]!): [directus_permissions]
-}
-`)])]),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_permissions_items(
-		data: [
-			{ collection: `),s("span",{class:"hljs-string"},'"pages"'),e(", action: "),s("span",{class:"hljs-string"},'"read"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`] }
-			{ collection: `),s("span",{class:"hljs-string"},'"pages"'),e(", action: "),s("span",{class:"hljs-string"},'"create"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(`] }
-		]
-	) {
-		id
-		collection
-		action
-	}
-}
-`)])])],-1),ce=s("hr",null,null,-1),he=s("h2",{id:"update-permissions",tabindex:"-1"},[e("Update Permissions "),s("a",{class:"header-anchor",href:"#update-permissions"},"#")],-1),de=s("p",null,"Update an existing permissions rule.",-1),pe={class:"two-up"},ue={class:"left"},_e=s("h3",{id:"query-parameters-4",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),me=e("Supports all "),ge=e("global query parameters"),fe=e("."),je=s("h3",{id:"request-body-2",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),be=s("p",null,[e("A partial "),s("a",{href:"#the-permission-object"},"permissions object"),e(".")],-1),ye=s("h3",{id:"returns-4",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),xe=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),e(" for the updated permission.")],-1),qe=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 /permissions/: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 /permissions/34"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),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_permissions_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_permissions_input!): directus_permissions
-}
-`)])]),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_permissions_item(id: `),s("span",{class:"hljs-number"},"34"),e(", data: { fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),e(`] }) {
-		id
-		action
-		collection
-	}
-}
-`)])])],-1),Pe=s("hr",null,null,-1),ve=s("h2",{id:"update-multiple-permissions",tabindex:"-1"},[e("Update Multiple Permissions "),s("a",{class:"header-anchor",href:"#update-multiple-permissions"},"#")],-1),Ee=s("p",null,"Update multiple existing permissions rules.",-1),Re={class:"two-up"},we={class:"left"},Te=s("h3",{id:"query-parameters-5",tabindex:"-1"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ke=e("Supports all "),Se=e("global query parameters"),Ae=e("."),De=s("h3",{id:"request-body-3",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Ce=s("h3",{id:"request-body-4",tabindex:"-1"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Le=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 permissions 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-permission-object"},"the permission object"),e("\u2019s properties.")])],-1),Qe=s("h3",{id:"returns-5",tabindex:"-1"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),Ie=s("p",null,[e("Returns the "),s("a",{href:"#the-permission-object"},"permission object"),e(" for the updated permissions.")],-1),Me=s("div",{class:"right"},[s("h3",{id:"rest-api-5",tabindex:"-1"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`PATCH /permissions
-`)]),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 /permissions"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"65"),e(`],
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"fields"'),e(": ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),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_permissions_items(id: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_permissions_input!): [directus_permissions]
-}
-`)])]),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_permissions_items(ids: [`),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"64"),e("], data: { fields: ["),s("span",{class:"hljs-string"},'"id"'),e(", "),s("span",{class:"hljs-string"},'"title"'),e(", "),s("span",{class:"hljs-string"},'"body"'),e(`] }) {
-		id
-		action
-		collection
-	}
-}
-`)])])],-1),Oe=s("hr",null,null,-1),Ge=s("h2",{id:"delete-permissions",tabindex:"-1"},[e("Delete Permissions "),s("a",{class:"header-anchor",href:"#delete-permissions"},"#")],-1),Be=s("p",null,"Delete an existing permissions rule",-1),Ue=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 /permissions/: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 /permissions/34
-`)]),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_permissions_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_permissions_item(id: `),s("span",{class:"hljs-number"},"34"),e(`) {
-		id
-	}
-}
-`)])])])],-1),He=s("hr",null,null,-1),Fe=s("h2",{id:"delete-multiple-permissions",tabindex:"-1"},[e("Delete Multiple Permissions "),s("a",{class:"header-anchor",href:"#delete-multiple-permissions"},"#")],-1),We=s("p",null,"Delete multiple existing permissions rules",-1),Ne=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,"An array of permission 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 /permissions
-`)]),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 /permissions"),e(`
-
-[`),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"64"),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_permissions_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_permissions_items(ids: [`),s("span",{class:"hljs-number"},"34"),e(", "),s("span",{class:"hljs-number"},"64"),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),Ve=s("hr",null,null,-1),Ye="Permissions",Ze=!1,$e="page-reference",st={name:"permissions",setup(ze,{expose:i}){const l={title:"Permissions",modularExtension:!1,pageClass:"page-reference"};return i({frontmatter:l}),(Je,Ke)=>{const a=r("router-link"),o=r("docs-wrapper");return c(),h(o,{frontmatter:l},{default:t(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,n(a,{to:"/docs/getting-started/glossary/#permissions"},{default:t(()=>[m]),_:1}),g])])]),f]),j,b,s("div",y,[s("div",x,[s("div",q,[P,s("p",null,[v,E,R,w,T,n(a,{to:"/docs/reference/system/roles/"},{default:t(()=>[k]),_:1}),S,A,D]),C,L,s("p",null,[Q,I,M,O,G,n(a,{to:"/docs/reference/filter-rules"},{default:t(()=>[B]),_:1}),U]),s("p",null,[H,F,W,N,V,n(a,{to:"/docs/reference/filter-rules"},{default:t(()=>[z]),_:1}),J]),K,X])]),Y]),Z,$,ss,s("div",es,[s("div",ts,[as,ns,s("p",null,[ls,n(a,{to:"/docs/reference/query"},{default:t(()=>[rs]),_:1}),is]),os,s("p",null,[cs,n(a,{to:"/docs/reference/query/#limit"},{default:t(()=>[hs]),_:1}),ds,ps,us])]),s("div",_s,[ms,gs,s("p",null,[n(a,{to:"/docs/reference/introduction/#search-http-method"},{default:t(()=>[fs]),_:1})]),js,bs,ys,xs,qs])]),Ps,vs,Es,s("div",Rs,[s("div",ws,[Ts,s("p",null,[ks,n(a,{to:"/docs/reference/query"},{default:t(()=>[Ss]),_:1}),As]),Ds,Cs]),Ls]),Qs,Is,Ms,s("div",Os,[s("div",Gs,[Bs,s("p",null,[Us,n(a,{to:"/docs/reference/query"},{default:t(()=>[Hs]),_:1}),Fs]),Ws,Ns,Vs,zs]),Js]),Ks,Xs,Ys,s("div",Zs,[s("div",$s,[se,s("p",null,[ee,n(a,{to:"/docs/reference/query"},{default:t(()=>[te]),_:1}),ae]),ne,le,re,ie]),oe]),ce,he,de,s("div",pe,[s("div",ue,[_e,s("p",null,[me,n(a,{to:"/docs/reference/query"},{default:t(()=>[ge]),_:1}),fe]),je,be,ye,xe]),qe]),Pe,ve,Ee,s("div",Re,[s("div",we,[Te,s("p",null,[ke,n(a,{to:"/docs/reference/query"},{default:t(()=>[Se]),_:1}),Ae]),De,Ce,Le,Qe,Ie]),Me]),Oe,Ge,Be,Ue,He,Fe,We,Ne,Ve])]),_:1})}}};export{st as default,Ze as modularExtension,$e as pageClass,Ye as title};