> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Form Requirement POST https://companies/%7Bcompany_id%7D/config/forms/requirements Content-Type: multipart/form-data Reference: https://docs.itspropel.com/propel-biz/03-company/03-company-config/form-requirements/create-form-requirement ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /companies/%7Bcompany_id%7D/config/forms/requirements: post: operationId: create-form-requirement summary: Create Form Requirement tags: - >- subpackage_03Company.subpackage_03Company/03CompanyConfig.subpackage_03Company/03CompanyConfig/formRequirements parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/03 Company_03 Company > Config_Form Requirements_Create Form Requirement_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: gate: type: string description: >- Required: lifecycle gate to block - must be registered for this parent_record_type - e.g. work_order.arrived | work_order.completed | work_order_assignment.accepted is_blocking: type: string description: >- Optional: bool true|false|1|0 - whether an unsatisfied requirement blocks the transition - default: true (false = advisory) trigger_mode: type: string description: >- Required: auto | manual - auto = AutoCreateFormSubmissionsListener materializes a draft submission on the trigger event; manual = staff create the submission from the UI form_template_id: type: string description: >- Required: UUID of the FormTemplate required at this gate - converted to int id by ConvertUuidToId middleware - template must be published parent_record_type: type: string description: >- Required: morph alias of the gated record - must be registered in FormGateRegistry by the consuming module - e.g. work_order | work_order_assignment conditions[0][condition]: type: string description: >- Optional: narrowing condition string from the Conditions Catalog - e.g. work_order.tag | work_order.customer_type | work_order.service | work_order.specific_record - empty = no narrowing (rule applies to every record of parent_record_type) conditions[0][operand_ref]: type: string description: >- Required IF condition kind is ENTITY/TAG/SELF: UUID of the referenced entity - resolved to int id server-side, tenant-scoped conditions[0][operand_value]: type: string description: >- Required IF condition kind is VALUE: scalar to match (e.g. "commercial" for work_order.customer_type) - leave empty for ENTITY/TAG/SELF kinds conditions[0][operand_ref_type]: type: string description: >- Required IF condition kind is ENTITY/TAG/SELF: morph alias of the referenced entity (e.g. tag_type | service | work_order). For SELF must equal parent_record_type required: - gate - is_blocking - trigger_mode - form_template_id - parent_record_type - conditions[0][condition] - conditions[0][operand_ref] - conditions[0][operand_value] - conditions[0][operand_ref_type] servers: - url: https:/ components: schemas: 03 Company_03 Company > Config_Form Requirements_Create Form Requirement_Response_200: type: object properties: {} description: Empty response body title: >- 03 Company_03 Company > Config_Form Requirements_Create Form Requirement_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/companies/%7Bcompany_id%7D/config/forms/requirements" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"gate\"\r\n\r\nwork_order.arrived\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_blocking\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_mode\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_template_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][condition]\"\r\n\r\nwork_order.customer_type\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_value]\"\r\n\r\ncommercial\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref_type]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/companies/%7Bcompany_id%7D/config/forms/requirements'; const form = new FormData(); form.append('gate', 'work_order.arrived'); form.append('is_blocking', 'true'); form.append('trigger_mode', 'auto'); form.append('form_template_id', '3fa85f64-5717-4562-b3fc-2c963f66afa6'); form.append('parent_record_type', 'work_order'); form.append('conditions[0][condition]', 'work_order.customer_type'); form.append('conditions[0][operand_ref]', ''); form.append('conditions[0][operand_value]', 'commercial'); form.append('conditions[0][operand_ref_type]', ''); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/companies/%7Bcompany_id%7D/config/forms/requirements" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"gate\"\r\n\r\nwork_order.arrived\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_blocking\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_mode\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_template_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][condition]\"\r\n\r\nwork_order.customer_type\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_value]\"\r\n\r\ncommercial\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref_type]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/companies/%7Bcompany_id%7D/config/forms/requirements") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"gate\"\r\n\r\nwork_order.arrived\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_blocking\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_mode\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_template_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][condition]\"\r\n\r\nwork_order.customer_type\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_value]\"\r\n\r\ncommercial\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref_type]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/companies/%7Bcompany_id%7D/config/forms/requirements") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"gate\"\r\n\r\nwork_order.arrived\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_blocking\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_mode\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_template_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][condition]\"\r\n\r\nwork_order.customer_type\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_value]\"\r\n\r\ncommercial\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref_type]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/companies/%7Bcompany_id%7D/config/forms/requirements', [ 'multipart' => [ [ 'name' => 'gate', 'contents' => 'work_order.arrived' ], [ 'name' => 'is_blocking', 'contents' => 'true' ], [ 'name' => 'trigger_mode', 'contents' => 'auto' ], [ 'name' => 'form_template_id', 'contents' => '3fa85f64-5717-4562-b3fc-2c963f66afa6' ], [ 'name' => 'parent_record_type', 'contents' => 'work_order' ], [ 'name' => 'conditions[0][condition]', 'contents' => 'work_order.customer_type' ], [ 'name' => 'conditions[0][operand_value]', 'contents' => 'commercial' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/companies/%7Bcompany_id%7D/config/forms/requirements"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"gate\"\r\n\r\nwork_order.arrived\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_blocking\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"trigger_mode\"\r\n\r\nauto\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_template_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_record_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][condition]\"\r\n\r\nwork_order.customer_type\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref]\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_value]\"\r\n\r\ncommercial\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conditions[0][operand_ref_type]\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "gate", "value": "work_order.arrived" ], [ "name": "is_blocking", "value": "true" ], [ "name": "trigger_mode", "value": "auto" ], [ "name": "form_template_id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], [ "name": "parent_record_type", "value": "work_order" ], [ "name": "conditions[0][condition]", "value": "work_order.customer_type" ], [ "name": "conditions[0][operand_ref]", "value": "" ], [ "name": "conditions[0][operand_value]", "value": "commercial" ], [ "name": "conditions[0][operand_ref_type]", "value": "" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/companies/%7Bcompany_id%7D/config/forms/requirements")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```