Jump to

• Request
• Response
• Examples

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: integer
  ID of the form.

Body ()

The request body defines the details of the form data to be created.

Root Schema : FormData

Type: object

Title: FormData

Show Source

• currentStatus(optional): string
  Current status of form submission when submitted through asynchronous submission
• fieldValues(optional): array fieldValues
  A list of key/value pairs identifying the form data (field name / value)
• id(optional): 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(optional): 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(optional): array processingStepErrors
  A list of Processing Step Errors occurred in current form submission. This is a read-only property
• rowId(optional): integer
  In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property
• submittedAt(optional): string
  Unix timestamp for the date and time the form data was submitted. This is a read-only property
• submittedByContactId(optional): string
  ID of the contact that submitted the form. This is a read-only property
• type(optional): string
  The asset's type in Eloqua. This is a read-only property
• validationErrors(optional): array validationErrors
  Validation errors if any occured in form submission. This is a read-only property

{
    "title":"FormData",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property"
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"ID of the form submit if synchronous or ID of the form submission job if async. This is a read-only property"
        },
        "currentStatus":{
            "type":"string",
            "description":"Current status of form submission when submitted through asynchronous submission"
        },
        "submittedAt":{
            "type":"string",
            "description":"Unix timestamp for the date and time the form data was submitted. This is a read-only property"
        },
        "submittedByContactId":{
            "type":"string",
            "description":"ID of the contact that submitted the form. This is a read-only property"
        },
        "fieldValues":{
            "type":"array",
            "description":"A list of key/value pairs identifying the form data (field name / value)",
            "items":{
                "$ref":"#/definitions/FieldValueRest10"
            }
        },
        "processingStepErrors":{
            "type":"array",
            "description":"A list of Processing Step Errors occurred in current form submission. This is a read-only property",
            "items":{
                "$ref":"#/definitions/ProcessingStepErrorRest10"
            }
        },
        "processedAt":{
            "type":"string",
            "description":"Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property"
        },
        "rowId":{
            "type":"integer",
            "description":"In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property"
        },
        "validationErrors":{
            "type":"array",
            "description":"Validation errors if any occured in form submission. This is a read-only property",
            "items":{
                "$ref":"#/definitions/ObjectValidationErrorRest10"
            }
        }
    }
}

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

{
    "type":"array",
    "description":"A list of key/value pairs identifying the form data (field name / value)",
    "items":{
        "$ref":"#/definitions/FieldValueRest10"
    }
}

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

{
    "type":"array",
    "description":"A list of Processing Step Errors occurred in current form submission. This is a read-only property",
    "items":{
        "$ref":"#/definitions/ProcessingStepErrorRest10"
    }
}

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

{
    "type":"array",
    "description":"Validation errors if any occured in form submission. This is a read-only property",
    "items":{
        "$ref":"#/definitions/ObjectValidationErrorRest10"
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        }
    }
}

Nested Schema : ProcessingStepError

Type: object

Title: ProcessingStepError

Show Source

• errorCode(optional): integer
  Unique Error Code for current error
• errorDescription(optional): string
  Detailed information about current error
• errorMessage(optional): string
  Error message for current error code
• processingStepDisplayName(optional): string
  DisplayName of the processing step including description (if configured)
• processingStepId(optional): string
  Processing step id during which error ocurred
• processingStepTypeId(optional): string
  Type of the processing step during which error ocurred
• type(optional): string
  The asset's type in Eloqua.

{
    "title":"ProcessingStepError",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "processingStepId":{
            "type":"string",
            "description":"Processing step id during which error ocurred"
        },
        "processingStepTypeId":{
            "type":"string",
            "description":"Type of the processing step during which error ocurred"
        },
        "processingStepDisplayName":{
            "type":"string",
            "description":"DisplayName of the processing step including description (if configured)"
        },
        "errorCode":{
            "type":"integer",
            "description":"Unique Error Code for current error"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message for current error code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Detailed information about current error"
        }
    }
}

Nested Schema : ObjectValidationError

Type: object

Title: ObjectValidationError

Show Source

• container(optional): object ObjectKey
  Title: ObjectKey
• property(optional): string
• requirement(optional): object Requirement
  Title: Requirement
• type(optional): string
• value(optional): string

{
    "title":"ObjectValidationError",
    "properties":{
        "type":{
            "type":"string"
        },
        "container":{
            "$ref":"#/definitions/ObjectKeyRest10"
        },
        "property":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "requirement":{
            "$ref":"#/definitions/RequirementRest10"
        }
    }
}

Nested Schema : ObjectKey

Type: object

Title: ObjectKey

Show Source

• container(optional): object ObjectKey
  Title: ObjectKey
• objectId(optional): string
• objectType(optional): string
• type(optional): string

{
    "title":"ObjectKey",
    "properties":{
        "type":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "container":{
            "$ref":"#/definitions/ObjectKeyRest10"
        }
    }
}

Nested Schema : Requirement

Type: object

Title: Requirement

Show Source

• type(optional): string

