/form
1 min
POST
/_form/v1/form
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsonapplication/problem+json
Form Parameters
- formKeystringrequiredMin Length1
- localestring
- isFinalizedboolean
- hostedPageUrlstring
- submissionKeystring
- currentStepinteger<int32>Formatint32
- submittedTimestring<date-time>Formatdate-time
- submittedUserstring
- submissionDatamap<string, string>Default{ "__field_uploadFileKey":"filename.png, filename1.png", "__field_textBoxKey":"sampleText", "__field_dateTimeKey":"01/01/2024" }
- __field_{elementGuid}string[]
- __field_{elementGuid}_file_{fileIndex}string[]
Responses
200
- SubmitFormResult
- successboolean
- submissionKeystring
- validationFailbooleanDefaultfalse
- messagesSubmitFormMessage[]
- sectionstring
- messagestring
- identifierstring
400
403
404
500
curl
curl --request POST \
--url /_form/v1/form \
--header 'accept: application/json' \
--header 'content-type: multipart/form-data' \
--form 'formKey="string"' \
--form 'submissionData="{
\"__field_uploadFileKey\":\"filename.png, filename1.png\",
\"__field_textBoxKey\":\"sampleText\",
\"__field_dateTimeKey\":\"01/01/2024\"
}"'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "multipart/form-data");
var formdata = new FormData();
formdata.append("formKey", "string");
formdata.append("submissionData", "\r\n {\r\n \"__field_uploadFileKey\":\"filename.png, filename1.png\",\r\n \"__field_textBoxKey\":\"sampleText\",\r\n \"__field_dateTimeKey\":\"01/01/2024\"\r\n }\r\n");
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: formdata,
redirect: 'follow'
};
fetch("/_form/v1/form", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "net/http"
url = URI("/_form/v1/form")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "multipart/form-data"
form_data = [['formKey', File.open('undefined')],['submissionData', File.open('undefined')]]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body
python
import requests
url = "/_form/v1/form"
payload = {}
files=[
]
headers = {
'accept': 'application/json',
'content-type': 'multipart/form-data'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
200
// Success
{
"success": false,
"submissionKey": "",
"validationFail": false,
"messages": [
{
"section": "",
"message": "",
"identifier": ""
}
]
}400
// Bad Request
403
// Forbidden
404
// Not Found
500
// Internal Server Error