Overview
Configuration is provided for establishing connections with Oracle Eloqua service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Oracle Eloqua REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Oracle Eloqua. Set [pod] to the desired pod in the Server host parameter.
Step 3. Then provide Company Username and Password in the grid below for the parameters Company, Username and Password. Then Click "Test Connection" to test your connection.
Step 4. Congratulations! You have now established a connection to your Oracle Eloqua instance.
In this guide, we will show how to read data from the Oracle Eloqua service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Oracle Eloqua connection from the combo. Select from available Oracle Eloqua resources listed in the second combo below.
You can include extra parameters in the grid below if needed or required.
For optional filter parameter please review the KB-Article that can be found here at https://desk.cozyroc.com/portal/en/kb/articles/oracle-eloqua-filter-parameter-for-export-and-import-definition
Step 4. Click on the "Columns tab" and select Oracle Eloqua resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Oracle Eloqua service.
In this guide, we will show how to write data to the Oracle Eloqua service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Oracle Eloqua connection from the combo. Also, select resource action and Oracle Eloqua resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Oracle Eloqua resource.
Configuration
Base URL address: https://secure.[pod].eloqua.com.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Company:
- Username:
- Password:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Company + '\\' + connection.user.Username + ':' + connection.user.Password)}}
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/Developers/GettingStarted/Authentication/authenticate-using-basic-auth.htm.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300)}}.The authentication has the following user-defined parameters:
- client_id: Required. Specify the client identifier of the application.
- client_secret: Required. Specify the client secret of the application.
- Scope:
- redirect_uri: Required. Specify the recirect uri of the application.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/Developers/GettingStarted/Authentication/authenticate-using-oauth.htm.
Based on resource template Base.
- [Read contact] action
-
Endpoint URL address:
/data/contact/{{=parameters.contact_id}}/membership.
The result is paginated.The action has the following user-defined parameters:
- contact_id: Required. Please specify the contact identifier..
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-contact-id-membership-get.html.
- [Read account] action
-
Endpoint URL address:
/data/account/{{=parameters.account_id}}/membership.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Please specify the account identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-account-id-membership-get.html.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- type
Template: ShortText.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/accounts/lists.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-lists-get.html.
- [Read single] action
-
Endpoint URL address:
/accounts/lists/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify list identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-lists-id-get.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=item.uri.split('/')[3]}}expression.- name
Template: ShortText.
- count
Data type: DT_I4
- statement
Template: ShortText.
- uri
Template: ShortText.
- createdBy
Template: ShortText. A read-only field.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/accounts/syncActions.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-syncactions-get.html.
- [Read single] action
-
Endpoint URL address:
/accounts/syncActions/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify sync action identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-syncactions-id-get.html.
- [Create] action
-
Endpoint URL address:
/accounts/syncActions.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-syncactions-post.html.
- [Update] action
-
Endpoint URL address:
/accounts/syncActions/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-syncactions-id-put.html.
- [Delete] action
-
Endpoint URL address:
/accounts/syncActions/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-syncactions-id-delete.html.
The resource includes the fields from the GeneralSyncActionT template.
Based on resource template BulkEntity.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/contacts/lists.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-lists-get.html.
- [Read single] action
-
Endpoint URL address:
/contacts/lists/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify list identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-lists-id-get.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=item.uri.split('/')[3]}}expression.- name
Template: ShortText.
- count
Data type: DT_I4 A read-only field.
- statement
Template: ShortText.
- uri
Template: ShortText.
- createdBy
Template: ShortText. A read-only field.
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/contacts/syncActions.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-syncactions-get.html.
- [Read single] action
-
Endpoint URL address:
/contacts/syncActions/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify sync action identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-syncactions-id-get.html.
- [Create] action
-
Endpoint URL address:
/contacts/syncActions.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-syncactions-post.html.
- [Update] action
-
Endpoint URL address:
/contacts/syncActions/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-syncactions-id-put.html.
- [Delete] action
-
Endpoint URL address:
/contacts/syncActions/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-syncactions-id-delete.html.
The resource includes the fields from the GeneralSyncActionT template.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/customObjects.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-get.html.
- [Read single] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- parentId: Required. Please specify custom object parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-get.html.
The resource includes the fields from the CustomObjectT template.
Based on resource template Bulk.
- [Read] action
-
The result is extracted from:{{=Eloqua.exportData(resource, parameters, Eloqua.UI.CustomObjectEditor.getValue(parameters))}}.
The result is paginated.The action has the following user-defined parameters:
- entity_id: Required. Specify custom object identifier.
- filter: Optional. Specify to filter the export.For more details about syntax visit https://desk.cozyroc.com/portal/en/kb/articles/oracle-eloqua-filter-parameter-for-export-and-import-definition
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-exports-post.html.
- [Create] action
-
Endpoint URL address:
.
The result is extracted from:{{=Eloqua.importData(resource, batch, parameters, Eloqua.UI.CustomObjectEditor.getValue(parameters))}}.The action has the following user-defined parameters:
- entity_id: Required. Specify custom object identifier.
- identifierFieldName: Required. Specify the identifierFieldName.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-imports-post.html.
- [External]
-
The external fields URL address:
/{{=Eloqua.getEntityFromResource(resource) + '/' + Eloqua.UI.CustomObjectEditor.getValue(parameters)}}/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.name}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/syncActions.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- parentId: Required. Please specify parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-syncactions-get.html.
- [Read single] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/syncActions/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- parentId: Required. Please specify parent identifier.
- id: Required. Please specify sync action identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-syncactions-id-get.html.
- [Create] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/syncActions.The action has the following user-defined parameters:
- parentId: Required. Please specify parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-syncactions-post.html.
- [Update] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/syncActions/{{=item.id}}.The action has the following user-defined parameters:
- parentId: Required. Please specify parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-syncactions-id-put.html.
- [Delete] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/syncActions/{{=item.id}}.The action has the following user-defined parameters:
- parentId: Required. Please specify parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-syncactions-id-delete.html.
The resource includes the fields from the GeneralSyncActionT template.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/syncActions.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-syncactions-get.html.
The resource includes the fields from the GeneralSyncActionT template.
Based on resource template BulkEntity.
Based on resource template BulkEntity.
Based on resource template BulkEntity.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/events.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-events-get.html.
- [Read single] action
-
Endpoint URL address:
/events/{{=parameters.parentId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- parentId: Required. Please specify custom object parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-events-id-get.html.
The resource includes the fields from the CustomObjectT template.
Based on resource template Bulk.
- [Read] action
-
The result is extracted from:{{=Eloqua.exportData(resource, parameters, Eloqua.UI.EventEditor.getValue(parameters))}}.
The result is paginated.The action has the following user-defined parameters:
- entity_id: Required. Specify event identifier.
- filter: Optional. Specify to filter the export.For more details about syntax visit https://desk.cozyroc.com/portal/en/kb/articles/oracle-eloqua-filter-parameter-for-export-and-import-definition
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-events-parentid-exports-post.html.
- [Create] action
-
Endpoint URL address:
.
The result is extracted from:{{=Eloqua.importData(resource, batch, parameters, Eloqua.UI.EventEditor.getValue(parameters))}}.The action has the following user-defined parameters:
- entity_id: Required. Specify custom object identifier.
- identifierFieldName: Required. Specify the identifierFieldName.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-events-parentid-imports-post.html.
- [External]
-
The external fields URL address:
/{{=Eloqua.getEntityFromResource(resource) + '/' + Eloqua.UI.EventEditor.getValue(parameters)}}/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.name}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}.
Based on resource template Bulk.
- [Read account] action
-
Endpoint URL address:
/accounts/fields.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-fields-get.html.
- [Read contact] action
-
Endpoint URL address:
/contacts/fields.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-fields-get.html.
- [Read activity] action
-
Endpoint URL address:
/activities/fields.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-activities-fields-get.html.
- [Read campaignResponse] action
-
Endpoint URL address:
/campaignResponses/fields.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-campaignresponses-fields-get.html.
- [Read opportunity] action
-
Endpoint URL address:
/opportunities/fields.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-opportunities-fields-get.html.
- [Read customObject] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/fields.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- parentId: Required. Specify the parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-fields-get.html.
- [Read event] action
-
Endpoint URL address:
/events/{{=parameters.parentId}}/fields.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- parentId: Required. Specify the parent identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-events-id-fields-get.html.
- [Read account single] action
-
Endpoint URL address:
/accounts/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-accounts-fields-id-get.html.
- [Read contact single] action
-
Endpoint URL address:
/contacts/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-contacts-fields-id-get.html.
- [Read activity single] action
-
Endpoint URL address:
/activities/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-activities-exports-id-get.html.
- [Read opportunity single] action
-
Endpoint URL address:
/opportunities/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-opportunities-fields-id-get.html.
- [Read campaignResponse single] action
-
Endpoint URL address:
/campaignResponses/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-campaignresponses-fields-id-get.html.
- [Read event single] action
-
Endpoint URL address:
/events/{{=parameters.parentId}}/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- parentId: Required. Specify the parent identifier.
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-events-parentid-fields-id-get.html.
- [Read customObject single] action
-
Endpoint URL address:
/customObjects/{{=parameters.parentId}}/fields/{{=parameters.fieldId}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- parentId: Required. Specify the parent identifier.
- fieldId: Required. Specify the field identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-customobjects-parentid-imports-id-get.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=item.uri.split('/')[3]}}expression.- name
Template: ShortText.
- internalName
Template: ShortText.
- dataType
Template: ShortText.
- hasReadOnlyConstraint
Data type: DT_BOOL
- hasNotNullConstraint
Data type: DT_BOOL
- hasUniquenessConstraint
Data type: DT_BOOL
- statement
Template: ShortText.
- uri
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/account/groups.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-account-groups-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/account/group/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify account group identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-account-groups-get.html.
- [Create] action
-
Endpoint URL address:
/assets/account/group.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-account-group-post.html.
- [Update] action
-
Endpoint URL address:
/assets/account/group/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-account-group-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/account/group/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-account-group-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- depth
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- count
Data type: DT_I4 A read-only field.
- isArchived
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/contact/segments.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-contact-segments-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/contact/segment/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify contact segment identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-contact-segment-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/contact/segment.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-contact-segment-post.html.
- [Update] action
-
Endpoint URL address:
/assets/contact/segment/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-contact-segment-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/contact/segment/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-account-group-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- depth
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- currentStatus
Template: ShortText.
- description
Template: LongText.
- count
Data type: DT_I4 A read-only field.
- createdBy
Template: ShortText. A read-only field.
- isStale
Data type: DT_BOOL
- accessedAt
Template: UnixTime. A read-only field.
- lastCalculatedAt
Template: UnixTime. A read-only field.
- scheduledFor
Template: ShortText.
- sourceTemplateId
Data type: DT_I8
- element
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/data/eventRegistration/{{=Eloqua.UI.EventEditor.getValue(parameters)}}/instances.
The result is extracted from:{{=response.elements}}.The action has the following user-defined parameters:
- entity_id: Required. Specify entity identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-eventregistration-parentid-instances-get.html.
- [Read single] action
-
Endpoint URL address:
/data/eventRegistration/{{=Eloqua.UI.EventEditor.getValue(parameters)}}/instances/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- entity_id: Required. Specify entity identifier.
- id: Required. Specify parentId identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-eventregistration-parentid-instance-id-get.html.
- [Create] action
-
Endpoint URL address:
/data/eventRegistration/{{=Eloqua.UI.EventEditor.getValue(parameters)}}/instances.The action has the following user-defined parameters:
- entity_id: Required. Specify entity identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-eventregistration-parentid-instance-post.html.
- [Update] action
-
Endpoint URL address:
/data/eventRegistration/{{=Eloqua.UI.EventEditor.getValue(parameters)}}/instances/{{=item.id}}.The action has the following user-defined parameters:
- entity_id: Required. Specify entity identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-eventregistration-parentid-instance-id-put.html.
- [Delete] action
-
Endpoint URL address:
/data/eventRegistration/{{=Eloqua.UI.EventEditor.getValue(parameters)}}/instances/{{=item.id}}.The action has the following user-defined parameters:
- entity_id: Required. Specify entity identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-eventregistration-parentid-instance-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- name
Template: ShortText.
- updatedAt
Template: UnixTime. A read-only field.
- fieldValues
Field components:
- An array.
-
Uses template:
FieldValueT.
- isMapped
Template: ShortText.
- uniqueCode
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/emails.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-emails-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/email/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify email identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-email-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/email.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-email-post.html.
- [Update] action
-
Endpoint URL address:
/assets/email/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-email-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/email/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-email-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- currentStatus
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- accessedAt
Template: UnixTime. A read-only field.
- depth
Template: ShortText.
- folderId
Data type: DT_I4
- brandId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- archive
Data type: DT_BOOL
- bounceBackEmail
Template: ShortText.
- contentSections
Template: LongText. A composite field.
- attachments
Field components:
- An array.
-
Uses template:
GeneralT.
- dynamicContents
Template: LongText. A composite field.
- emailFooterId
Template: ShortText.
- emailGroupId
Template: ShortText.
- description
Template: ShortText.
- emailHeaderId
Template: ShortText.
- encodingId
Template: ShortText.
- fieldMerges
Field components:
- An array.
-
Uses template:
GeneralT.
- files
Field components:
- An array.
-
Uses template:
GeneralT.
- forms
Field components:
- An array.
-
Uses template:
GeneralT.
- htmlContent
Field components:
-
Uses template:
ShortText. - Contains the following components: type, contentSource, docType, htmlBody, metaTags, systemHeader, root.
-
Uses template:
- hyperlinks
Field components:
- An array.
-
Uses template:
GeneralT.
- images
Field components:
- An array.
-
Uses template:
GeneralT.
- isContentProtected
Template: ShortText.
- isPlainTextEditable
Template: ShortText.
- isPrivate
Template: ShortText.
- isTracked
Template: ShortText.
- layout
Template: ShortText.
- plainText
Template: ShortText.
- renderMode
Template: ShortText.
- replyToEmail
Template: ShortText.
- replyToName
Template: ShortText.
- sendPlainTextOnly
Template: ShortText.
- senderEmail
Template: ShortText.
- senderName
Template: ShortText.
- style
Template: ShortText.
- subject
Template: ShortText.
- virtualMTAId
Template: ShortText.
- sourceTemplateId
Template: ShortText.
- scheduledFor
Template: ShortText.
- previewText
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: archive, unarchive.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/emailGroups.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-emailgroups-get.html.
- [Read single] action
-
Endpoint URL address:
/emailGroups/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify email group identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-emailgroups-id-get.html.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- statement
Template: ShortText.
- createdBy
Template: ShortText. A read-only field.
- createdAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- updatedAt
Template: UnixTime. A read-only field.
- uri
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/externals.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-externals-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/external/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify external asset identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/externals.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-post.html.
- [Update] action
-
Endpoint URL address:
/assets/external/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/external/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-id-put.html.
- id
A key field. Data type: DT_I4
- accessedAt
Template: UnixTime. A read-only field.
- createdAt
Template: UnixTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- currentStatus
Template: ShortText.
- depth
Template: ShortText.
- description
Template: ShortText.
- externalAssetTypeId
Template: ShortText.
- folderId
Template: ShortText.
- name
Template: ShortText.
- scheduledFor
Template: ShortText.
- sourceTemplateId
Template: ShortText.
- type
Template: ShortText.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/external/types.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-types-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/external/type/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify external asset type identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/external/types.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-type-post.html.
- [Update] action
-
Endpoint URL address:
/assets/external/type/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-type-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/external/type/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-external-type-id-delete.html.
- id
A key field. Data type: DT_I4
- accessedAt
Template: UnixTime. A read-only field.
- activityTypes
Template: LongText. A composite field.
- createdAt
Template: UnixTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- currentStatus
Template: ShortText.
- depth
Template: ShortText.
- description
Template: ShortText.
- folderId
Template: ShortText.
- image
Template: LongText. A composite field.
- name
Template: ShortText.
- scheduledFor
Template: ShortText.
- sourceTemplateId
Template: ShortText.
- type
Template: ShortText.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/forms.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-forms-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/form/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify form identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-form-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/form.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-form-post.html.
- [Update] action
-
Endpoint URL address:
/assets/form/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-form-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/form/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-form-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- currentStatus
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- depth
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- archived
Template: ShortText.
- htmlName
Template: ShortText.
- isResponsive
Data type: DT_BOOL
- customCSS
Data type: DT_WSTR ( length 4000 )
- defaultKeyFieldMapping
Field components:
-
Uses template:
ShortText. - Contains the following components: type, sourceFormFieldId, targetEntityFieldId.
-
Uses template:
- elements
Field components:
- An array.
- Contains the following components: id, type, depth, name, instructions, style.
- formJson
Template: ShortText.
- isHidden
Data type: DT_BOOL
- processingSteps
Field components:
- An array.
- Contains the following components: type, id, name, execute, keyFieldId, mappings.
- processingType
Template: ShortText.
- size
Template: SizeT.
- style
Template: ShortText.
- submitFailedLandingPageId
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: archive, unarchive.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}.
The result is extracted from:{{=Eloqua.getFormData(resource.getFields(parameters), response.elements)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-id-get.html.
- [Read job] action
-
Endpoint URL address:
/assets/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}/formData/{{=parameters.job_id}}.
The result is extracted from:{{=Eloqua.getFormData(resource.getFields(parameters), [response])}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
- job_id: Required. Specify form submit job identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-formid-formdata-formsubmitjobid-get.html.
- [Read asynchronous] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}/formData.
The result is extracted from:{{=Eloqua.getFormData(resource.getFields(parameters), response.elements)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-formid-formdata-get.html.
- [Read spam] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}/formSpamData.
The result is extracted from:{{=Eloqua.getFormData(resource.getFields(parameters), response.elements)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-formid-formspamdata-get.html.
- [Read correlation] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}/batchCorrelation/formData/{{=parameters.correlation_id}}}.
The result is extracted from:{{=Eloqua.getFormData(resource.getFields(parameters), response.elements)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
- correlation_id: Required. Specify batch correlation identiifer.
- [Read batch] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}/batch/formData/{{=parameters.batch_id}}.
The result is extracted from:{{=Eloqua.getFormData(resource.getFields(parameters), response.elements)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
- batch_id: Requied. Specify batch identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-formid-batch-formdata-batchid-get.html.
- [Create] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-id-post.html.
- [Delete] action
-
Endpoint URL address:
/data/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}/datarow/{{=item.rowId}}.The action has the following user-defined parameters:
- form_id: Required. Specify form identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-form-id-datarow-rowid-delete.html.
- id
Template: ShortText.
- rowId
A key field. Data type: DT_I4
- type
Template: ShortText. A read-only field.
- correlationId
Template: ShortText.
- currentStatus
Template: ShortText. A read-only field.
- callbackUrl
Template: ShortText.
- currentBatchStatus
Template: ShortText.
- depth
Template: ShortText.
- fieldValues
Field components:
- An array.
-
Uses template:
FieldValueT.
- submittedAt
Template: UnixTime. A read-only field.
- submittedByContactId
Template: ShortText. A read-only field.
- validationErrors
A read-only field. Field components:
- An array.
- Contains the following components: container, property, requirement, type, value.
- processedAt
Template: UnixTime. A read-only field.
- processingStatus
Template: ShortText. A read-only field.
- processingStepErrors
A read-only field. Field components:
- An array.
-
Uses template:
ProcessingError.
- blockReason
Template: ShortText. A read-only field.
- formSubmissionSource
Template: ShortText. A read-only field.
- [External]
-
The external fields URL address:
/assets/form/{{=Eloqua.UI.FormEditor.getValue(parameters)}}. The external fields list is extracted from:{{=response.elements}}.- data.{{=external.name}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}. Before setting, the value is processed with
{{={ id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/landingPages.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-landingpages-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/landingPage/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify landing page identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-landingpage-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/landingPage.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-landingpage-post.html.
- [Update] action
-
Endpoint URL address:
/assets/landingPage/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-landingpage-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/landingPage/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-landingpage-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- currentStatus
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- depth
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- contentSections
Template: LongText. A composite field.
- deployedAt
Template: UnixTime. A read-only field.
- dynamicContents
Template: LongText. A composite field.
- excludeFromAuthentication
Template: ShortText.
- htmlContent
Field components:
-
Uses template:
ShortText. - Contains the following components: type, contentSource, html.
-
Uses template:
- hyperlinks
Field components:
- An array.
- Contains the following components: type, id, name, href.
- images
Field components:
- An array.
- Contains the following components: type, currentStatus, id, name, fullImageUrl.
- isContentProtected
Data type: DT_BOOL
- isHidden
Data type: DT_BOOL
- layout
Template: ShortText.
- micrositeId
Data type: DT_I4
- refreshedAt
Template: UnixTime. A read-only field.
- relativePath
Template: ShortText.
- style
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/programs.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-programs-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/program/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify program identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-program-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/program.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-program-post.html.
- [Update] action
-
Endpoint URL address:
/assets/program/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-program-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/program/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-program-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- currentStatus
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- depth
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- updatedAt
Template: UnixTime. A read-only field.
- elements
Field components:
- An array.
- Contains the following components: type, id, name, memberCount, position.
- isReadOnly
Data type: DT_BOOL
- defaultEntityType
Template: ShortText.
- isMemberAllowedDuplicates
Data type: DT_BOOL
- action
Template: ShortText. Field components:
- Contains the following components: activate, deactivate, pause.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/system/security/groups.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-security-groups-get.html.
- [Create] action
-
Endpoint URL address:
/assets/program.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{= { patchMethod: 'add', user: { id: item.userId } } }}
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-security-group-id-users-patch.html.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/assets/program.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{= { patchMethod: 'remove', user: { id: item.userId } } }}
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-security-group-id-users-patch.html.
-
application/json:
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- depth
Template: ShortText.
- description
Template: LongText.
- name
Template: ShortText.
- updatedAt
Template: UnixTime. A read-only field.
- acronym
Template: ShortText.
- isEffective
Data type: DT_BOOL
- isReadOnly
Data type: DT_BOOL
- userId
Data type: DT_I4
- users
A read-only field. The value is gathered from
/system/security/group/{{=item.id}}/usersaddress. The gathered value is processed with{{=response.elements}}expression. Field components:- An array.
- Contains the following components: type, user.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/system/users.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-users-get.html.
- [Read single] action
-
Endpoint URL address:
/system/user/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify user identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-user-id-get.html.
- [Read current] action
-
Endpoint URL address:
/system/user/current.
The result is extracted from:{{=[response]}}.
The result is paginated.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-user-current-get.html.
- [Create] action
-
Endpoint URL address:
/system/user.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-user-post.html.
- [Update] action
-
Endpoint URL address:
/system/user/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-user-id-put.html.
- [Delete] action
-
Endpoint URL address:
/system/user/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-system-user-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- depth
Template: ShortText.
- description
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- address1
Template: ShortText.
- address2
Template: ShortText.
- betaAccess
Template: LongText. A composite field.
- capabilities
Template: LongText. A composite field.
- cellPhone
Template: ShortText.
- city
Template: ShortText.
- companyDisplayName
Template: ShortText.
- companyUrl
Template: ShortText.
- country
Template: ShortText.
- crmUserNames
Field components:
-
Uses template:
ShortText. - Contains the following components: type, MSDUserName, OSCUserName, SFDCUserName, SODUserName.
-
Uses template:
- crmUsername
Template: ShortText.
- defaultAccountViewId
Data type: DT_I4
- defaultContactViewId
Data type: DT_I4
- department
Template: ShortText.
- digitalSignatureId
Data type: DT_I4
- emailAddress
Template: ShortText.
- fax
Template: ShortText.
- federationId
Data type: DT_I4
- firstName
Template: ShortText.
- interfacePermissions
Field components:
- An array.
- Contains the following components: type, interfaceCode, nestedInterfacePermissions.
- isDisabled
Data type: DT_BOOL
- isUsingBrightenTemplate
Template: ShortText.
- jobTitle
Template: ShortText.
- lastName
Template: ShortText.
- loginName
Template: ShortText.
- passwordExpires
Template: ShortText.
- personalMessage
Template: ShortText.
- personalPhotoId
Data type: DT_I4
- personalUrl
Template: ShortText.
- phone
Template: ShortText.
- preferences
Field components:
-
Uses template:
ShortText. - Contains the following components: type, timezoneId.
-
Uses template:
- productPermissions
Field components:
- An array.
- Contains the following components: type, productCode.
- replyToAddress
Template: ShortText.
- securityGroups
Field components:
- An array.
- Contains the following components: id, type, createdAt, depth, name, updatedAt, acronym, isEffective, isReadOnly.
- senderDisplayName
Template: ShortText.
- senderEmailAddress
Template: ShortText.
- ssoOnly
Template: ShortText.
- state
Template: ShortText.
- typePermissions
Field components:
- An array.
- Contains the following components: type, objectType, permissions.
- zipCode
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: enableORdisable, updateUserPassword.
-
Uses template:
- [External]
-
The external fields URL address:
{{=new Uri(connection.serverHost).authority()}}/api/bulk/2.0/users/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.internalName}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/data/visitors.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-visitors-get.html.
- [Read ids] action
-
Endpoint URL address:
/data/visitors.
The result is extracted from:{{=response.elements}}.
The action uses POST method.The action has the following user-defined parameters:
- ids: Required. Specify comma (,) delimited list of visitor GUID.
The following request parameters will be automatically processed:
-
application/json:
{{={ externalIds: parameters.ids.split(',') } }}
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-data-visitors-post.html.
- visitorId
A key field. Template: ShortText.
- type
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- V_IPAddress
Template: ShortText.
- V_LastVisitDateAndTime
Template: ShortText. A read-only field.
- externalId
Template: ShortText.
- currentStatus
Template: ShortText.
- [External]
-
The external fields URL address:
/assets/visitor/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.internalName}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/assets/campaigns.
The result is extracted from:{{=response.elements}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-campaigns-get.html.
- [Read single] action
-
Endpoint URL address:
/assets/campaign/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify campaign identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-campaign-id-get.html.
- [Create] action
-
Endpoint URL address:
/assets/campaign.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-campaign-post.html.
- [Update] action
-
Endpoint URL address:
/assets/campaign/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-campaign-id-put.html.
- [Delete] action
-
Endpoint URL address:
/assets/campaign/{{=item.id}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-rest-2.0-assets-campaign-id-delete.html.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- currentStatus
Template: ShortText.
- createdAt
Template: UnixTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- depth
Template: ShortText.
- description
Template: ShortText.
- folderId
Data type: DT_I4
- name
Template: ShortText.
- permissions
Template: LongText. A composite field.
- sourceTemplateId
Data type: DT_I8
- updatedAt
Template: UnixTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- elements
Field components:
- An array.
- Contains the following components: type, id, name, memberCount, outputTerminals, position, isFinished, isRecurring.
- isReadOnly
Data type: DT_BOOL
- actualCost
Data type: DT_R8
- budgetedCost
Data type: DT_R8
- campaignCategory
Template: ShortText.
- campaignType
Template: ShortText.
- fieldValues
Field components:
- An array.
-
Uses template:
FieldValueT.
- isEmailMarketingCampaign
Data type: DT_BOOL
- isIncludedInROI
Data type: DT_BOOL
- isMemberAllowedReEntry
Data type: DT_BOOL
- isSyncedWithCRM
Data type: DT_BOOL
- product
Template: ShortText.
- region
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: activate, deactivate.
- [External]
-
The external fields URL address:
/assets/campaign/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.internalName}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/syncs.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-syncs-get.html.
- [Read single] action
-
Endpoint URL address:
/syncs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the sync identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-syncs-id-get.html.
- [Create] action
-
Endpoint URL address:
/syncs.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-syncs-post.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=item.uri.split('/')[2]}}expression.- syncedInstanceUri
Template: ShortText.
- callbackURL
Template: ShortText.
- syncStartedAt
Template: DateTime. A read-only field.
- syncEndedAt
Template: DateTime. A read-only field.
- status
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- uri
Template: ShortText.
- logs
The value is gathered from
/syncs/{{=item.uri.split('/')[2]}}/logsaddress. The gathered value is processed with{{=response.items}}expression. Field components:- An array.
- Contains the following components: syncUri, count, severity, statusCode, message, createdAt.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/syncs/{{=parameters.id}}/data.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- id: Required. Please specify the sync identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-syncs-id-data-get.html.
- [Read rejects] action
-
Endpoint URL address:
/syncs/{{=parameters.id}}/rejects.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- id: Required. Please specify the sync identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-syncs-id-rejects-get.html.
- [Delete] action
-
Endpoint URL address:
/syncs/{{=item.id}}/data.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-syncs-id-data-delete.html.
- id
A key field. Data type: DT_I4
- fieldValues
Template: FieldT.
- message
Data type: DT_WSTR ( length 4000 )
- statusCode
Template: ShortText.
- recordIndex
Data type: DT_I4
- invalidFields
Template: LongText. A composite field.
- [External]
-
The external fields URL address:
/syncs/{{=parameters.id}}/data. The external fields list is extracted from:{{=_.map(response.items[0] || {}, function(v, k) { return { name: k }; })}}.- {{=external.name}}
Template: ShortText. ( length 255 )
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/exports.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-exports-get.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=function() { var uriList = item.uri.split('/'); return parseInt(uriList[4] || uriList[3]); }()}}expression.- name
Template: ShortText.
- dataRetentionDuration
Template: ShortText.
- autoDeleteDuration
Template: ShortText.
- uri
Template: ShortText.
- filter
Template: ShortText.
- createdBy
Template: ShortText. A read-only field.
- kbUsed
Data type: DT_I4
- kbAllowed
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- syncActions
Field components:
- An array.
-
Uses template:
SyncActionT.
- fields
Template: FieldT.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/imports.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-imports-get.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=function() { var uriList = item.uri.split('/'); return parseInt(uriList[4] || uriList[3]); }()}}expression.- name
Template: ShortText.
- dataRetentionDuration
Template: ShortText.
- identifierFieldName
Template: ShortText.
- isSyncTriggeredOnImport
Data type: DT_BOOL
- isUpdatingMultipleMatchedRecords
Data type: DT_BOOL
- uri
Template: ShortText.
- filter
Template: ShortText.
- createdBy
Template: ShortText. A read-only field.
- kbUsed
Data type: DT_I4
- kbAllowed
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedBy
Template: ShortText. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- syncActions
Field components:
- An array.
-
Uses template:
SyncActionT.
- fields
Template: FieldT.
Based on resource template Bulk.
- [Read] action
-
Endpoint URL address:
/imports/priorities.
The result is extracted from:{{=response.items}}.Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-imports-priorities-get.html.
- [Read single] action
-
Endpoint URL address:
/imports/priorities/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the priority identifier.
Documentation: https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/op-api-bulk-2.0-imports-priorities-id-get.html.
- id
A key field. Data type: DT_I4 The gathered value is processed with
{{=parseInt(item.uri.split('/')[3]) }}expression.- name
Template: ShortText.
- uri
Template: ShortText.
- priority
Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Bulk.
- [Read] action
-
The result is extracted from:{{=Eloqua.exportData(resource, parameters)}}.
The result is paginated.The action has the following user-defined parameters:
- filter: Optional. Specify to filter the export.For more details about syntax visit https://desk.cozyroc.com/portal/en/kb/articles/oracle-eloqua-filter-parameter-for-export-and-import-definition
- [Create] action
-
Endpoint URL address:
.
The result is extracted from:{{=Eloqua.importData(resource, batch, parameters)}}.The action has the following user-defined parameters:
- identifierFieldName: Required. Specify the identifierFieldName.
- [External]
-
The external fields URL address:
/{{=Eloqua.getEntityFromResource(resource)}}/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.name}}
Template: {{=Eloqua.getFieldTemplate(external.dataType)}}.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_R8
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=Eloqua.getTimeStamp(value)}}expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}expression.- SizeT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, width, height.
-
Uses template:
- GeneralT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, accessedAt, brandId, createdAt, createdBy, currentStatus, depth, description, fileName, folderId, link, name, redirectLink, scheduledFor, sourceTemplateId, trackedLink, type, updatedAt, updatedBy, customCSS, accountFieldId, allowUrlsInValue, contactFieldId, customObjectFieldId, customObjectId, customObjectSort, defaultValue, eventFieldId, eventId, eventSessionFieldId, redirectLink, sourceTemplateId, trackedLink, externalIntegrationUrl, folderId, formJson, html, htmlName, isFormSpamProtectionEnabled, isHidden, isResponsive, name, permissions, processingSteps, processingType, scheduledFor, size, style, submitFailedLandingPageId, hyperlinkType, href, syncDate, referencedEntityId, fullImageUrl, thumbnailUrl, queryStringKey, syntax.
-
Uses template:
- FieldT
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- SyncActionT
Field components:
-
Uses template:
ShortText. - Contains the following components: destination, action, status.
-
Uses template:
- GeneralSyncActionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, identifierFieldName, uri, createdAt, createdBy, updatedAt, updatedBy, syncActions, fields.
-
Uses template:
- FieldValueT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, id, value, name.
-
Uses template:
- ProcessingError
Field components:
-
Uses template:
ShortText. - Contains the following components: errorDescription, errorCode, errorMessage, processingStepDisplayName, processingStepId, processingStepTypeId, type.
-
Uses template:
- CustomObjectT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, displayNameFieldUri, emailAddressFieldUri, uniqueFieldUri, uri, createdBy, createdAt, updatedBy, updatedAt.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.