Search
K
Formigros QUAL

Get Form by Alias

This will retrieve a form by providing its path alias.

get
https://api-qual.migros.ch/migros/forms/v1/{formPath}

Path Parameters

formPathstringrequired

Form Alias

Example:AmazingContactForm

Response

200 application/json

Get Form by Alias

_idstring

Example:5fc7c25a2a992abe68b247b4

_vidnumber

Example:0

accessarray[object]

Example:[{"roles":["5fc7befe2a992abe68b24766","5fc7befe2a992abe68b24767","5fc7befe2a992abe68b24768"],"type":"read_all"}]

Show Child Parameters
componentsarray[object]
Show Child Parameters
createdstring

Example:2020-12-02T16:35:38.683Z

displaystring

Example:form

machineNamestring

Example:proj366:synthesize

modifiedstring

Example:2020-12-02T16:35:38.687Z

namestring

Example:synthesize

ownerstring

Example:5fc7beeb2a992abe68b2475c

pathstring

Example:iterate

projectstring

Example:5fc7befe2a992abe68b24765

revisionsstring

Example:[ "" ]

submissionAccessarray

Example:[]

tagsarray

Example:[]

titlestring

Example:navigating

typestring

Example:form

get/migros/forms/v1/{formPath}
 
200 application/json

Delete File from Azure Storage

Deletes a file from the configured Azure storage provider.

delete
https://api-qual.migros.ch/migros/forms/v1/integration/{formPath}/storage/azure

Query Parameters

namestringrequired

File name

Example:tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf

keystringrequired

Storage key

Example:tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf

Path Parameters

formPathstringrequired

Form Alias

Example:AmazingContactForm

Response

204

File deleted

delete/migros/forms/v1/integration/{formPath}/storage/azure
 
204

Get Azure Storage Files

This will retrieve the files stored in the configured Azure storage provider.

get
https://api-qual.migros.ch/migros/forms/v1/integration/{formPath}/storage/azure

Path Parameters

formPathstringrequired

Form Alias

Example:AmazingContactForm

Headers

x-jwt-tokenstring

Example:{{token}}

Response

200 application/json

Get Azure Storage Files

object
get/migros/forms/v1/integration/{formPath}/storage/azure
 
200 application/json

Upload File to Azure Storage

Uploads a file through Form.io to the configured Azure storage provider.

post
https://api-qual.migros.ch/migros/forms/v1/integration/{formPath}/storage/azure

Path Parameters

formPathstringrequired

Form Alias

Example:AmazingContactForm

Body

application/json
groupIdstring | null

Optional group id

Example:null

groupPermissionsstring | null

Optional group permissions identifier

Example:null

namestringrequired

File name

Example:tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf

sizeintegerrequired

File size in bytes

Example:12

typestringrequired

MIME type

Example:application/pdf

Response

200

File uploaded

post/migros/forms/v1/integration/{formPath}/storage/azure

Body

{ "groupId": null, "groupPermissions": null, "name": "tmp-6ffe3dac-57e5-459e-8dc7-fd96266b3d8b.pdf", "size": 12, "type": "application/pdf" }
 
200

Get Form Submissions

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.

Extra 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).

Auth: Form.io enforces roles such as the form’s submission viewer permissions using this JWT.

get
https://api-qual.migros.ch/migros/forms/v1/integration/{formPath}/submission

Query Parameters

limitinteger

Maximum submissions to return. Form.io (resourcejs) defaults to 10 when limit, skip, and Range are all omitted.

>= 0

Example:50

skipinteger

Number of submissions to skip (offset before limit).

>= 0

Example:0

sortstring

Mongo-style sort, e.g. -created for newest first, created for oldest first.

Example:-created

Path Parameters

formPathstringrequired

Form Alias

Example:AmazingContactForm

Headers

x-jwt-tokenstringrequired

Form.io JWT token for the signed-in user.

Rangestring

Optional pagination header; must use the items unit. Example: items=0-49.
Equivalent 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.

Example:items=0-49

Response

application/json

JSON array of submissions—either the full matching set in one response, or the last page of a paginated request.

array[object]
get/migros/forms/v1/integration/{formPath}/submission
 
application/json