--- title: "Formigros QUAL" url: "https://developer-qual.migros.ch/apis/formigros-qual-0/versions/5cf4bb7f-1e47-4efc-a301-5c2ff79fea16" --- # Formigros QUAL OpenAPI specification document. ```json {"externalDocs":{"description":"Details, examples and more information can be found here.","url":"https://developer.migros.ch/mgb-developer-portal/api-catalog/formigros"},"info":{"contact":{"email":"ARG_MGB-CONSOL-Team@mgb.ch","name":"MGB-CONSOL Team","url":"https://teams.microsoft.com/l/channel/19%3A9b261b70350d4b5797a26552deb0ea80%40thread.tacv2/CONSOL?groupId=8acfd246-03ee-4be4-98c1-b81d574b28a2&tenantId=35aa8c5b-ac0a-4b15-9788-ff6dfa22901f"},"description":"API to interact with forms from Formigros (Migros Form Service).\n\n[Internal Documentation](https://wiki.migros.net/display/FORMIGROS)","title":"Formigros QUAL","version":"0.0.1"},"openapi":"3.0.1","paths":{"/migros/forms/v1/form/{formId}":{"get":{"description":"This will retrieve a form by providing its id.","operationId":"getFormById","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"5fc7c25a2a992abe68b247b4","type":"string"}}],"responses":{"200":{"description":"Get Form by Id"}},"summary":"Get Form by Id","tags":["Form API"]}},"/migros/forms/v1/form/{formId}/v":{"get":{"description":"This API will fetch all revisions for a specific form.","operationId":"getFormRevisions","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"{{formId}}","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":[{"_id":"5fc7c2d02a992abe68b247b6","_rid":"5fc7c25a2a992abe68b247b4","_vid":1,"_vnote":"","_vuser":"user522","access":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"components":[{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"firstName","label":"First Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"lastName","label":"Last Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"defaultValue":"","input":true,"inputType":"email","isNew":false,"key":"email","kickbox":{"enabled":false},"label":"Email","lockKey":true,"persistent":true,"placeholder":"Enter your email address","prefix":"","protected":false,"suffix":"","tableView":true,"type":"email","unique":false},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"(999) 999-9999","isNew":false,"key":"phoneNumber","label":"Phone Number","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"phoneNumber","unique":false,"validate":{"required":false}},{"action":"submit","block":false,"disableOnInvalid":false,"input":true,"key":"submit","label":"Submit","leftIcon":"","rightIcon":"","size":"md","tableView":false,"theme":"primary","type":"button"}],"created":"2020-12-02T16:35:38.683Z","display":"form","modified":"2020-12-02T16:37:36.283Z","name":"synthesize","owner":"5fc7beeb2a992abe68b2475c","path":"iterate","project":"5fc7befe2a992abe68b24765","revisions":"original","submissionAccess":[],"tags":["register"],"title":"navigating","type":"form"}],"schema":{"items":{"properties":{"_id":{"type":"string"},"_rid":{"type":"string"},"_vid":{"type":"integer"},"_vnote":{"type":"string"},"_vuser":{"type":"string"},"access":{"items":{"properties":{"roles":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"conditional":{"properties":{"eq":{"type":"string"},"show":{"type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"type":"string"},"input":{"type":"boolean"},"inputMask":{"type":"string"},"inputType":{"type":"string"},"isNew":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"lockKey":{"type":"boolean"},"multiple":{"type":"boolean"},"persistent":{"type":"boolean"},"placeholder":{"type":"string"},"prefix":{"type":"string"},"protected":{"type":"boolean"},"suffix":{"type":"string"},"tableView":{"type":"boolean"},"tags":{"items":{},"type":"array"},"type":{"type":"string"},"unique":{"type":"boolean"},"validate":{"properties":{"custom":{"type":"string"},"customPrivate":{"type":"boolean"},"maxLength":{"type":"string"},"minLength":{"type":"string"},"pattern":{"type":"string"},"required":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"format":"date-time","type":"string"},"display":{"type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"path":{"type":"string"},"project":{"type":"string"},"revisions":{"type":"string"},"submissionAccess":{"items":{},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}}},"description":"Get Form Revisions","headers":{"Accept-Ranges":{"example":"items","schema":{"type":"string"}},"Access-Control-Allow-Origin":{"example":"https://form.io","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"Content-Range, Accept-Ranges, Range-Unit","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":2284,"schema":{"type":"integer"}},"Content-Range":{"example":"0-0/1","schema":{"type":"string"}},"Date":{"example":"Wed, 02 Dec 2020 16:39:03 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"8ec-BzhKp6IzE5tO/Et6WjY9G7JQ6/c\"","schema":{"type":"string"}},"Link":{"example":"","schema":{"type":"string"}},"Range-Unit":{"example":"items","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3MTQzLCJleHAiOjE2MDY5NDE1NDN9.UPLwDNKDudotIphfGlRM-5gSslyBpSei71daxg7DzGM","schema":{"type":"string"}}}}},"summary":"Get Form Revisions","tags":["Form API"]}},"/migros/forms/v1/form/{formId}/v/{revisionNumber}":{"get":{"description":"This API request will fetch the form JSON for a specific form revision.","operationId":"getSpecificFormRevision","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"{{formId}}","type":"string"}},{"description":"Form revision number","in":"path","name":"revisionNumber","required":true,"schema":{"example":"{{revisionNumber}}","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_id":"5fc7c2d02a992abe68b247b6","_rid":"5fc7c25a2a992abe68b247b4","_vid":1,"_vnote":"","_vuser":"user522","access":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"components":[{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"firstName","label":"First Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"lastName","label":"Last Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"defaultValue":"","input":true,"inputType":"email","isNew":false,"key":"email","kickbox":{"enabled":false},"label":"Email","lockKey":true,"persistent":true,"placeholder":"Enter your email address","prefix":"","protected":false,"suffix":"","tableView":true,"type":"email","unique":false},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"(999) 999-9999","isNew":false,"key":"phoneNumber","label":"Phone Number","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"phoneNumber","unique":false,"validate":{"required":false}},{"action":"submit","block":false,"disableOnInvalid":false,"input":true,"key":"submit","label":"Submit","leftIcon":"","rightIcon":"","size":"md","tableView":false,"theme":"primary","type":"button"}],"created":"2020-12-02T16:35:38.683Z","display":"form","modified":"2020-12-02T16:37:36.283Z","name":"synthesize","owner":"5fc7beeb2a992abe68b2475c","path":"iterate","project":"5fc7befe2a992abe68b24765","revisions":"original","submissionAccess":[],"tags":["register"],"title":"navigating","type":"form"},"schema":{"properties":{"_id":{"type":"string"},"_rid":{"type":"string"},"_vid":{"type":"integer"},"_vnote":{"type":"string"},"_vuser":{"type":"string"},"access":{"items":{"properties":{"roles":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"conditional":{"properties":{"eq":{"type":"string"},"show":{"type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"type":"string"},"input":{"type":"boolean"},"inputMask":{"type":"string"},"inputType":{"type":"string"},"isNew":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"lockKey":{"type":"boolean"},"multiple":{"type":"boolean"},"persistent":{"type":"boolean"},"placeholder":{"type":"string"},"prefix":{"type":"string"},"protected":{"type":"boolean"},"suffix":{"type":"string"},"tableView":{"type":"boolean"},"tags":{"items":{},"type":"array"},"type":{"type":"string"},"unique":{"type":"boolean"},"validate":{"properties":{"custom":{"type":"string"},"customPrivate":{"type":"boolean"},"maxLength":{"type":"string"},"minLength":{"type":"string"},"pattern":{"type":"string"},"required":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"format":"date-time","type":"string"},"display":{"type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"path":{"type":"string"},"project":{"type":"string"},"revisions":{"type":"string"},"submissionAccess":{"items":{},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"description":"Get Specific Form Revision","headers":{"Access-Control-Allow-Origin":{"example":"https://form.io","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"x-jwt-token","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":2282,"schema":{"type":"integer"}},"Date":{"example":"Wed, 02 Dec 2020 16:39:29 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"8ea-CpgJLmOfj3blrtpq+7j3Fb3+7iU\"","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3MTY5LCJleHAiOjE2MDY5NDE1Njl9.6DbqLZ7iJ653GKYrCOKYRf_bkyCqQ0_yHo66VtssxPk","schema":{"type":"string"}}}}},"summary":"Get Specific Form Revision","tags":["Form API"]}},"/migros/forms/v1/integration/form/{formId}":{"get":{"description":"This will retrieve a form by providing its id.","operationId":"getFormByIdIntegration","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"5fc7c25a2a992abe68b247b4","type":"string"}}],"responses":{"200":{"description":"Get Form by Id"}},"summary":"Get Form by Id","tags":["Form API"]}},"/migros/forms/v1/integration/form/{formId}/v":{"get":{"description":"This API will fetch all revisions for a specific form.","operationId":"getFormRevisionsIntegration","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"{{formId}}","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":[{"_id":"5fc7c2d02a992abe68b247b6","_rid":"5fc7c25a2a992abe68b247b4","_vid":1,"_vnote":"","_vuser":"user522","access":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"components":[{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"firstName","label":"First Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"lastName","label":"Last Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"defaultValue":"","input":true,"inputType":"email","isNew":false,"key":"email","kickbox":{"enabled":false},"label":"Email","lockKey":true,"persistent":true,"placeholder":"Enter your email address","prefix":"","protected":false,"suffix":"","tableView":true,"type":"email","unique":false},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"(999) 999-9999","isNew":false,"key":"phoneNumber","label":"Phone Number","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"phoneNumber","unique":false,"validate":{"required":false}},{"action":"submit","block":false,"disableOnInvalid":false,"input":true,"key":"submit","label":"Submit","leftIcon":"","rightIcon":"","size":"md","tableView":false,"theme":"primary","type":"button"}],"created":"2020-12-02T16:35:38.683Z","display":"form","modified":"2020-12-02T16:37:36.283Z","name":"synthesize","owner":"5fc7beeb2a992abe68b2475c","path":"iterate","project":"5fc7befe2a992abe68b24765","revisions":"original","submissionAccess":[],"tags":["register"],"title":"navigating","type":"form"}],"schema":{"items":{"properties":{"_id":{"type":"string"},"_rid":{"type":"string"},"_vid":{"type":"integer"},"_vnote":{"type":"string"},"_vuser":{"type":"string"},"access":{"items":{"properties":{"roles":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"conditional":{"properties":{"eq":{"type":"string"},"show":{"type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"type":"string"},"input":{"type":"boolean"},"inputMask":{"type":"string"},"inputType":{"type":"string"},"isNew":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"lockKey":{"type":"boolean"},"multiple":{"type":"boolean"},"persistent":{"type":"boolean"},"placeholder":{"type":"string"},"prefix":{"type":"string"},"protected":{"type":"boolean"},"suffix":{"type":"string"},"tableView":{"type":"boolean"},"tags":{"items":{},"type":"array"},"type":{"type":"string"},"unique":{"type":"boolean"},"validate":{"properties":{"custom":{"type":"string"},"customPrivate":{"type":"boolean"},"maxLength":{"type":"string"},"minLength":{"type":"string"},"pattern":{"type":"string"},"required":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"format":"date-time","type":"string"},"display":{"type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"path":{"type":"string"},"project":{"type":"string"},"revisions":{"type":"string"},"submissionAccess":{"items":{},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}}},"description":"Get Form Revisions","headers":{"Accept-Ranges":{"example":"items","schema":{"type":"string"}},"Access-Control-Allow-Origin":{"example":"https://form.io","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"Content-Range, Accept-Ranges, Range-Unit","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":2284,"schema":{"type":"integer"}},"Content-Range":{"example":"0-0/1","schema":{"type":"string"}},"Date":{"example":"Wed, 02 Dec 2020 16:39:03 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"8ec-BzhKp6IzE5tO/Et6WjY9G7JQ6/c\"","schema":{"type":"string"}},"Link":{"example":"","schema":{"type":"string"}},"Range-Unit":{"example":"items","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3MTQzLCJleHAiOjE2MDY5NDE1NDN9.UPLwDNKDudotIphfGlRM-5gSslyBpSei71daxg7DzGM","schema":{"type":"string"}}}}},"summary":"Get Form Revisions","tags":["Form API"]}},"/migros/forms/v1/integration/form/{formId}/v/{revisionNumber}":{"get":{"description":"This API request will fetch the form JSON for a specific form revision.","operationId":"getSpecificFormRevisionIntegration","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"{{formId}}","type":"string"}},{"description":"Form revision number","in":"path","name":"revisionNumber","required":true,"schema":{"example":"{{revisionNumber}}","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_id":"5fc7c2d02a992abe68b247b6","_rid":"5fc7c25a2a992abe68b247b4","_vid":1,"_vnote":"","_vuser":"user522","access":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"components":[{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"firstName","label":"First Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"lastName","label":"Last Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"defaultValue":"","input":true,"inputType":"email","isNew":false,"key":"email","kickbox":{"enabled":false},"label":"Email","lockKey":true,"persistent":true,"placeholder":"Enter your email address","prefix":"","protected":false,"suffix":"","tableView":true,"type":"email","unique":false},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"(999) 999-9999","isNew":false,"key":"phoneNumber","label":"Phone Number","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"phoneNumber","unique":false,"validate":{"required":false}},{"action":"submit","block":false,"disableOnInvalid":false,"input":true,"key":"submit","label":"Submit","leftIcon":"","rightIcon":"","size":"md","tableView":false,"theme":"primary","type":"button"}],"created":"2020-12-02T16:35:38.683Z","display":"form","modified":"2020-12-02T16:37:36.283Z","name":"synthesize","owner":"5fc7beeb2a992abe68b2475c","path":"iterate","project":"5fc7befe2a992abe68b24765","revisions":"original","submissionAccess":[],"tags":["register"],"title":"navigating","type":"form"},"schema":{"properties":{"_id":{"type":"string"},"_rid":{"type":"string"},"_vid":{"type":"integer"},"_vnote":{"type":"string"},"_vuser":{"type":"string"},"access":{"items":{"properties":{"roles":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"conditional":{"properties":{"eq":{"type":"string"},"show":{"type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"type":"string"},"input":{"type":"boolean"},"inputMask":{"type":"string"},"inputType":{"type":"string"},"isNew":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"lockKey":{"type":"boolean"},"multiple":{"type":"boolean"},"persistent":{"type":"boolean"},"placeholder":{"type":"string"},"prefix":{"type":"string"},"protected":{"type":"boolean"},"suffix":{"type":"string"},"tableView":{"type":"boolean"},"tags":{"items":{},"type":"array"},"type":{"type":"string"},"unique":{"type":"boolean"},"validate":{"properties":{"custom":{"type":"string"},"customPrivate":{"type":"boolean"},"maxLength":{"type":"string"},"minLength":{"type":"string"},"pattern":{"type":"string"},"required":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"format":"date-time","type":"string"},"display":{"type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"path":{"type":"string"},"project":{"type":"string"},"revisions":{"type":"string"},"submissionAccess":{"items":{},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"description":"Get Specific Form Revision","headers":{"Access-Control-Allow-Origin":{"example":"https://form.io","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"x-jwt-token","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":2282,"schema":{"type":"integer"}},"Date":{"example":"Wed, 02 Dec 2020 16:39:29 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"8ea-CpgJLmOfj3blrtpq+7j3Fb3+7iU\"","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3MTY5LCJleHAiOjE2MDY5NDE1Njl9.6DbqLZ7iJ653GKYrCOKYRf_bkyCqQ0_yHo66VtssxPk","schema":{"type":"string"}}}}},"summary":"Get Specific Form Revision","tags":["Form API"]}},"/migros/forms/v1/integration/language/submission":{"get":{"description":"Retrieves language submissions for a specific form and language.","operationId":"getLanguageSubmissionIntegration","parameters":[{"description":"Language code","in":"query","name":"data.language","required":true,"schema":{"example":"de","type":"string"}},{"description":"Form identifier","in":"query","name":"data.form","required":true,"schema":{"example":"generic","type":"string"}}],"responses":{"200":{"description":"Language submissions fetched"}},"summary":"Get Language Submission","tags":["Form API"]}},"/migros/forms/v1/integration/{formPath}":{"get":{"description":"This will retrieve a form by providing its path alias.","operationId":"getFormByAliasIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"responses":{"200":{"description":"Get Form by Alias"}},"summary":"Get Form by Alias","tags":["Form API"]}},"/migros/forms/v1/integration/{formPath}/storage/azure":{"delete":{"description":"Deletes a file from the configured Azure storage provider.","operationId":"deleteFromAzureStorageIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"File name","in":"query","name":"name","required":true,"schema":{"example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"}},{"description":"Storage key","in":"query","name":"key","required":true,"schema":{"example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"}}],"responses":{"204":{"description":"File deleted"}},"summary":"Delete File from Azure Storage","tags":["Submission API"]},"get":{"description":"This will retrieve the files stored in the configured Azure storage provider.","operationId":"getFromAzureStorageIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get Azure Storage Files"}},"summary":"Get Azure Storage Files","tags":["Submission API"]},"post":{"description":"Uploads a file through Form.io to the configured Azure storage provider.","operationId":"uploadToAzureStorageIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UploadFile":{"value":{"groupId":null,"groupPermissions":null,"name":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","size":12,"type":"application/pdf"}}},"schema":{"properties":{"groupId":{"description":"Optional group id","example":null,"nullable":true,"type":"string"},"groupPermissions":{"description":"Optional group permissions identifier","example":null,"nullable":true,"type":"string"},"name":{"description":"File name","example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"},"size":{"description":"File size in bytes","example":12,"type":"integer"},"type":{"description":"MIME type","example":"application/pdf","type":"string"}},"required":["name","size","type"],"type":"object"}}},"required":true},"responses":{"200":{"description":"File uploaded"}},"summary":"Upload File to Azure Storage","tags":["Submission API"]}},"/migros/forms/v1/integration/{formPath}/submission":{"get":{"description":"Retrieves submissions for the given Integration form alias. Kong proxies to Form.io’s submission **index** API (resourcejs), which applies the same `limit` / `skip` / `Range` pagination and query filtering as the native project URL.\n\nExtra query keys may filter on indexed submission fields using Form.io / resourcejs conventions (for example `data.someKey=value` or operator suffixes such as `__regex` where supported).\n\n**Auth:** Form.io enforces roles such as the form’s submission viewer permissions using this JWT.\n","operationId":"getFormSubmissionsIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"Form.io JWT token for the signed-in user.","in":"header","name":"x-jwt-token","required":true,"schema":{"type":"string"}},{"description":"Maximum submissions to return. Form.io (resourcejs) defaults to **10** when `limit`, `skip`, and `Range` are all omitted.\n","in":"query","name":"limit","required":false,"schema":{"example":50,"minimum":0,"type":"integer"}},{"description":"Number of submissions to skip (offset before `limit`).","in":"query","name":"skip","required":false,"schema":{"example":0,"minimum":0,"type":"integer"}},{"description":"Mongo-style sort, e.g. `-created` for newest first, `created` for oldest first.","in":"query","name":"sort","required":false,"schema":{"example":"-created","type":"string"}},{"description":"Optional pagination header; must use the **`items`** unit. Example: `items=0-49`.\nEquivalent to setting `limit` and `skip` from the range; do not rely on mixing both in one request without verifying behavior on your Form.io version.\n","in":"header","name":"Range","required":false,"schema":{"example":"items=0-49","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"JSON array of submissions—either the full matching set in one response, or the last page of a paginated request.\n","headers":{"Content-Range":{"description":"May be present when the server reports pagination metadata. Typical shape: `items -/` (unit `items`).\n","schema":{"example":"items 0-9/42","type":"string"}}}},"206":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Partial list; additional submissions exist. Read `Content-Range`, then request the next window via `skip` / `limit` or a follow-up `Range` header.\n","headers":{"Content-Range":{"description":"Returned slice and total count, e.g. `items 0-9/42`.","required":true,"schema":{"example":"items 0-9/42","type":"string"}}}}},"security":[{"apikey":[]}],"summary":"Get Form Submissions","tags":["Submission API"]},"post":{"description":"Creates a new submission for the given form alias. Include _fvid to target a specific form revision.","operationId":"createFormSubmissionIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Create Form Submission":{"value":{"_fvid":"2","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"}}}},"schema":{"properties":{"_fvid":{"example":"2","type":"string"},"data":{"properties":{"email":{"example":"joe@example.com","type":"string"},"firstName":{"example":"Joe","type":"string"},"lastName":{"example":"Smith","type":"string"},"phoneNumber":{"example":"(123) 123-1234","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Create Form Submission / Create Submission / Create Form Revision Submission"}},"summary":"Create Form Submission","tags":["Submission API"]}},"/migros/forms/v1/integration/{formPath}/submission/{submissionId}":{"get":{"description":"This will retrieve a single submission within a form.","operationId":"getFormSubmissionByIdIntegration","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"Submission Id","in":"path","name":"submissionId","required":true,"schema":{"example":"57d0a2fd76f943a4007e1529","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_fvid":1,"_id":"5fc7c4082a992abe68b247b9","_vid":0,"access":[],"created":"2020-12-02T16:42:48.128Z","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"},"externalIds":[],"form":"5fc7c25a2a992abe68b247b4","modified":"2020-12-02T16:42:48.129Z","owner":"5fc7beeb2a992abe68b2475c","project":"5fc7befe2a992abe68b24765","roles":[],"state":"submitted"},"schema":{"properties":{"_fvid":{"type":"integer"},"_id":{"type":"string"},"_vid":{"type":"integer"},"access":{"items":{},"type":"array"},"created":{"format":"date-time","type":"string"},"data":{"properties":{"email":{"format":"email","type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"}},"type":"object"},"externalIds":{"items":{},"type":"array"},"form":{"type":"string"},"modified":{"format":"date-time","type":"string"},"owner":{"type":"string"},"project":{"type":"string"},"roles":{"items":{},"type":"array"},"state":{"type":"string"}},"type":"object"}}},"description":"Get a Submission","headers":{"Access-Control-Allow-Origin":{"example":"*","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"x-jwt-token","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":397,"schema":{"type":"integer"}},"Date":{"example":"Wed, 02 Dec 2020 16:44:35 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"18d-WTVXer2UdkEDeKfaQMFTYPuR3Ww\"","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3NDc1LCJleHAiOjE2MDY5NDE4NzV9.MboJ5cX_nJD_sO76p8HA4bW2NMNHb9uowXJMayfXQNQ","schema":{"type":"string"}}}}},"summary":"Get a Submission","tags":["Submission API"]}},"/migros/forms/v1/language/submission":{"get":{"description":"Retrieves language submissions for a specific form and language.","operationId":"getLanguageSubmission","parameters":[{"description":"Language code","in":"query","name":"data.language","required":true,"schema":{"example":"de","type":"string"}},{"description":"Form identifier","in":"query","name":"data.form","required":true,"schema":{"example":"generic","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Language submissions fetched"}},"summary":"Get Language Submission","tags":["Form API"]}},"/migros/forms/v1/pre/form/{formId}":{"get":{"description":"This will retrieve a form by providing its id.","operationId":"getFormByIdPre","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"5fc7c25a2a992abe68b247b4","type":"string"}}],"responses":{"200":{"description":"Get Form by Id"}},"summary":"Get Form by Id","tags":["Form API"]}},"/migros/forms/v1/pre/form/{formId}/v":{"get":{"description":"This API will fetch all revisions for a specific form.","operationId":"getFormRevisionsPre","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"{{formId}}","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":[{"_id":"5fc7c2d02a992abe68b247b6","_rid":"5fc7c25a2a992abe68b247b4","_vid":1,"_vnote":"","_vuser":"user522","access":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"components":[{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"firstName","label":"First Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"lastName","label":"Last Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"defaultValue":"","input":true,"inputType":"email","isNew":false,"key":"email","kickbox":{"enabled":false},"label":"Email","lockKey":true,"persistent":true,"placeholder":"Enter your email address","prefix":"","protected":false,"suffix":"","tableView":true,"type":"email","unique":false},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"(999) 999-9999","isNew":false,"key":"phoneNumber","label":"Phone Number","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"phoneNumber","unique":false,"validate":{"required":false}},{"action":"submit","block":false,"disableOnInvalid":false,"input":true,"key":"submit","label":"Submit","leftIcon":"","rightIcon":"","size":"md","tableView":false,"theme":"primary","type":"button"}],"created":"2020-12-02T16:35:38.683Z","display":"form","modified":"2020-12-02T16:37:36.283Z","name":"synthesize","owner":"5fc7beeb2a992abe68b2475c","path":"iterate","project":"5fc7befe2a992abe68b24765","revisions":"original","submissionAccess":[],"tags":["register"],"title":"navigating","type":"form"}],"schema":{"items":{"properties":{"_id":{"type":"string"},"_rid":{"type":"string"},"_vid":{"type":"integer"},"_vnote":{"type":"string"},"_vuser":{"type":"string"},"access":{"items":{"properties":{"roles":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"conditional":{"properties":{"eq":{"type":"string"},"show":{"type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"type":"string"},"input":{"type":"boolean"},"inputMask":{"type":"string"},"inputType":{"type":"string"},"isNew":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"lockKey":{"type":"boolean"},"multiple":{"type":"boolean"},"persistent":{"type":"boolean"},"placeholder":{"type":"string"},"prefix":{"type":"string"},"protected":{"type":"boolean"},"suffix":{"type":"string"},"tableView":{"type":"boolean"},"tags":{"items":{},"type":"array"},"type":{"type":"string"},"unique":{"type":"boolean"},"validate":{"properties":{"custom":{"type":"string"},"customPrivate":{"type":"boolean"},"maxLength":{"type":"string"},"minLength":{"type":"string"},"pattern":{"type":"string"},"required":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"format":"date-time","type":"string"},"display":{"type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"path":{"type":"string"},"project":{"type":"string"},"revisions":{"type":"string"},"submissionAccess":{"items":{},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}}},"description":"Get Form Revisions","headers":{"Accept-Ranges":{"example":"items","schema":{"type":"string"}},"Access-Control-Allow-Origin":{"example":"https://form.io","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"Content-Range, Accept-Ranges, Range-Unit","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":2284,"schema":{"type":"integer"}},"Content-Range":{"example":"0-0/1","schema":{"type":"string"}},"Date":{"example":"Wed, 02 Dec 2020 16:39:03 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"8ec-BzhKp6IzE5tO/Et6WjY9G7JQ6/c\"","schema":{"type":"string"}},"Link":{"example":"","schema":{"type":"string"}},"Range-Unit":{"example":"items","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3MTQzLCJleHAiOjE2MDY5NDE1NDN9.UPLwDNKDudotIphfGlRM-5gSslyBpSei71daxg7DzGM","schema":{"type":"string"}}}}},"summary":"Get Form Revisions","tags":["Form API"]}},"/migros/forms/v1/pre/form/{formId}/v/{revisionNumber}":{"get":{"description":"This API request will fetch the form JSON for a specific form revision.","operationId":"getSpecificFormRevisionPre","parameters":[{"description":"Form Id","in":"path","name":"formId","required":true,"schema":{"example":"{{formId}}","type":"string"}},{"description":"Form revision number","in":"path","name":"revisionNumber","required":true,"schema":{"example":"{{revisionNumber}}","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_id":"5fc7c2d02a992abe68b247b6","_rid":"5fc7c25a2a992abe68b247b4","_vid":1,"_vnote":"","_vuser":"user522","access":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"components":[{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"firstName","label":"First Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"","inputType":"text","isNew":false,"key":"lastName","label":"Last Name","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"textfield","unique":false,"validate":{"custom":"","customPrivate":false,"maxLength":"","minLength":"","pattern":"","required":false}},{"defaultValue":"","input":true,"inputType":"email","isNew":false,"key":"email","kickbox":{"enabled":false},"label":"Email","lockKey":true,"persistent":true,"placeholder":"Enter your email address","prefix":"","protected":false,"suffix":"","tableView":true,"type":"email","unique":false},{"conditional":{"eq":"","show":"","when":null},"defaultValue":"","input":true,"inputMask":"(999) 999-9999","isNew":false,"key":"phoneNumber","label":"Phone Number","lockKey":true,"multiple":false,"persistent":true,"placeholder":"","prefix":"","protected":false,"suffix":"","tableView":true,"tags":[],"type":"phoneNumber","unique":false,"validate":{"required":false}},{"action":"submit","block":false,"disableOnInvalid":false,"input":true,"key":"submit","label":"Submit","leftIcon":"","rightIcon":"","size":"md","tableView":false,"theme":"primary","type":"button"}],"created":"2020-12-02T16:35:38.683Z","display":"form","modified":"2020-12-02T16:37:36.283Z","name":"synthesize","owner":"5fc7beeb2a992abe68b2475c","path":"iterate","project":"5fc7befe2a992abe68b24765","revisions":"original","submissionAccess":[],"tags":["register"],"title":"navigating","type":"form"},"schema":{"properties":{"_id":{"type":"string"},"_rid":{"type":"string"},"_vid":{"type":"integer"},"_vnote":{"type":"string"},"_vuser":{"type":"string"},"access":{"items":{"properties":{"roles":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"conditional":{"properties":{"eq":{"type":"string"},"show":{"type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"type":"string"},"input":{"type":"boolean"},"inputMask":{"type":"string"},"inputType":{"type":"string"},"isNew":{"type":"boolean"},"key":{"type":"string"},"label":{"type":"string"},"lockKey":{"type":"boolean"},"multiple":{"type":"boolean"},"persistent":{"type":"boolean"},"placeholder":{"type":"string"},"prefix":{"type":"string"},"protected":{"type":"boolean"},"suffix":{"type":"string"},"tableView":{"type":"boolean"},"tags":{"items":{},"type":"array"},"type":{"type":"string"},"unique":{"type":"boolean"},"validate":{"properties":{"custom":{"type":"string"},"customPrivate":{"type":"boolean"},"maxLength":{"type":"string"},"minLength":{"type":"string"},"pattern":{"type":"string"},"required":{"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"format":"date-time","type":"string"},"display":{"type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"path":{"type":"string"},"project":{"type":"string"},"revisions":{"type":"string"},"submissionAccess":{"items":{},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"description":"Get Specific Form Revision","headers":{"Access-Control-Allow-Origin":{"example":"https://form.io","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"x-jwt-token","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":2282,"schema":{"type":"integer"}},"Date":{"example":"Wed, 02 Dec 2020 16:39:29 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"8ea-CpgJLmOfj3blrtpq+7j3Fb3+7iU\"","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3MTY5LCJleHAiOjE2MDY5NDE1Njl9.6DbqLZ7iJ653GKYrCOKYRf_bkyCqQ0_yHo66VtssxPk","schema":{"type":"string"}}}}},"summary":"Get Specific Form Revision","tags":["Form API"]}},"/migros/forms/v1/pre/language/submission":{"get":{"description":"Retrieves language submissions for a specific form and language.","operationId":"getLanguageSubmissionPre","parameters":[{"description":"Language code","in":"query","name":"data.language","required":true,"schema":{"example":"de","type":"string"}},{"description":"Form identifier","in":"query","name":"data.form","required":true,"schema":{"example":"generic","type":"string"}}],"responses":{"200":{"description":"Language submissions fetched"}},"summary":"Get Language Submission","tags":["Form API"]}},"/migros/forms/v1/pre/{formPath}":{"get":{"description":"This will retrieve a form by providing its path alias.","operationId":"getFormByAliasPre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"responses":{"200":{"description":"Get Form by Alias"}},"summary":"Get Form by Alias","tags":["Form API"]}},"/migros/forms/v1/pre/{formPath}/storage/azure":{"delete":{"description":"Deletes a file from the configured Azure storage provider.","operationId":"deleteFromAzureStoragePre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"File name","in":"query","name":"name","required":true,"schema":{"example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"}},{"description":"Storage key","in":"query","name":"key","required":true,"schema":{"example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"}}],"responses":{"204":{"description":"File deleted"}},"summary":"Delete File from Azure Storage","tags":["Submission API"]},"get":{"description":"This will retrieve the files stored in the configured Azure storage provider.","operationId":"getFromAzureStoragePre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get Azure Storage Files"}},"summary":"Get Azure Storage Files","tags":["Submission API"]},"post":{"description":"Uploads a file through Form.io to the configured Azure storage provider.","operationId":"uploadToAzureStoragePre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UploadFile":{"value":{"groupId":null,"groupPermissions":null,"name":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","size":12,"type":"application/pdf"}}},"schema":{"properties":{"groupId":{"description":"Optional group id","example":null,"nullable":true,"type":"string"},"groupPermissions":{"description":"Optional group permissions identifier","example":null,"nullable":true,"type":"string"},"name":{"description":"File name","example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"},"size":{"description":"File size in bytes","example":12,"type":"integer"},"type":{"description":"MIME type","example":"application/pdf","type":"string"}},"required":["name","size","type"],"type":"object"}}},"required":true},"responses":{"200":{"description":"File uploaded"}},"summary":"Upload File to Azure Storage","tags":["Submission API"]}},"/migros/forms/v1/pre/{formPath}/submission":{"get":{"description":"Retrieves submissions for the given Pre-PROD form alias. Kong proxies to Form.io’s submission **index** API (resourcejs), which applies the same `limit` / `skip` / `Range` pagination and query filtering as the native project URL.\n\nExtra query keys may filter on indexed submission fields using Form.io / resourcejs conventions (for example `data.someKey=value` or operator suffixes such as `__regex` where supported).\n\n**Auth:** Form.io enforces roles such as the form’s submission viewer permissions using this JWT.\n","operationId":"getFormSubmissionsPre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"Form.io JWT token for the signed-in user.","in":"header","name":"x-jwt-token","required":true,"schema":{"type":"string"}},{"description":"Maximum submissions to return. Form.io (resourcejs) defaults to **10** when `limit`, `skip`, and `Range` are all omitted.\n","in":"query","name":"limit","required":false,"schema":{"example":50,"minimum":0,"type":"integer"}},{"description":"Number of submissions to skip (offset before `limit`).","in":"query","name":"skip","required":false,"schema":{"example":0,"minimum":0,"type":"integer"}},{"description":"Mongo-style sort, e.g. `-created` for newest first, `created` for oldest first.","in":"query","name":"sort","required":false,"schema":{"example":"-created","type":"string"}},{"description":"Optional pagination header; must use the **`items`** unit. Example: `items=0-49`.\nEquivalent to setting `limit` and `skip` from the range; do not rely on mixing both in one request without verifying behavior on your Form.io version.\n","in":"header","name":"Range","required":false,"schema":{"example":"items=0-49","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"JSON array of submissions—either the full matching set in one response, or the last page of a paginated request.\n","headers":{"Content-Range":{"description":"May be present when the server reports pagination metadata. Typical shape: `items -/` (unit `items`).\n","schema":{"example":"items 0-9/42","type":"string"}}}},"206":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Partial list; additional submissions exist. Read `Content-Range`, then request the next window via `skip` / `limit` or a follow-up `Range` header.\n","headers":{"Content-Range":{"description":"Returned slice and total count, e.g. `items 0-9/42`.","required":true,"schema":{"example":"items 0-9/42","type":"string"}}}}},"security":[{"apikey":[]}],"summary":"Get Form Submissions","tags":["Submission API"]},"post":{"description":"Creates a new submission for the given form alias. Include _fvid to target a specific form revision.","operationId":"createFormSubmissionPre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Create Form Submission":{"value":{"_fvid":"2","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"}}}},"schema":{"properties":{"_fvid":{"example":"2","type":"string"},"data":{"properties":{"email":{"example":"joe@example.com","type":"string"},"firstName":{"example":"Joe","type":"string"},"lastName":{"example":"Smith","type":"string"},"phoneNumber":{"example":"(123) 123-1234","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Create Form Submission / Create Submission / Create Form Revision Submission"}},"summary":"Create Form Submission","tags":["Submission API"]}},"/migros/forms/v1/pre/{formPath}/submission/{submissionId}":{"get":{"description":"This will retrieve a single submission within a form.","operationId":"getFormSubmissionByIdPre","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"Submission Id","in":"path","name":"submissionId","required":true,"schema":{"example":"57d0a2fd76f943a4007e1529","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_fvid":1,"_id":"5fc7c4082a992abe68b247b9","_vid":0,"access":[],"created":"2020-12-02T16:42:48.128Z","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"},"externalIds":[],"form":"5fc7c25a2a992abe68b247b4","modified":"2020-12-02T16:42:48.129Z","owner":"5fc7beeb2a992abe68b2475c","project":"5fc7befe2a992abe68b24765","roles":[],"state":"submitted"},"schema":{"properties":{"_fvid":{"type":"integer"},"_id":{"type":"string"},"_vid":{"type":"integer"},"access":{"items":{},"type":"array"},"created":{"format":"date-time","type":"string"},"data":{"properties":{"email":{"format":"email","type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"}},"type":"object"},"externalIds":{"items":{},"type":"array"},"form":{"type":"string"},"modified":{"format":"date-time","type":"string"},"owner":{"type":"string"},"project":{"type":"string"},"roles":{"items":{},"type":"array"},"state":{"type":"string"}},"type":"object"}}},"description":"Get a Submission","headers":{"Access-Control-Allow-Origin":{"example":"*","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"x-jwt-token","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":397,"schema":{"type":"integer"}},"Date":{"example":"Wed, 02 Dec 2020 16:44:35 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"18d-WTVXer2UdkEDeKfaQMFTYPuR3Ww\"","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3NDc1LCJleHAiOjE2MDY5NDE4NzV9.MboJ5cX_nJD_sO76p8HA4bW2NMNHb9uowXJMayfXQNQ","schema":{"type":"string"}}}}},"summary":"Get a Submission","tags":["Submission API"]}},"/migros/forms/v1/{formPath}":{"get":{"description":"This will retrieve a form by providing its path alias.","operationId":"getFormByAlias","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"_id":{"example":"5fc7c25a2a992abe68b247b4","type":"string"},"_vid":{"example":0,"type":"number"},"access":{"example":[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}],"items":{"properties":{"roles":{"example":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"items":{"example":"5fc7befe2a992abe68b24766","type":"string"},"type":"array"},"type":{"example":"read_all","type":"string"}},"type":"object"},"type":"array"},"components":{"items":{"properties":{"action":{"example":"submit","type":"string"},"block":{"example":false,"type":"boolean"},"conditional":{"properties":{"eq":{"example":"","type":"string"},"show":{"example":"","type":"string"},"when":{"example":null,"nullable":true,"type":"string"}},"type":"object"},"defaultValue":{"example":"","type":"string"},"disableOnInvalid":{"example":false,"type":"boolean"},"input":{"example":true,"type":"boolean"},"inputMask":{"example":"","type":"string"},"inputType":{"example":"text","type":"string"},"isNew":{"example":false,"type":"boolean"},"key":{"example":"firstName","type":"string"},"kickbox":{"properties":{"enabled":{"example":false,"type":"boolean"}},"type":"object"},"label":{"example":"First Name","type":"string"},"leftIcon":{"example":"","type":"string"},"lockKey":{"example":true,"type":"boolean"},"multiple":{"example":false,"type":"boolean"},"persistent":{"example":true,"type":"boolean"},"placeholder":{"example":"","type":"string"},"prefix":{"example":"","type":"string"},"protected":{"example":false,"type":"boolean"},"rightIcon":{"example":"","type":"string"},"size":{"example":"md","type":"string"},"suffix":{"example":"","type":"string"},"tableView":{"example":true,"type":"boolean"},"tags":{"example":[],"items":{},"type":"array"},"theme":{"example":"primary","type":"string"},"type":{"example":"textfield","type":"string"},"unique":{"example":false,"type":"boolean"},"validate":{"properties":{"custom":{"example":"","type":"string"},"customPrivate":{"example":false,"type":"boolean"},"maxLength":{"example":"","type":"string"},"minLength":{"example":"","type":"string"},"pattern":{"example":"","type":"string"},"required":{"example":true,"type":"boolean"}},"type":"object"}},"type":"object"},"type":"array"},"created":{"example":"2020-12-02T16:35:38.683Z","type":"string"},"display":{"example":"form","type":"string"},"machineName":{"example":"proj366:synthesize","type":"string"},"modified":{"example":"2020-12-02T16:35:38.687Z","type":"string"},"name":{"example":"synthesize","type":"string"},"owner":{"example":"5fc7beeb2a992abe68b2475c","type":"string"},"path":{"example":"iterate","type":"string"},"project":{"example":"5fc7befe2a992abe68b24765","type":"string"},"revisions":{"example":"","type":"string"},"submissionAccess":{"example":[],"items":{},"type":"array"},"tags":{"example":[],"items":{},"type":"array"},"title":{"example":"navigating","type":"string"},"type":{"example":"form","type":"string"}},"type":"object"}}},"description":"Get Form by Alias"}},"summary":"Get Form by Alias","tags":["Form API"]}},"/migros/forms/v1/{formPath}/storage/azure":{"delete":{"description":"Deletes a file from the configured Azure storage provider.","operationId":"deleteFromAzureStorage","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"File name","in":"query","name":"name","required":true,"schema":{"example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"}},{"description":"Storage key","in":"query","name":"key","required":true,"schema":{"example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"}}],"responses":{"204":{"description":"File deleted"}},"summary":"Delete File from Azure Storage","tags":["Submission API"]},"get":{"description":"This will retrieve the files stored in the configured Azure storage provider.","operationId":"getFromAzureStorage","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get Azure Storage Files"}},"summary":"Get Azure Storage Files","tags":["Submission API"]},"post":{"description":"Uploads a file through Form.io to the configured Azure storage provider.","operationId":"uploadToAzureStorage","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"UploadFile":{"value":{"groupId":null,"groupPermissions":null,"name":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","size":12,"type":"application/pdf"}}},"schema":{"properties":{"groupId":{"description":"Optional group id","example":null,"nullable":true,"type":"string"},"groupPermissions":{"description":"Optional group permissions identifier","example":null,"nullable":true,"type":"string"},"name":{"description":"File name","example":"tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf","type":"string"},"size":{"description":"File size in bytes","example":12,"type":"integer"},"type":{"description":"MIME type","example":"application/pdf","type":"string"}},"required":["name","size","type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"File uploaded"}},"summary":"Upload File to Azure Storage","tags":["Submission API"]}},"/migros/forms/v1/{formPath}/submission":{"get":{"description":"Retrieves submissions for the given form alias. Kong proxies to Form.io’s submission **index** API (resourcejs), which applies the same `limit` / `skip` / `Range` pagination and query filtering as the native project URL.\n\nExtra query keys may filter on indexed submission fields using Form.io / resourcejs conventions (for example `data.someKey=value` or operator suffixes such as `__regex` where supported).\n\n**Auth:** Form.io enforces roles such as the form’s submission viewer permissions using this JWT.\n","operationId":"getFormSubmissions","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"Form.io JWT token for the signed-in user.","in":"header","name":"x-jwt-token","required":true,"schema":{"type":"string"}},{"description":"Maximum submissions to return. Form.io (resourcejs) defaults to **10** when `limit`, `skip`, and `Range` are all omitted.\n","in":"query","name":"limit","required":false,"schema":{"example":50,"minimum":0,"type":"integer"}},{"description":"Number of submissions to skip (offset before `limit`).","in":"query","name":"skip","required":false,"schema":{"example":0,"minimum":0,"type":"integer"}},{"description":"Mongo-style sort, e.g. `-created` for newest first, `created` for oldest first.","in":"query","name":"sort","required":false,"schema":{"example":"-created","type":"string"}},{"description":"Optional pagination header; must use the **`items`** unit. Example: `items=0-49`.\nEquivalent to setting `limit` and `skip` from the range; do not rely on mixing both in one request without verifying behavior on your Form.io version.\n","in":"header","name":"Range","required":false,"schema":{"example":"items=0-49","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"JSON array of submissions—either the full matching set in one response, or the last page of a paginated request.\n","headers":{"Content-Range":{"description":"May be present when the server reports pagination metadata. Typical shape: `items -/` (unit `items`).\n","schema":{"example":"items 0-9/42","type":"string"}}}},"206":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"Partial list; additional submissions exist. Read `Content-Range`, then request the next window via `skip` / `limit` or a follow-up `Range` header.\n","headers":{"Content-Range":{"description":"Returned slice and total count, e.g. `items 0-9/42`.","required":true,"schema":{"example":"items 0-9/42","type":"string"}}}}},"summary":"Get Form Submissions","tags":["Submission API"]},"post":{"description":"Creates a new submission for the given form alias. Include _fvid to target a specific form revision.","operationId":"createFormSubmission","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Create Form Submission":{"value":{"_fvid":"2","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"}}}},"schema":{"properties":{"_fvid":{"example":"2","type":"string"},"data":{"properties":{"email":{"example":"joe@example.com","type":"string"},"firstName":{"example":"Joe","type":"string"},"lastName":{"example":"Smith","type":"string"},"phoneNumber":{"example":"(123) 123-1234","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"Create Form Revision Submission":{"value":{"_fvid":2,"_id":"662fc7e23d908589b89322e5","access":[],"created":"2024-04-29T16:16:34.219Z","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"},"externalIds":[],"form":"662fc76b3d908589b8931efb","modified":"2024-04-29T16:16:34.220Z","owner":"662fc7483d908589b8931c16","project":"662fc74e3d908589b8931c52","roles":[],"state":"submitted"}},"Create Form Submission":{"value":{"_fvid":1,"_id":"5fc7c4082a992abe68b247b9","_vid":0,"access":[],"created":"2020-12-02T16:42:48.128Z","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"},"externalIds":[],"form":"5fc7c25a2a992abe68b247b4","modified":"2020-12-02T16:42:48.129Z","owner":"5fc7beeb2a992abe68b2475c","project":"5fc7befe2a992abe68b24765","roles":[],"state":"submitted"}},"Create Submission":{"value":{"_id":"57d0a2fd76f943a4007e1529","access":[],"created":"2016-09-07T23:30:05.757Z","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"123123123"},"externalIds":[],"form":"57d0a2f876f943a4007e1527","modified":"2016-09-07T23:30:05.758Z","owner":"57d010fe76f943a4007e11da","roles":[]}}},"schema":{"properties":{"_fvid":{"example":1,"type":"number"},"_id":{"example":"5fc7c4082a992abe68b247b9","type":"string"},"_vid":{"example":0,"type":"number"},"access":{"example":[],"items":{},"type":"array"},"created":{"example":"2020-12-02T16:42:48.128Z","type":"string"},"data":{"properties":{"email":{"example":"joe@example.com","type":"string"},"firstName":{"example":"Joe","type":"string"},"lastName":{"example":"Smith","type":"string"},"phoneNumber":{"example":"(123) 123-1234","type":"string"}},"type":"object"},"externalIds":{"example":[],"items":{},"type":"array"},"form":{"example":"5fc7c25a2a992abe68b247b4","type":"string"},"modified":{"example":"2020-12-02T16:42:48.129Z","type":"string"},"owner":{"example":"5fc7beeb2a992abe68b2475c","type":"string"},"project":{"example":"5fc7befe2a992abe68b24765","type":"string"},"roles":{"example":[],"items":{},"type":"array"},"state":{"example":"submitted","type":"string"}},"type":"object"}}},"description":"Create Form Submission / Create Submission / Create Form Revision Submission"}},"summary":"Create Form Submission","tags":["Submission API"]}},"/migros/forms/v1/{formPath}/submission/{submissionId}":{"get":{"description":"This will retrieve a single submission within a form.","operationId":"getFormSubmissionById","parameters":[{"description":"Form Alias","in":"path","name":"formPath","required":true,"schema":{"example":"AmazingContactForm","type":"string"}},{"description":"Submission Id","in":"path","name":"submissionId","required":true,"schema":{"example":"57d0a2fd76f943a4007e1529","type":"string"}},{"example":"{{token}}","in":"header","name":"x-jwt-token","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"_fvid":1,"_id":"5fc7c4082a992abe68b247b9","_vid":0,"access":[],"created":"2020-12-02T16:42:48.128Z","data":{"email":"joe@example.com","firstName":"Joe","lastName":"Smith","phoneNumber":"(123) 123-1234"},"externalIds":[],"form":"5fc7c25a2a992abe68b247b4","modified":"2020-12-02T16:42:48.129Z","owner":"5fc7beeb2a992abe68b2475c","project":"5fc7befe2a992abe68b24765","roles":[],"state":"submitted"},"schema":{"properties":{"_fvid":{"type":"integer"},"_id":{"type":"string"},"_vid":{"type":"integer"},"access":{"items":{},"type":"array"},"created":{"format":"date-time","type":"string"},"data":{"properties":{"email":{"format":"email","type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"}},"type":"object"},"externalIds":{"items":{},"type":"array"},"form":{"type":"string"},"modified":{"format":"date-time","type":"string"},"owner":{"type":"string"},"project":{"type":"string"},"roles":{"items":{},"type":"array"},"state":{"type":"string"}},"type":"object"}}},"description":"Get a Submission","headers":{"Access-Control-Allow-Origin":{"example":"*","schema":{"type":"string"}},"Access-Control-Expose-Headers":{"example":"x-jwt-token","schema":{"type":"string"}},"Cache-Control":{"example":"no-cache,max-age=0","schema":{"type":"string"}},"Connection":{"example":"keep-alive","schema":{"type":"string"}},"Content-Length":{"example":397,"schema":{"type":"integer"}},"Date":{"example":"Wed, 02 Dec 2020 16:44:35 GMT","schema":{"type":"string"}},"ETag":{"example":"W/\"18d-WTVXer2UdkEDeKfaQMFTYPuR3Ww\"","schema":{"type":"string"}},"Vary":{"example":"Origin","schema":{"type":"string"}},"X-Powered-By":{"example":"Express","schema":{"type":"string"}},"x-jwt-token":{"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjVmYzdiZWViMmE5OTJhYmU2OGIyNDc1YyJ9LCJpc3MiOiJodHRwczovL2FwaS5mb3JtLmlvOjMwMDAiLCJzdWIiOiI1ZmM3YmVlYjJhOTkyYWJlNjhiMjQ3NWMiLCJqdGkiOiI1ZmM3YmVmMjJhOTkyYWJlNjhiMjQ3NjEiLCJmb3JtIjp7Il9pZCI6IjVlZDE4MGYzZDM2MGEyM2FlNTBiMDBkYSIsInByb2plY3QiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwicHJvamVjdCI6eyJfaWQiOiI1ZWQxODBmMmQzNjBhMjNhZTUwYjAwZDYifSwiaWF0IjoxNjA2OTI3NDc1LCJleHAiOjE2MDY5NDE4NzV9.MboJ5cX_nJD_sO76p8HA4bW2NMNHb9uowXJMayfXQNQ","schema":{"type":"string"}}}}},"summary":"Get a Submission","tags":["Submission API"]}}},"servers":[{"url":"https://api-qual.migros.ch"}],"x-company":"migros","x-edm-domain":"enterprise-support","x-headmatter":{"readable_by":"*"},"x-leanIx-Id":"caf73955-ab48-4365-999a-27bb84d0b0be"} ```