1"use strict";(self.webpackChunkdocs_formkiq_com=self.webpackChunkdocs_formkiq_com||[]).push([[922],{42396:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>q,contentTitle:()=>b,default:()=>M,frontMatter:()=>v,metadata:()=>i,toc:()=>k});const i=JSON.parse('{"id":"api-reference/add-rule","title":"Add New Rule","description":"Creates a new rule; available as an Add-On Module","source":"@site/docs/api-reference/add-rule.api.mdx","sourceDirName":"api-reference","slug":"/api-reference/add-rule","permalink":"/docs/api-reference/add-rule","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"add-rule","title":"Add New Rule","description":"Creates a new rule; available as an Add-On Module","sidebar_label":"Add New Rule","hide_title":true,"hide_table_of_contents":true,"api":"eJztGV1v27b2rxBMgSYXku1kuw9Xe5nqupjXJvFit9ngBgEtHdtsKFIlqTiuof9+cUjJkmOnTYvd+7S8RCF5vr9PNlTloJnlSg5TGtE4Ta8KATSgKZhE8xxvaET7GpgFQxiRsCK6EPALYfeMCzYTQJghTJI4TcNLSc5V6jFYtjA0mlJEaMAaehPQnGmWgQWNNxsqWQY0ooZbGKY0oBxpfS5Ar/c4GHMLZJiCtHzOQdOAavhccA0pjeZMGAioSZaQMRptqF3nDq/VXC5oWQZbUtoz01DLmV3uEatYfoqe1cVXyd34x2DsK5Wu8cVj2ERJC9LiFctzwRNngu4ng+Q3LdQN4JQmzAAqsSKnZp8gsTSguUYjWg7GQaD2G6aeeJVrrjS369ZLWWQzJ+i+Lsj2efno+rHwB6HbR2VAV0rfzYVaocd9C/66ekusIsYybYmSJGM2WXK5IGpOEiVTjo8NojaW2cJ8G+3YvUN4uwRSmZsGFGSRoarj/mT4YUADOryoPlHv3KJqa+/wOJBqi4dvKj4rjG29YlqzfWd/x41F5tCWbQkDyi1kz6DCrNV8Vlh4poW2NMgWkhynkGtImIU0IIUB0tfcguZKnrQ0NRn8OaEB7V9eTAYXk9vJXyNU26v4qn/5Gr/eDAfvXtOAxpPJ1fDV+8meJvs16XjLM6q0pvXjAvxPmNzqAJncknoL62fy2aj3DtbkWEmxJnWMk7nSZMsCSRp1lwGdcxDphUtizyLk3hPMeoeoOIEfUbhnovh+f/FQZdAUkr/FYoM/KnvFw4vxk9a43NIsyyeenGO8lU9e7wDW1e/A2ZXP54ipxOxuciWNj7Wz3in+2hXxrHdK+leDeDJAv1oCS13N29A4ScCYsK+k1UqEsRBqFV5qvuCPMv9eDTsMeg52qVLzQ7C/NWw9DVt+R7X6dmV6Ts537tEqvQfN4Q1Q2ePnXm/fBD/3euTyLf3b2AetlTbPzt3V82en7Lvn5JABIiWYbsrAM/RcmHMwhi12ffsDEzx1ynBvdsPk0aXZUTmWWkgK30FMNzTOeVzYpdL8S5UDpjfYBj2ELGNflAxZzhfMwoqtQy4tLJpUUWiOv97IKBoXM6dWGb3YxNfjKBoxbV2YllGDoL68goW7ESybpSzCRq571jv9d9j7KfzptDsvZOKqZvfF5rVKigykNXHOq0g2sZZll8t75d3BFfKduE5hzgrh3Ma3FX2Vgg9t2jwdtTraDc1cNHbqy44P/M7Xo4++7HsPDSfrHII/wzj7Er5mFoIdneJFzsO3sA4ewrnS2R3/HKYgYOGuQ6vuQL6kwXcxsU0f9OW/vhe2zloO1PlEzoyxS62KxfIVLNk9R/+k178NLm4vLm8ng/PRu3gyGGNGtDb3tGlER5djLM91WK3Mba7VA4ZWztZCsfSN0hmzH0Ab79KnnZ4LgAcL0vi+a1pF0DddrlXo/nG9f1zvh1wPU1tWo8iVcdkcB8mIdqsJ03Q321mz9IcUk6a+r4ffQgsaOW6ibleohImlx/SonuANSeEehMrRk4hHQpGJOgmPsYZ539lPxRuKExRels3wyAq7PKOHMzSr4MFVF+4qsV2PVaEThH1RDbdbC+2QC+inle0rOeeLosnyrEg5SASftgPuxaavFpJb9d6AHikl+oKDtKUTjhtTeBYaAFSXibrdxIOFPM07u0HZ8fKwlekkKuvuUSh9CfRq+LSqmkNsBq6amX3wwLLcz9H1PN1MzL3HJtoW3vZk25zWQ2kzVe4OjH4knO5MbfXI0pqD6qPdqaMh05oQmsMq1zUHrTYdm+zyxonP5Vy5TqIq/uj1b/kfJB4Nye/Xk6qJYolLSdUqpXpDg5Yno2mq/IDax4Y+YxxvTZHnSttf27clup9QC+WTcRtJqhLTab11B12BSyjbveUZW4CpKTkUndyJN2PJ3UKrQqZ9JVwKOHrjflBxwk7gwbbEe4e0y4AKngC2No1wcc6SJZCzTm9PvtVq1WHuuqP0olvBmu67YX9wMR6EZ51eZ2kzsbcraWs1InVhIOdMsgW4z5FgFoVyei8MrjguMbqOf7+enBD8wlD0VeOj/Cj/UgVJmCRzLlOiCksypYGwGX7WxJgl0wOmuTmuMk/r7KSDSI+OyBBzbVokNZ0aF/eLvtEwnHNtLDnGDBAKMOYkIDNmrYAQLQQpSWvxska8eDTskMkSSNu9cq3ueYq7RSHcNgYPQaa54tIa3PvMCi5SslaFJiPQc0jsV5XXaXOMyFbMOBxud2RVjt359DIHiZcmh4TPK516pdRGVjlIlnODZj4JiFGEW1QBMLNGvnAnUjOMaMicCyArbpeEyTVpzRrELpklVQgYB3SQvmMdbxxOZ3oybj8gIak51GzVWXC7LGaFAV3NOC5UKotuwyNRGroZMxa0D6NKsPp3+GllO2uWiR3qw/j8/0Gbs2xL++hoz8drO6r5HDRqTgPgBiNzyzu28zr6KAkJWxHj/46vxyhM9cdo6MangN63Svrpf3xDiaU8Y7KdB9KUXMCKHNqKb5rJ8scW5L4GWXiw3Vww7nZKLtdsqm5iWu+rsXeI2rtr31DcBNT1DNGUbjYzZuC9FmWJx36JjkUl5QZ5aNbkT8qwv2I/yKFvs7c7+7rCuJJ9zzRHat9J+fiqWk6dkIOr94N81D2bXLe5qPlrlFXelPUGpjUmtPveFvzeggD/d+AhsBHN7VffttvCqrOcVf8ByHwHr9kKrcdWnleVb7sAd7ahgslFgYN6RD1OLM/o5+0NQt28VR84bJflfwEn6vfs","sidebar_class_name":"post api-method","info_path":"docs/api-reference/formkiq-api-jwt","custom_edit_url":null},"sidebar":"openApiSidebar","previous":{"title":"Get Rules","permalink":"/docs/api-reference/get-rules"},"next":{"title":"Get Rule","permalink":"/docs/api-reference/get-rule"}}');var r=a(74848),l=a(28453),n=a(91366),t=a.n(n),d=(a(6050),a(57742)),c=a.n(d),o=(a(67792),a(27362)),m=a.n(o),p=a(36683),h=a.n(p),u=a(81124),j=a.n(u),x=a(60674),f=a.n(x),g=a(12601),N=a(51107),y=(a(77675),a(19365));const v={id:"add-rule",title:"Add New Rule",description:"Creates a new rule; available as an Add-On Module",sidebar_label:"Add New Rule",hide_title:!0,hide_table_of_contents:!0,api:"eJztGV1v27b2rxBMgSYXku1kuw9Xe5nqupjXJvFit9ngBgEtHdtsKFIlqTiuof9+cUjJkmOnTYvd+7S8RCF5vr9PNlTloJnlSg5TGtE4Ta8KATSgKZhE8xxvaET7GpgFQxiRsCK6EPALYfeMCzYTQJghTJI4TcNLSc5V6jFYtjA0mlJEaMAaehPQnGmWgQWNNxsqWQY0ooZbGKY0oBxpfS5Ar/c4GHMLZJiCtHzOQdOAavhccA0pjeZMGAioSZaQMRptqF3nDq/VXC5oWQZbUtoz01DLmV3uEatYfoqe1cVXyd34x2DsK5Wu8cVj2ERJC9LiFctzwRNngu4ng+Q3LdQN4JQmzAAqsSKnZp8gsTSguUYjWg7GQaD2G6aeeJVrrjS369ZLWWQzJ+i+Lsj2efno+rHwB6HbR2VAV0rfzYVaocd9C/66ekusIsYybYmSJGM2WXK5IGpOEiVTjo8NojaW2cJ8G+3YvUN4uwRSmZsGFGSRoarj/mT4YUADOryoPlHv3KJqa+/wOJBqi4dvKj4rjG29YlqzfWd/x41F5tCWbQkDyi1kz6DCrNV8Vlh4poW2NMgWkhynkGtImIU0IIUB0tfcguZKnrQ0NRn8OaEB7V9eTAYXk9vJXyNU26v4qn/5Gr/eDAfvXtOAxpPJ1fDV+8meJvs16XjLM6q0pvXjAvxPmNzqAJncknoL62fy2aj3DtbkWEmxJnWMk7nSZMsCSRp1lwGdcxDphUtizyLk3hPMeoeoOIEfUbhnovh+f/FQZdAUkr/FYoM/KnvFw4vxk9a43NIsyyeenGO8lU9e7wDW1e/A2ZXP54ipxOxuciWNj7Wz3in+2hXxrHdK+leDeDJAv1oCS13N29A4ScCYsK+k1UqEsRBqFV5qvuCPMv9eDTsMeg52qVLzQ7C/NWw9DVt+R7X6dmV6Ts537tEqvQfN4Q1Q2ePnXm/fBD/3euTyLf3b2AetlTbPzt3V82en7Lvn5JABIiWYbsrAM/RcmHMwhi12ffsDEzx1ynBvdsPk0aXZUTmWWkgK30FMNzTOeVzYpdL8S5UDpjfYBj2ELGNflAxZzhfMwoqtQy4tLJpUUWiOv97IKBoXM6dWGb3YxNfjKBoxbV2YllGDoL68goW7ESybpSzCRq571jv9d9j7KfzptDsvZOKqZvfF5rVKigykNXHOq0g2sZZll8t75d3BFfKduE5hzgrh3Ma3FX2Vgg9t2jwdtTraDc1cNHbqy44P/M7Xo4++7HsPDSfrHII
1/wzj7Er5mFoIdneJFzsO3sA4ewrnS2R3/HKYgYOGuQ6vuQL6kwXcxsU0f9OW/vhe2zloO1PlEzoyxS62KxfIVLNk9R/+k178NLm4vLm8ng/PRu3gyGGNGtDb3tGlER5djLM91WK3Mba7VA4ZWztZCsfSN0hmzH0Ab79KnnZ4LgAcL0vi+a1pF0DddrlXo/nG9f1zvh1wPU1tWo8iVcdkcB8mIdqsJ03Q321mz9IcUk6a+r4ffQgsaOW6ibleohImlx/SonuANSeEehMrRk4hHQpGJOgmPsYZ539lPxRuKExRels3wyAq7PKOHMzSr4MFVF+4qsV2PVaEThH1RDbdbC+2QC+inle0rOeeLosnyrEg5SASftgPuxaavFpJb9d6AHikl+oKDtKUTjhtTeBYaAFSXibrdxIOFPM07u0HZ8fKwlekkKuvuUSh9CfRq+LSqmkNsBq6amX3wwLLcz9H1PN1MzL3HJtoW3vZk25zWQ2kzVe4OjH4knO5MbfXI0pqD6qPdqaMh05oQmsMq1zUHrTYdm+zyxonP5Vy5TqIq/uj1b/kfJB4Nye/Xk6qJYolLSdUqpXpDg5Yno2mq/IDax4Y+YxxvTZHnSttf27clup9QC+WTcRtJqhLTab11B12BSyjbveUZW4CpKTkUndyJN2PJ3UKrQqZ9JVwKOHrjflBxwk7gwbbEe4e0y4AKngC2No1wcc6SJZCzTm9PvtVq1WHuuqP0olvBmu67YX9wMR6EZ51eZ2kzsbcraWs1InVhIOdMsgW4z5FgFoVyei8MrjguMbqOf7+enBD8wlD0VeOj/Cj/UgVJmCRzLlOiCksypYGwGX7WxJgl0wOmuTmuMk/r7KSDSI+OyBBzbVokNZ0aF/eLvtEwnHNtLDnGDBAKMOYkIDNmrYAQLQQpSWvxska8eDTskMkSSNu9cq3ueYq7RSHcNgYPQaa54tIa3PvMCi5SslaFJiPQc0jsV5XXaXOMyFbMOBxud2RVjt359DIHiZcmh4TPK516pdRGVjlIlnODZj4JiFGEW1QBMLNGvnAnUjOMaMicCyArbpeEyTVpzRrELpklVQgYB3SQvmMdbxxOZ3oybj8gIak51GzVWXC7LGaFAV3NOC5UKotuwyNRGroZMxa0D6NKsPp3+GllO2uWiR3qw/j8/0Gbs2xL++hoz8drO6r5HDRqTgPgBiNzyzu28zr6KAkJWxHj/46vxyhM9cdo6MangN63Svrpf3xDiaU8Y7KdB9KUXMCKHNqKb5rJ8scW5L4GWXiw3Vww7nZKLtdsqm5iWu+rsXeI2rtr31DcBNT1DNGUbjYzZuC9FmWJx36JjkUl5QZ5aNbkT8qwv2I/yKFvs7c7+7rCuJJ9zzRHat9J+fiqWk6dkIOr94N81D2bXLe5qPlrlFXelPUGpjUmtPveFvzeggD/d+AhsBHN7VffttvCqrOcVf8ByHwHr9kKrcdWnleVb7sAd7ahgslFgYN6RD1OLM/o5+0NQt28VR84bJflfwEn6vfs",sidebar_class_name:"post api-method",info_path:"docs/api-reference/formkiq-api-jwt",custom_edit_url:null},b=void 0,q={},k=[];function A(e){const s={p:"p",...(0,l.R)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(N.default,{as:"h1",className:"openapi__heading",children:"Add New Rule"}),"\n",(0,r.jsx)(c(),{method:"post",path:"/rulesets/{rulesetId}/rules",context:"endpoint"}),"\n",(0,r.jsx)(s.p,{children:"Creates a new rule; available as an Add-On Module"}),"\n",(0,r.jsx)(N.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,r.jsx)(s.p,{children:"Path Parameters"})})}),(0,r.jsx)("div",{children:(0,r.jsx)("ul",{children:(0,r.jsx)(h(),{className:"paramsItem",param:{name:"rulesetId",in:"path",description:"Ruleset Identifier",required:!0,schema:{type:"string"},enumDescriptions:[]}})})})]}),"\n",(0,r.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,r.jsx)(s.p,{children:"Query Parameters"})})}),(0,r.jsx)("div",{children:(0,r.jsx)("ul",{children:(0,r.jsx)(h(),{className:"paramsItem",param:{name:"siteId",in:"query",description:"Site Identifier",required:!1,schema:{type:"string"},enumDescriptions:[]}})})})]}),"\n",(0,r.jsx)(m(),{className:"openapi-tabs__mime",children:(0,r.jsx)(y.default,{label:"application/json",value:"application/json-schema",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,r.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,r.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,r.jsx)(s.p,{children:"Body"})}),(0,r.jsx)("strong",{className:"openapi-schema__required",children:(0,r.jsx)(s.p,{children:"required"})})]}),(0,r.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,r.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,r.jsx)(f(),{collapsible:!0,className:"schemaItem",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsxs)("span",{className:"openapi-schema__container",children:[(0,r.jsx)("strong",{className:"openapi-schema__property",children:(0,r.jsx)(s.p,{children:"rule"})}),(0,r.jsx)("span",{className:"openapi-schema__name",children:(0,r.jsx)(s.p,{children:"object"})})]})}),(0,r.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,r.jsx)(f(),{collapsible:!1,name:"priority",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"Rule priority"}}),(0,r.jsx)(f(),{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Rule description"}}),(0,r.jsx)(f(),{collapsible:!1,name:"workflowId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Workflow to start on matching of conditions"}}),(0,r.jsx)(f(),{collapsible:!1,name:"status",required:!1,schemaName:"RulesetStatus (string)",qualifierMessage:"**Possible values:** [`ACTIVE`, `INACTIVE`]",schema:{type:"string",description:"Status of the Ruleset",enum:["ACTIVE","INACTIVE"],title:"RulesetStatus"}}),(0,r.jsx)(f(),{collapsible:!0,className:"schemaItem",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsxs)("span",{className:"openapi-schema__container",children:[(0,r.jsx)("strong",{className:"openapi-schema__property",children:(0,r.jsx)(s.p,{children:"conditions"})}),(0,r.jsx)("span",{className:"openapi-schema__name",children:(0,r.jsx)(s.p,{children:"object"})})]})}),(0,r.jsx)("div",{style:{marginLeft:"1rem"},children:(0,r.jsx)(f(),{collapsible:!0,className:"schemaItem",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsxs)("span",{className:"openapi-schema__container",children:[(0,r.jsx)("strong",{className:"openapi-schema__property",children:(0,r.jsx)(s.p,{children:"must"})}),(0,r.jsx)("span",{className:"openapi-schema__name",children:(0,r.jsx)(s.p,{children:"object[]"})})]})}),(0,r.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,r.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,r.jsx)(s.p,{children:"List of rule conditions"})}),(0,r.jsx)("li",{children:(0,r.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,r.jsx)(s.p,{children:"Array ["})})}),(0,r.jsx)(f(),{collapsible:!1,name:"attribute",required:!1,schemaName:"RuleConditionAttribute (string)",qualifierMessage:"**Possible values:** [`TEXT`, `CONTENT_TYPE`, `BARCODE`, `FIELD`, `ATTRIBUTE`]",schema:{type:"string",description:"Rule condition attribute (deprecated, use Criterion)",enum:["TEXT","CONTENT_TYPE","BARCODE","FIELD","ATTRIBUTE"],title:"RuleConditionAttribute"}}),(0,r.jsx)(f(),{collapsible:!1,name:"criterion",required:!1,schemaName:"RuleConditionCriterion (string)",qualifierMessage:"**Possible values:** [`TEXT`, `CONTENT_TYPE`, `BARCODE`, `FIELD`, `ATTRIBUTE`]",schema:{type:"string",description:"Rule condition attribute",enum:["TEXT","CONTENT_TYPE","BARCODE","FIELD","ATTRIBUTE"],title:"RuleConditionCriterion"}}),(0,r.jsx)(f(),{collapsible:!1,name:"attributeKey",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Rule attribute key (only required for ATTRIBUTE criterion)"}}),(0,r.jsx)(f(),{collapsible:!1,name:"fieldName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Rule field name (only required for FIELD criterion)"}}),(0,r.jsx)(f(),{collapsible:!1,name:"value",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Rule condition value"}}),(0,r.jsx)(f(),{collapsible:!1,name:"operation",required:!1,schemaName:"RuleConditionOperation (string)",qualifierMessage:"**Possible values:** [`EQ`, `CONTAINS`]",schema:{type:"string",description:"Rule condition attribute",enum:["EQ","CONTAINS"],title:"RuleConditionOperation"}}),(0,r.jsx)("li",{children:(0,r.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,r.jsx)(s.p,{children:"]"})})})]})]})})})]})})]})]})})})]})})}),"\n",(0,r.jsx)("div",{children:(0,r.jsx)("div",{children:(0,r.jsxs)(t(),{label:void 0,id:void 0,children:[(0,r.jsxs)(y.default,{label:"201",value:"201",children:[(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"201 CREATED"})}),(0,r.jsxs)(a,{style:{textAlign:"left",marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!0,open:!1,children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsx)("strong",{children:(0,r.jsx)(s.p,{children:"Response Headers"})})}),(0,r.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,r.jsxs)("li",{className:"schemaItem",children:[(0,r.jsxs)("summary",{style:{},children:[(0,r.jsx)("strong",{children:(0,r.jsx)(s.p,{children:"Access-Control-Allow-Origin"})}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:(0,r.jsx)(s.p,{children:"string"})})]}),(0,r.jsx)("div",{})]}),(0,r.jsxs)("li",{className:"schemaItem",children:[(0,r.jsxs)("summary",{style:{},children:[(0,r.jsx)("strong",{children:(0,r.jsx)(s.p,{children:"Access-Control-Allow-Methods"})}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:(0,r.jsx)(s.p,{children:"string"})})]}),(0,r.jsx)("div",{})]}),(0,r.jsxs)("li",{className:"schemaItem",children:[(0,r.jsxs)("summary",{style:{},children:[(0,r.jsx)("strong",{children:(0,r.jsx)(s.p,{children:"Access-Control-Allow-Headers"})}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:(0,r.jsx)(s.p,{children:"string"})})]}),(0,r.jsx)("div",{})]})]})]}),(0,r.jsx)("div",{children:(0,r.jsx)(m(),{className:"openapi-tabs__mime",schemaType:"response",children:(0,r.jsx)(y.default,{label:"application/json",value:"application/json",children:(0,r.jsxs)(g.default,{className:"openapi-tabs__schema",children:[(0,r.jsx)(y.default,{label:"Schema",value:"Schema",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,r.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,r.jsx)("strong",{children:(0,r.jsx)(s.p,{children:"Schema"})})}),(0,r.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,r.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,r.jsx)(f(),{collapsible:!1,name:"ruleId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Rule Identifier"}})})]})}),(0,r.jsx)(y.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,r.jsx)(j(),{responseEx
1ample:'{\n "ruleId": "string"\n}',language:"json"})})]})})})})]}),(0,r.jsxs)(y.default,{label:"400",value:"400",children:[(0,r.jsx)("div",{children:(0,r.jsx)(s.p,{children:"400 OK"})}),(0,r.jsx)("div",{children:(0,r.jsx)(m(),{className:"openapi-tabs__mime",schemaType:"response",children:(0,r.jsx)(y.default,{label:"application/json",value:"application/json",children:(0,r.jsxs)(g.default,{className:"openapi-tabs__schema",children:[(0,r.jsx)(y.default,{label:"Schema",value:"Schema",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,r.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,r.jsx)("strong",{children:(0,r.jsx)(s.p,{children:"Schema"})})}),(0,r.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,r.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,r.jsx)(f(),{collapsible:!0,className:"schemaItem",children:(0,r.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,r.jsx)("summary",{style:{},children:(0,r.jsxs)("span",{className:"openapi-schema__container",children:[(0,r.jsx)("strong",{className:"openapi-schema__property",children:(0,r.jsx)(s.p,{children:"errors"})}),(0,r.jsx)("span",{className:"openapi-schema__name",children:(0,r.jsx)(s.p,{children:"object[]"})})]})}),(0,r.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,r.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,r.jsx)(s.p,{children:"List of errors"})}),(0,r.jsx)("li",{children:(0,r.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,r.jsx)(s.p,{children:"Array ["})})}),(0,r.jsx)(f(),{collapsible:!1,name:"key",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Error Key"}}),(0,r.jsx)(f(),{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Error Message"}}),(0,r.jsx)("li",{children:(0,r.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,r.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,r.jsx)(y.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,r.jsx)(j(),{responseExample:'{\n "errors": [\n {\n "key": "string",\n "error": "string"\n }\n ]\n}',language:"json"})})]})})})})]})]})})})]})}function M(e={}){const{wrapper:s}={...(0,l.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(A,{...e})}):A(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.