{
    "title":"Requirement",
    "properties":{
        "type":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : FormData

Type: object

Title: FormData

Show Source

• currentStatus(optional): string
  Current status of form submission when submitted through asynchronous submission
• fieldValues(optional): array fieldValues
  A list of key/value pairs identifying the form data (field name / value)
• id(optional): 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(optional): 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(optional): array processingStepErrors
  A list of Processing Step Errors occurred in current form submission. This is a read-only property
• rowId(optional): integer
  In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property
• submittedAt(optional): string
  Unix timestamp for the date and time the form data was submitted. This is a read-only property
• submittedByContactId(optional): string
  ID of the contact that submitted the form. This is a read-only property
• type(optional): string
  The asset's type in Eloqua. This is a read-only property
• validationErrors(optional): array validationErrors
  Validation errors if any occured in form submission. This is a read-only property

{
    "title":"FormData",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property"
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"ID of the form submit if synchronous or ID of the form submission job if async. This is a read-only property"
        },
        "currentStatus":{
            "type":"string",
            "description":"Current status of form submission when submitted through asynchronous submission"
        },
        "submittedAt":{
            "type":"string",
            "description":"Unix timestamp for the date and time the form data was submitted. This is a read-only property"
        },
        "submittedByContactId":{
            "type":"string",
            "description":"ID of the contact that submitted the form. This is a read-only property"
        },
        "fieldValues":{
            "type":"array",
            "description":"A list of key/value pairs identifying the form data (field name / value)",
            "items":{
                "$ref":"#/definitions/FieldValueRest10"
            }
        },
        "processingStepErrors":{
            "type":"array",
            "description":"A list of Processing Step Errors occurred in current form submission. This is a read-only property",
            "items":{
                "$ref":"#/definitions/ProcessingStepErrorRest10"
            }
        },
        "processedAt":{
            "type":"string",
            "description":"Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property"
        },
        "rowId":{
            "type":"integer",
            "description":"In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property"
        },
        "validationErrors":{
            "type":"array",
            "description":"Validation errors if any occured in form submission. This is a read-only property",
            "items":{
                "$ref":"#/definitions/ObjectValidationErrorRest10"
            }
        }
    }
}

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

{
    "type":"array",
    "description":"A list of key/value pairs identifying the form data (field name / value)",
    "items":{
        "$ref":"#/definitions/FieldValueRest10"
    }
}

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

{
    "type":"array",
    "description":"A list of Processing Step Errors occurred in current form submission. This is a read-only property",
    "items":{
        "$ref":"#/definitions/ProcessingStepErrorRest10"
    }
}

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

{
    "type":"array",
    "description":"Validation errors if any occured in form submission. This is a read-only property",
    "items":{
        "$ref":"#/definitions/ObjectValidationErrorRest10"
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        }
    }
}

Nested Schema : ProcessingStepError

Type: object

Title: ProcessingStepError

Show Source

• errorCode(optional): integer
  Unique Error Code for current error
• errorDescription(optional): string
  Detailed information about current error
• errorMessage(optional): string
  Error message for current error code
• processingStepDisplayName(optional): string
  DisplayName of the processing step including description (if configured)
• processingStepId(optional): string
  Processing step id during which error ocurred
• processingStepTypeId(optional): string
  Type of the processing step during which error ocurred
• type(optional): string
  The asset's type in Eloqua.

{
    "title":"ProcessingStepError",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "processingStepId":{
            "type":"string",
            "description":"Processing step id during which error ocurred"
        },
        "processingStepTypeId":{
            "type":"string",
            "description":"Type of the processing step during which error ocurred"
        },
        "processingStepDisplayName":{
            "type":"string",
            "description":"DisplayName of the processing step including description (if configured)"
        },
        "errorCode":{
            "type":"integer",
            "description":"Unique Error Code for current error"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message for current error code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Detailed information about current error"
        }
    }
}

Nested Schema : ObjectValidationError

Type: object

Title: ObjectValidationError

Show Source

• container(optional): object ObjectKey
  Title: ObjectKey
• property(optional): string
• requirement(optional): object Requirement
  Title: Requirement
• type(optional): string
• value(optional): string

{
    "title":"ObjectValidationError",
    "properties":{
        "type":{
            "type":"string"
        },
        "container":{
            "$ref":"#/definitions/ObjectKeyRest10"
        },
        "property":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "requirement":{
            "$ref":"#/definitions/RequirementRest10"
        }
    }
}

Nested Schema : ObjectKey

Type: object

Title: ObjectKey

Show Source

• container(optional): object ObjectKey
  Title: ObjectKey
• objectId(optional): string
• objectType(optional): string
• type(optional): string

{
    "title":"ObjectKey",
    "properties":{
        "type":{
            "type":"string"
        },
        "objectType":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "container":{
            "$ref":"#/definitions/ObjectKeyRest10"
        }
    }
}

Nested Schema : Requirement

Type: object

Title: Requirement

Show Source

• type(optional): string

{
    "title":"Requirement",
    "properties":{
        "type":{
            "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.

Back to Top

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:

The fieldValue 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"
    }
  ]
}
			

Back to Top