Retrieve all form submit jobs for a single form
get
/api/rest/2.0/data/form/{formId}/formData
Retrieves all asynchronous form submissions for a form specified by the
formId
.Request
Supported Media Types
- application/json
Path Parameters
-
formId(required): string
The ID of the form
Query Parameters
-
count: string
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
page: string
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.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
-
startAt: integer
The earliest date time for which the request will retrieve data, expressed in Unix time.
Response
Supported Media Types
- application/json
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
The following examples demonstrate how to retrieve asynchronous form submission data for a form using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve the statuses of asynchronous form submission for the form with ID #5:
GET /api/REST/2.0/data/form/5/formData
Response:
{
"elements": [
{
"currentStatus": "Success",
"id": "4",
"fieldValues": [
{
"type": "FieldValue",
"id": "14",
"value": "Aquamarine"
},
{
"type": "FieldValue",
"id": "84",
"value": ""
},
{
"type": "FieldValue",
"id": "17",
"value": ""
},
{
"type": "FieldValue",
"id": "88",
"value": ""
},
{
"type": "FieldValue",
"id": "15",
"value": ""
},
{
"type": "FieldValue",
"id": "68",
"value": ""
},
{
"type": "FieldValue",
"id": "85",
"value": ""
},
{
"type": "FieldValue",
"id": "16",
"value": ""
},
{
"type": "FieldValue",
"id": "82",
"value": ""
},
{
"type": "FieldValue",
"id": "86",
"value": ""
},
{
"type": "FieldValue",
"id": "83",
"value": ""
},
{
"type": "FieldValue",
"id": "87",
"value": ""
}
],
"submittedAt": "1555076161",
"processedAt": "1555076165",
"rowId": 243
},
{
"currentStatus": "Success",
"id": "3",
"fieldValues": [
{
"type": "FieldValue",
"id": "14",
"value": "Aquamarine"
},
{
"type": "FieldValue",
"id": "84",
"value": ""
},
{
"type": "FieldValue",
"id": "17",
"value": ""
},
{
"type": "FieldValue",
"id": "88",
"value": ""
},
{
"type": "FieldValue",
"id": "15",
"value": ""
},
{
"type": "FieldValue",
"id": "68",
"value": ""
},
{
"type": "FieldValue",
"id": "85",
"value": ""
},
{
"type": "FieldValue",
"id": "16",
"value": ""
},
{
"type": "FieldValue",
"id": "82",
"value": ""
},
{
"type": "FieldValue",
"id": "86",
"value": ""
},
{
"type": "FieldValue",
"id": "83",
"value": ""
},
{
"type": "FieldValue",
"id": "87",
"value": ""
}
],
"submittedAt": "1555075601",
"processedAt": "1555075767",
"rowId": 241
},
{
"currentStatus": "Success",
"id": "2",
"fieldValues": [
{
"type": "FieldValue",
"id": "14",
"value": "Aquamarine"
},
{
"type": "FieldValue",
"id": "84",
"value": ""
},
{
"type": "FieldValue",
"id": "17",
"value": ""
},
{
"type": "FieldValue",
"id": "88",
"value": ""
},
{
"type": "FieldValue",
"id": "15",
"value": ""
},
{
"type": "FieldValue",
"id": "68",
"value": ""
},
{
"type": "FieldValue",
"id": "85",
"value": ""
},
{
"type": "FieldValue",
"id": "16",
"value": ""
},
{
"type": "FieldValue",
"id": "82",
"value": ""
},
{
"type": "FieldValue",
"id": "86",
"value": ""
},
{
"type": "FieldValue",
"id": "83",
"value": ""
},
{
"type": "FieldValue",
"id": "87",
"value": ""
}
],
"submittedAt": "1555075589",
"processedAt": "1555075767",
"rowId": 240
},
{
"currentStatus": "Success",
"id": "1",
"fieldValues": [
{
"type": "FieldValue",
"id": "14",
"value": "Aquamarine"
},
{
"type": "FieldValue",
"id": "84",
"value": ""
},
{
"type": "FieldValue",
"id": "17",
"value": ""
},
{
"type": "FieldValue",
"id": "88",
"value": ""
},
{
"type": "FieldValue",
"id": "15",
"value": ""
},
{
"type": "FieldValue",
"id": "68",
"value": ""
},
{
"type": "FieldValue",
"id": "85",
"value": ""
},
{
"type": "FieldValue",
"id": "16",
"value": ""
},
{
"type": "FieldValue",
"id": "82",
"value": ""
},
{
"type": "FieldValue",
"id": "86",
"value": ""
},
{
"type": "FieldValue",
"id": "83",
"value": ""
},
{
"type": "FieldValue",
"id": "87",
"value": ""
}
],
"submittedAt": "1555075497",
"processedAt": "1555075767",
"rowId": 242
}
],
"page": 1,
"pageSize": 1000,
"total": 4
}
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/5/formData