1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 2.0
  5. Form data

Retrieve processed form data for a single form

get

/api/rest/2.0/data/form/{id}

Retrieves the form data for the form specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • The latest date time for which the request will retrieve data, expressed in Unix time.
  • Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
  • The earliest date time for which the request will retrieve data, expressed in Unix time.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultFormSubmission
Type: object
Title: QueryResultFormSubmission
Show Source
Nested Schema : elements
Type: array
Array of form data elements.
Show Source
Nested Schema : FormData
Type: object
Title: FormData
Show Source
  • The unique identifier of form submission within the batch. Optional String field. If present, must be unique across created batches. If correlationId is not unique, then the entire batch will fail. The correlationId is persisted and could be used to identify the form submit.
  • The current status of the form submission job. Possible values: Queued, InProgress, Error, and Success.
  • fieldValues
    A list of key/value pairs identifying the form data (field name / value)
  • Read Only: true
    The ID of the form submit if synchronous or ID of the form submission job if asynchronous. This is a read-only property
  • Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property
  • processingStepErrors
    A list of Processing Step Errors occurred in current form submission. This is a read-only property
  • In case of an asynchronous form submission if processed then submit ID of form submission. This is a read-only property
  • Unix timestamp for the date and time the form data was submitted. This is a read-only property
  • The ID of the contact that submitted the form. This is a read-only property
  • The asset's type in Eloqua. This is a read-only property
  • 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
Nested Schema : processingStepErrors
Type: array
A list of Processing Step Errors occurred in current form submission. This is a read-only property
Show Source
Nested Schema : validationErrors
Type: array
Validation errors if any occured in form submission. This is a read-only property
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
Show Source
  • Read Only: true
    The id of the field to be set to the corresponding value.
  • Name of the field value.
  • The asset's type in Eloqua. This is a read-only property.
  • The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
Nested Schema : ProcessingStepError
Type: object
Title: ProcessingStepError
Show Source
Nested Schema : ObjectValidationError
Type: object
Title: ObjectValidationError
Show Source
Nested Schema : ObjectKey
Type: object
Title: ObjectKey
Show Source
Nested Schema : Requirement
Type: object
Title: Requirement
Show Source

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

The following examples demonstrate how to retrieve form data using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the form data from the form with ID #18:


GET /api/REST/2.0/data/form/18

Response:


{  
  "elements": [  
    {  
      "type": "FormData",  
      "id": "120666",  
      "fieldValues": [  
        {  
          "type": "FieldValue",  
          "id": "122318",  
          "value": "fred.sakr@eloqua.com"  
        },  
        {  
          "type": "FieldValue",  
          "id": "122319",  
          "value": "Fred"  
        },  
        {  
          "type": "FieldValue",  
          "id": "122320",  
          "value": "Last"  
        },  
        {  
          "type": "FieldValue",  
          "id": "122321",  
          "value": "Eloqua Corp"  
        },  
        {  
          "type": "FieldValue",  
          "id": "122322",  
          "value": "Toronto"  
        },  
        {  
          "type": "FieldValue",  
          "id": "122323"  
        }  
      ],  
      "submittedAt": "1358364307"  
    },  
..  
]}

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3. 


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/data/form/18
Back to Top