Create form data for a single form
post
/api/REST/1.0/data/form/{id}
Creates form data for the form that matches the criteria specified by the request body. This endpoint will only create form data specified in the request body, including static values in form fields. If a form field contains a static value, the field must be included in the request body to update the static value.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
ID of the form.
The request body defines the details of the form data to be created.
Root Schema : FormData
Type:
object
Title:
Show Source
FormData
-
currentStatus:
string
Current status of form submission when submitted through asynchronous submission
-
fieldValues:
array fieldValues
A list of key/value pairs identifying the form data (field name / value)
-
id:
string
Read Only:
true
ID of the form submit if synchronous or ID of the form submission job if async. This is a read-only property -
processedAt:
string
Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property
-
processingStepErrors:
array processingStepErrors
A list of Processing Step Errors occurred in current form submission. This is a read-only property
-
rowId:
integer
In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property
-
submittedAt:
string
Unix timestamp for the date and time the form data was submitted. This is a read-only property
-
submittedByContactId:
string
ID of the contact that submitted the form. This is a read-only property
-
type:
string
The asset's type in Eloqua. This is a read-only property
-
validationErrors:
array validationErrors
Validation errors if any occured in form submission. This is a read-only property
Nested Schema : fieldValues
Type:
array
A list of key/value pairs identifying the form data (field name / value)
Show Source
-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : processingStepErrors
Type:
array
A list of Processing Step Errors occurred in current form submission. This is a read-only property
Show Source
-
Array of:
object ProcessingStepError
Title:
ProcessingStepError
Nested Schema : validationErrors
Type:
array
Validation errors if any occured in form submission. This is a read-only property
Show Source
-
Array of:
object ObjectValidationError
Title:
ObjectValidationError
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
Nested Schema : ProcessingStepError
Type:
object
Title:
Show Source
ProcessingStepError
-
errorCode:
integer
Unique Error Code for current error
-
errorDescription:
string
Detailed information about current error
-
errorMessage:
string
Error message for current error code
-
processingStepDisplayName:
string
DisplayName of the processing step including description (if configured)
-
processingStepId:
string
Processing step id during which error ocurred
-
processingStepTypeId:
string
Type of the processing step during which error ocurred
-
type:
string
The asset's type in Eloqua.
Nested Schema : ObjectValidationError
Type:
object
Title:
Show Source
ObjectValidationError
-
container:
object ObjectKey
Title:
ObjectKey
-
property:
string
-
requirement:
object Requirement
Title:
Requirement
-
type:
string
-
value:
string
Nested Schema : ObjectKey
Type:
object
Title:
Show Source
ObjectKey
-
container:
object ObjectKey
Title:
ObjectKey
-
objectId:
string
-
objectType:
string
-
type:
string
Response
Supported Media Types
- application/json
201 Response
Success.
Root Schema : FormData
Type:
object
Title:
Show Source
FormData
-
currentStatus:
string
Current status of form submission when submitted through asynchronous submission
-
fieldValues:
array fieldValues
A list of key/value pairs identifying the form data (field name / value)
-
id:
string
Read Only:
true
ID of the form submit if synchronous or ID of the form submission job if async. This is a read-only property -
processedAt:
string
Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property
-
processingStepErrors:
array processingStepErrors
A list of Processing Step Errors occurred in current form submission. This is a read-only property
-
rowId:
integer
In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property
-
submittedAt:
string
Unix timestamp for the date and time the form data was submitted. This is a read-only property
-
submittedByContactId:
string
ID of the contact that submitted the form. This is a read-only property
-
type:
string
The asset's type in Eloqua. This is a read-only property
-
validationErrors:
array validationErrors
Validation errors if any occured in form submission. This is a read-only property
Nested Schema : fieldValues
Type:
array
A list of key/value pairs identifying the form data (field name / value)
Show Source
-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : processingStepErrors
Type:
array
A list of Processing Step Errors occurred in current form submission. This is a read-only property
Show Source
-
Array of:
object ProcessingStepError
Title:
ProcessingStepError
Nested Schema : validationErrors
Type:
array
Validation errors if any occured in form submission. This is a read-only property
Show Source
-
Array of:
object ObjectValidationError
Title:
ObjectValidationError
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
Nested Schema : ProcessingStepError
Type:
object
Title:
Show Source
ProcessingStepError
-
errorCode:
integer
Unique Error Code for current error
-
errorDescription:
string
Detailed information about current error
-
errorMessage:
string
Error message for current error code
-
processingStepDisplayName:
string
DisplayName of the processing step including description (if configured)
-
processingStepId:
string
Processing step id during which error ocurred
-
processingStepTypeId:
string
Type of the processing step during which error ocurred
-
type:
string
The asset's type in Eloqua.
Nested Schema : ObjectValidationError
Type:
object
Title:
Show Source
ObjectValidationError
-
container:
object ObjectKey
Title:
ObjectKey
-
property:
string
-
requirement:
object Requirement
Title:
Requirement
-
type:
string
-
value:
string
Nested Schema : ObjectKey
Type:
object
Title:
Show Source
ObjectKey
-
container:
object ObjectKey
Title:
ObjectKey
-
objectId:
string
-
objectType:
string
-
type:
string
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Create some new form data for the form asset with ID #21:
POST /api/REST/1.0/data/form/21
Content-Type: application/json
Note:
ThefieldValue
IDs must correspond to the "FormField" parameters contained within the parent form asset. To retrieve a list of appropriate field values, you can make a GET
request to /assets/form/{id}
(in this case the ID of the form is 21 and the fieldValue
ID is 3).
Request body:
{
"fieldValues": [
{
"type": "FieldValue",
"id": "3",
"value": "Aquamarine"
}
]
}
Response:
{
"id": "225",
"fieldValues": [
{
"type": "FieldValue",
"id": "3",
"value": "Aquamarine"
}
]
}