REST API for Oracle Eloqua Marketing Cloud Service

Retrieve processed form data for a single form

get

/api/REST/1.0/data/form/{id}

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

Request

Supported Media Types

application/json

Path Parameters

id(required): integer

ID of the form.

Query Parameters

count: integer

Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
endAt: integer

The latest date time for which the request will retrieve data, expressed in Unix time.
page: integer

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.
startAt: integer

The earliest date time for which the request will retrieve data, expressed in Unix time.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : QueryResultFormSubmission

Type: object

Title: QueryResultFormSubmission

Show Source

elements: array elements

Array of form data elements.
page: integer

The specified page.
pageSize: integer

The page size.
total: integer

The total amount of results.
type: string

The asset's type in Eloqua.

{
    "title":"QueryResultFormSubmission",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of form data elements.",
            "items":{
                "$ref":"#/definitions/FormDataRest10"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of form data elements.

Show Source

Array of: object FormData

Title: FormData

{
    "type":"array",
    "description":"Array of form data elements.",
    "items":{
        "$ref":"#/definitions/FormDataRest10"
    }
}

Nested Schema : FormData

Type: object

Title: FormData

Show Source

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

{
    "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: 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.

{
    "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: 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.

{
    "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: object ObjectKey

Title: ObjectKey
property: string
requirement: object Requirement

Title: Requirement
type: string
value: 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: object ObjectKey

Title: ObjectKey
objectId: string
objectType: string
type: 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: 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.

Examples

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


GET /api/REST/1.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"  
    },  
..  
]}