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

Retrieve a list of forms

get

/api/rest/2.0/assets/forms

Retrieves all forms that match the criteria specified by the request parameters.

Request

Supported Media Types
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
  • Specifies whether to include archived forms in the results, considered false if not specified.
  • Specifies whether to include unarchived forms in the results, considered true if not specified.
  • The date and time the form was last updated.
  • Specifies the field by which list results are ordered.
  • 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.
  • Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultForm
Type: object
Title: QueryResultForm
Show Source
Nested Schema : elements
Type: array
Array of form elements.
Show Source
Nested Schema : Form
Type: object
Title: Form
Show Source
  • True if form is archived otherwise False. This is a read-only property.
  • Read Only: true
    The date and time the form was created, expressed in Unix time.
  • Read Only: true
    The login ID of the user who created the form.
  • The form's current status. Example: draft, active, or complete.
  • The custom style applied to the form.
  • FormFieldUpdateMapping
    Title: FormFieldUpdateMapping
  • Read Only: true
    Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
  • The description of the form.
  • elements
    Array consisting of form elements.
  • The external integration URL used for integrating external forms.
  • Read Only: true
    The ID of the containing folder.
  • Form metadata in JSON. Applicable only to responsive forms. Not required to be set when creating and updating forms. We recommend omitting this parameter when creating and updating forms, and letting Eloqua set it by default. When creating a form and including this parameter, this must be set to {\"type\":\"responsiveForm\",\"version\":\"1\"}.
  • The asset's raw HTML content.
  • The asset's raw HTML name.
  • Read Only: true
    Id of the form.
  • Indicates whether spam protection is enabled on the form.
  • Whether the form is an internal form. If true, the form is not exposed outside of Eloqua and any form submissions to this form are deleted.
  • Indicates whether the form is responsive. Returns true for a responsive form, false for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property.
  • The name of the form.
  • permissions
    The permissions for the form granted to your current instance. This is a read-only property.
  • processingSteps
    A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
  • A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
  • Read Only: true
    This property is not used.
  • Size
    Title: Size
  • Id of the source template.
  • The asset's main layout style.
  • The landing page ID of the failed submit.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the form was last updated.
  • Read Only: true
    The login ID of the user that last updated the form.
Nested Schema : FormFieldUpdateMapping
Type: object
Title: FormFieldUpdateMapping
Show Source
Nested Schema : elements
Type: array
Array consisting of form elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the form granted to your current instance. This is a read-only property.
Show Source
Nested Schema : processingSteps
Type: array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
Show Source
Nested Schema : Size
Type: object
Title: Size
Show Source
  • The height dimensions of the asset expressed in pixels.
  • The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
  • The width dimensions of the asset expressed in pixels.
Nested Schema : permissions
Type: array
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FormElement
Type: object
Title: FormElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the form element granted to your current instance.
Show Source
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source
Nested Schema : ProcessingStepCondition
Type: object
Title: ProcessingStepCondition
Show Source
Nested Schema : permissions
Type: array
The permissions for the form processing step granted to your current instance.
Show Source
Nested Schema : conditionalFieldCriteria
Type: array
The conditional field criteria for the form processing step condition.
Show Source
Nested Schema : FieldComparisonCriteria
Type: object
Title: FieldComparisonCriteria
Show Source
Nested Schema : Condition
Type: object
Title: Condition
Show Source
  • The asset's type in Eloqua. This is a read-only property.
Nested Schema : permissions
Type: array
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
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 forms using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Examples

Retrieve the first 2 unarchived forms in your database. By default only unarchived forms are returned.


GET /api/REST/2.0/assets/forms?count=2

Response:


{
  "elements": [
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "75",
      "createdAt": "1554748229",
      "createdBy": "52",
      "depth": "minimal",
      "folderId": "4220",
      "name": "Form_Demo",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1586954686",
      "updatedBy": "52",
      "archived": "false",
      "htmlName": "responsiveform-1554748226676",
      "isResponsive": "true"
    },
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "101",
      "createdAt": "1586894543",
      "createdBy": "35",
      "depth": "minimal",
      "folderId": "4124",
      "name": "Form_Demo_2",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1586894551",
      "updatedBy": "35",
      "archived": "false",
      "htmlName": "responsiveform-1586894918064",
      "isResponsive": "true"
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 72
}

Retrieve only archived forms:


GET /api/REST/2.0/assets/forms?includeArchived=true&includeAvailable=false

Response:


{
  "elements": [
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "2",
      "createdAt": "1418404077",
      "createdBy": "5",
      "depth": "minimal",
      "folderId": "4367",
      "name": "Form 01",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1534172012",
      "updatedBy": "9",
      "archived": "true",
      "htmlName": "untitledForm-1418404075886",
      "isResponsive": "false"
    },
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "80",
      "createdAt": "1556620616",
      "createdBy": "35",
      "depth": "minimal",
      "folderId": "4367",
      "name": "Test 1",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1556620616",
      "updatedBy": "35",
      "archived": "true",
      "htmlName": "copyOfClassicForm-1556620603031",
      "isResponsive": "true"
    },
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "97",
      "createdAt": "1586894350",
      "createdBy": "35",
      "depth": "minimal",
      "folderId": "4367",
      "name": "20B Archive Demo",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1586894359",
      "updatedBy": "35",
      "archived": "true",
      "htmlName": "copyOfDemoDesignEditor-1586894724087",
      "isResponsive": "true"
    }
  ],
  "page": 1,
  "pageSize": 1000,
  "total": 3
}

Retrieve both archived and unarchived forms:


GET /api/REST/2.0/assets/forms?includeArchived=true

Response:


{
	"elements": [{
			"type": "Form",
			"currentStatus": "Draft",
			"id": "2",
			"createdAt": "1418404077",
			"createdBy": "5",
			"depth": "minimal",
			"folderId": "4367",
			"name": "Form 01",
			"permissions": [
				"Retrieve",
				"SetSecurity",
				"Delete",
				"Update"
			],
			"updatedAt": "1534172012",
			"updatedBy": "9",
			"archived": "true",
			"htmlName": "untitledForm-1418404075886",
			"isResponsive": "false"
		},
		{
			"type": "Form",
			"currentStatus": "Draft",
			"id": "3",
			"createdAt": "1421850657",
			"createdBy": "5",
			"depth": "minimal",
			"folderId": "4199",
			"name": "test",
			"permissions": [
				"Retrieve",
				"SetSecurity",
				"Delete",
				"Update"
			],
			"updatedAt": "1540913905",
			"updatedBy": "4",
			"archived": "false",
			"htmlName": "form",
			"isResponsive": "false"
		}
		...
	],
	"page": 1,
	"pageSize": 1000,
	"total": 76
}

cURL Examples

Here are the same examples 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/assets/forms?count=2
			

curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/assets/forms?includeArchived=true&includeAvailable=false
			

curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/assets/forms?includeArchived=true
Back to Top