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

Retrieve a list of forms

get

/api/REST/1.0/assets/forms

Retrieves all forms that match the criteria specified by the request parameters. Note: You can also retrieve a list of forms via REST 2.0 by using the endpoint REST/2.0/assets/forms.

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.
  • 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 fields.
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.
  • 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 email address form field entity's unique identifier.
  • The asset's raw HTML content.
  • The asset's raw HTML name.
  • Read Only: true
    Id of the form. This is a read-only property.
  • 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.
  • The name of the form.
  • 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.
  • 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 : elements
Type: array
Array consisting of form elements.
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 : FormElement
Type: object
Title: FormElement
Show Source
  • Read Only: true
    The date and time the form element was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the form element.
  • The form element's current status.
  • 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 element.
  • Read Only: true
    Id of the form element. This is a read-only property.
  • The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
  • Name of the form element.
  • The permissions for the form element granted to your current instance.
  • The asset's main layout style.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the form element was last updated.
  • Read Only: true
    The login id of the user that last updated the form element.
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source
  • The comparator used to validate a condition. Possible values include: exactly or not exactly.
  • The form field id used to compare form fields within a form processing step condition.
  • The type of value the comparator is validating. Possible values include: 'form field' or 'static value'.
  • Read Only: true
    The date and time the form processing step was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the form processing step.
  • The form processing step's current status.
  • 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 processing step.
  • The conditions for which this form processing step will execute. Possible values include: always, conditionally, and never.
  • Read Only: true
    Id of the form processing step. This is a read-only property.
  • The conditions for which the processing step will execute. If yes, the processing step will execute when the conditions are met. If no, the processing step will execute when the conditions are not met.
  • Name of the form processing step.
  • The permissions for the form processing step granted to your current instance.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the form processing step was last updated.
  • Read Only: true
    The login id of the user that last updated the form processing step.

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

Retrieve the first 2 forms in your database:


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

Response:


{
  "elements": [
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "75",
      "createdAt": "1554748229",
      "createdBy": "52",
      "depth": "minimal",
      "folderId": "4220",
      "name": "The Amazing Form!",
      "permissions": "fullControl",
      "updatedAt": "1586954686",
      "updatedBy": "52",
      "archived": "false",
      "htmlName": "responsiveform-1554748226676"
    },
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "101",
      "createdAt": "1586894543",
      "createdBy": "35",
      "depth": "minimal",
      "folderId": "4124",
      "name": "Kiosk Form",
      "permissions": "fullControl",
      "updatedAt": "1586894551",
      "updatedBy": "35",
      "archived": "false",
      "htmlName": "responsiveform-1586894918064"
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 72
}
Back to Top