Module eloqua
ballerinax/eloqua Ballerina library
1.3.1
Overview
This is a generated connector for Oracle Eloqua OpenAPI specification.
The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Oracle devoloper Account.
- Obtain tokens by following this guide.
Quickstart
To use the Eloqua connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/eloqua module into the Ballerina project.
import ballerinax/eloqua;
Step 2: Create a new connector instance
Create a eloqua:ClientConfig with the BEARER_TOKEN obtained, and initialize the connector with it.
eloqua:ClientConfig clientConfig = { auth: { token: <BEARER_TOKEN> } }; eloqua:Client baseClient = check new (clientConfig);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to retrieve a list of emails.
Retrieve a list of emails.
public function main() returns error? { eloqua:QueryResultEmailRest20 response = check baseClient->searchListOfEmails(); log:printInfo(response.toString()); } -
Use
bal runcommand to compile and run the Ballerina program.
Clients
eloqua: Client
Isolated
This is a generated connector for Eloqua Marketing Cloud Service API Version 2021.08.12 OpenAPI Specification. The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. Oracle Eloqua is a software as a service (SaaS) platform for marketing automation offered by Oracle that aims to help B2B marketers and organizations manage marketing campaigns and sales lead generation
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Please create a Oracle devoloper account and obtain tokens.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getSyncActionOperationSearch
Isolated FunctionRemote Function
function getSyncActionOperationSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of sync action definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getEmailAddressImportSearch
Isolated FunctionRemote Function
function getEmailAddressImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of email address import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postEmailAddressImportIndividual
Isolated FunctionRemote Function
function postEmailAddressImportIndividual(EmailAddressImportIndividual payload) returns json|errorCreate an email address import definition
Parameters
- payload EmailAddressImportIndividual - The request body contains details of the email address import definition.
Return Type
- json|error - Success.
getEmailAddressImportIndividual
Isolated FunctionRemote Function
Retrieve an email address import definition
Parameters
- id int - The email address import definition's resource identification number.
Return Type
- json|error - OK.
putEmailAddressImportIndividual
Isolated FunctionRemote Function
function putEmailAddressImportIndividual(int id, Emailaddressimportindividual2 payload) returns json|errorUpdate an email address import definition
Parameters
- id int - The email address import definition's resource identification number.
- payload Emailaddressimportindividual2 - The request body contains details of the email address import definition.
Return Type
- json|error - OK.
deleteEmailAddressImportIndividual
Isolated FunctionRemote Function
Delete an email address import definition
Parameters
- id int - The email address import definition's resource identification number.
postEmailAddressImportData
Isolated FunctionRemote Function
Submit data for an email address import
Parameters
- id int - The email address import definition's resource identification number.
- payload record {}[] - The request body contains the list of email addresses to be unsubscribed.
Return Type
- json|error? - Success.
deleteEmailAddressImportData
Isolated FunctionRemote Function
Delete an email address import definition's synced data
Parameters
- id int - The email address import definition's resource identification number.
getEmailGroupIndividual
Isolated FunctionRemote Function
Retrieve an email group
Parameters
- id int - The unique resource identifier of the email group.
Return Type
- json|error - OK.
getEmailGroupSearch
Isolated FunctionRemote Function
function getEmailGroupSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of email groups
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getSyncSearch
Isolated FunctionRemote Function
function getSyncSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of syncs
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postSyncIndividual
Isolated FunctionRemote Function
function postSyncIndividual(SyncIndividual payload) returns json|errorCreate an import or export sync
Parameters
- payload SyncIndividual - The request body contains details about the synchronization definition.
Return Type
- json|error - Success.
getSyncIndividual
Isolated FunctionRemote Function
Retrieve a sync
Parameters
- id int - Id of the sync.
Return Type
- json|error - OK.
getSyncDataQuery
Isolated FunctionRemote Function
function getSyncDataQuery(int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve an export sync's data
Parameters
- id int - Id of the sync.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Total number of sync results found.
Return Type
- json|error - OK
deleteSyncDataQuery
Isolated FunctionRemote Function
Delete sync data
Parameters
- id int - Id of the sync.
getSyncLogSearch
Isolated FunctionRemote Function
function getSyncLogSearch(int id, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a sync's logs
Parameters
- id int - Id of the sync.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - This captures the total number of records that satisfy the request. This is not the count returned in the current response, but total count on the server side. Example: ?totalResults=true.
Return Type
- json|error - OK.
getSyncRejectSearch
Isolated FunctionRemote Function
function getSyncRejectSearch(int id, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve import sync failure data
Parameters
- id int - Id of the sync.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getImportStorage
Isolated FunctionRemote Function
function getImportStorage() returns json|errorDiscover the amount of database space your imports are using
Return Type
- json|error - OK.
getImportPriorityIndividual
Isolated FunctionRemote Function
Retrieve an import priority
Parameters
- id int - The unique resource identifier.
Return Type
- json|error - OK.
getImportPrioritySearch
Isolated FunctionRemote Function
function getImportPrioritySearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of import priorities
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getImportSearch
Isolated FunctionRemote Function
function getImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of imports
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getExportStorage
Isolated FunctionRemote Function
function getExportStorage() returns json|errorDiscover the amount of database space your exports are using
Return Type
- json|error - OK.
getExportSearch
Isolated FunctionRemote Function
function getExportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of exports
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getEventIndividual
Isolated FunctionRemote Function
Retrieve an event
Parameters
- id int - The event's resource identification number.
Return Type
- json|error - OK.
getEventExportSearch
Isolated FunctionRemote Function
function getEventExportSearch(int id, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of export definitions for an event
Parameters
- id int - The event's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getEventFieldSearch
Isolated FunctionRemote Function
function getEventFieldSearch(int id, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of the fields for an event
Parameters
- id int - The event's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getEventImportSearch
Isolated FunctionRemote Function
function getEventImportSearch(int id, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of import definitions for an event
Parameters
- id int - The event's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postEventExportIndividual
Isolated FunctionRemote Function
function postEventExportIndividual(int parentId, EventExportIndividual payload) returns json|errorCreate an export definition for an event
Parameters
- parentId int - The event's resource identification number.
- payload EventExportIndividual - The request body contains details of the event export definition.
Return Type
- json|error - Success.
getEventExportIndividual
Isolated FunctionRemote Function
Retrieve an export definition for an event
Parameters
- parentId int - The event's resource identification number.
- id int - The event export definition's resource identification number.
Return Type
- json|error - OK.
putEventExportIndividual
Isolated FunctionRemote Function
function putEventExportIndividual(int parentId, int id, Eventexportindividual2 payload) returns json|errorUpdate an export definition for an event
Parameters
- parentId int - The event's resource identification number.
- id int - The event export definition's resource identification number.
- payload Eventexportindividual2 - The request body contains details of the event export definition.
Return Type
- json|error - OK.
deleteEventExportIndividual
Isolated FunctionRemote Function
Delete an export definition for an event
Parameters
- parentId int - The event's resource identification number.
- id int - The event export definition's resource identification number.
getEventExportDataQuery
Isolated FunctionRemote Function
function getEventExportDataQuery(int parentId, int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve the synced data for an event export definition
Parameters
- parentId int - The event's resource identification number.
- id int - The event export definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
deleteEventExportDataQuery
Isolated FunctionRemote Function
Delete the synced data for an event export definition
Parameters
- parentId int - The event's resource identification number.
- id int - The event export definition's resource identification number.
getEventFieldIndividual
Isolated FunctionRemote Function
Retrieve an event field definition
Parameters
- parentId int - The event's resource identification number.
- id int - The event field's resource identification number.
Return Type
- json|error - OK.
postEventImportIndividual
Isolated FunctionRemote Function
function postEventImportIndividual(int parentId, EventImportIndividual payload) returns json|errorCreate an import definition for an event
Parameters
- parentId int - The event's resource identification number.
- payload EventImportIndividual - The request body contains details of the event import definition.
Return Type
- json|error - Success.
getEventImportIndividual
Isolated FunctionRemote Function
Retrieve an import definition for an event
Parameters
- parentId int - The event's resource identification number.
- id int - The event import definition's resource identification number.
Return Type
- json|error - OK.
putEventImportIndividual
Isolated FunctionRemote Function
function putEventImportIndividual(int parentId, int id, Eventimportindividual2 payload) returns json|errorUpdate an import definition for an event
Parameters
- parentId int - The event's resource identification number.
- id int - The event import definition's resource identification number.
- payload Eventimportindividual2 - The request body contains details of the event import definition.
Return Type
- json|error - OK.
deleteEventImportIndividual
Isolated FunctionRemote Function
Delete an import definition for an event
Parameters
- parentId int - The event's resource identification number.
- id int - The event import definition's resource identification number.
postEventImportData
Isolated FunctionRemote Function
Upload data for an event import definition
Parameters
- parentId int - The event's resource identification number.
- id int - The event import definition's resource identification number.
- payload record {}[] - The request body contains data to be uploaded to the event import definition.
Return Type
- json|error - Success.
deleteEventImportData
Isolated FunctionRemote Function
Delete the synced data for an event import definition
Parameters
- parentId int - The event's resource identification number.
- id int - The event import definition's resource identification number.
getEventSearch
Isolated FunctionRemote Function
function getEventSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of events
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getCampaignResponseExportSearch
Isolated FunctionRemote Function
function getCampaignResponseExportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of campaign response export definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postCampaignResponseExportIndividual
Isolated FunctionRemote Function
function postCampaignResponseExportIndividual(CampaignResponseExportIndividual payload) returns json|errorCreate a campaign response export definition
Parameters
- payload CampaignResponseExportIndividual - The request body contains details of the campaign response export definition.
Return Type
- json|error - OK.
getCampaignResponseExportIndividual
Isolated FunctionRemote Function
Retrieve a campaign response export definition
Parameters
- id int - The campaign response export definition's resource identification number.
Return Type
- json|error - OK.
putCampaignResponseExportIndividual
Isolated FunctionRemote Function
function putCampaignResponseExportIndividual(int id, Campaignresponseexportindividual2 payload) returns json|errorUpdate a campaign response export definition
Parameters
- id int - The campaign response export definition's resource identification number.
- payload Campaignresponseexportindividual2 - The request body contains details of the campaign response export definition.
Return Type
- json|error - OK.
deleteCampaignResponseExportIndividual
Isolated FunctionRemote Function
Delete a campaign response export definition
Parameters
- id int - The campaign response export definition's resource identification number.
getCampaignResponseExportDataQuery
Isolated FunctionRemote Function
function getCampaignResponseExportDataQuery(int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve the synced data for a campaign response export definition
Parameters
- id int - The campaign response export definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
deleteCampaignResponseExportDataQuery
Isolated FunctionRemote Function
Delete the synced data for a campaign response export definition
Parameters
- id int - The campaign response export definition's resource identification number.
getCampaignResponseFieldIndividual
Isolated FunctionRemote Function
Retrieve a campaign response field definition
Parameters
- id int - The campaign response field's resource identification number.
Return Type
- json|error - OK.
getCampaignResponseFieldSearch
Isolated FunctionRemote Function
function getCampaignResponseFieldSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve all campaign response fields
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getCampaignResponseImportSearch
Isolated FunctionRemote Function
function getCampaignResponseImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of campaign response import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postCampaignResponseImportIndividual
Isolated FunctionRemote Function
function postCampaignResponseImportIndividual(CampaignResponseImportIndividual payload) returns json|errorCreate a campaign response import definition
Parameters
- payload CampaignResponseImportIndividual - The request body contains details of the campaign response import definition.
Return Type
- json|error - OK.
getCampaignResponseImportIndividual
Isolated FunctionRemote Function
Retrieve a campaign response import definition
Parameters
- id int - The campaign response import definition's resource identification number.
Return Type
- json|error - OK.
putCampaignResponseImportIndividual
Isolated FunctionRemote Function
function putCampaignResponseImportIndividual(int id, Campaignresponseimportindividual2 payload) returns json|errorUpdate a campaign response import definition
Parameters
- id int - The campaign response import definition's resource identification number.
- payload Campaignresponseimportindividual2 - The request body contains details of the campaign response import definition.
Return Type
- json|error - OK.
deleteCampaignResponseImportIndividual
Isolated FunctionRemote Function
Delete a campaign response import definition
Parameters
- id int - The campaign response import definition's resource identification number.
postCampaignResponseImportData
Isolated FunctionRemote Function
Upload data for a campaign response import definition
Parameters
- id int - The campaign response import definition's resource identification number.
- payload record {}[] - The request body contains details of the campaign response data.
Return Type
- json|error? - OK.
deleteCampaignResponseImportData
Isolated FunctionRemote Function
Delete the synced data for a campaign response import definition
Parameters
- id int - The campaign response import definition's resource identification number.
getCampaignFieldIndividual
Isolated FunctionRemote Function
Retrieve a campaign field definition
Parameters
- id int - The campaign field definition's resource identification number.
Return Type
- json|error - OK.
getCampaignFieldSearch
Isolated FunctionRemote Function
function getCampaignFieldSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of campaign fields
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getOpportunityContactLinkageImportSearch
Isolated FunctionRemote Function
function getOpportunityContactLinkageImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of opportunity contact linkage import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postOpportunityContactLinkageImportIndividual
Isolated FunctionRemote Function
function postOpportunityContactLinkageImportIndividual(OpportunityContactLinkageImportIndividual payload) returns json|errorCreate an opportunity contact linkage import definition
Parameters
- payload OpportunityContactLinkageImportIndividual - The request body contains details of the opportunity contact linkage import definition.
Return Type
- json|error - OK.
getOpportunityContactLinkageImportIndividual
Isolated FunctionRemote Function
Retrieve an opportunity contact linkage import definition
Parameters
- id int - The opportunity contact linkage import definition's resource identification number.
Return Type
- json|error - OK.
putOpportunityContactLinkageImportIndividual
Isolated FunctionRemote Function
function putOpportunityContactLinkageImportIndividual(int id, Opportunitycontactlinkageimportindividual2 payload) returns json|errorUpdate an opportunity contact linkage import definition
Parameters
- id int - The opportunity contact linkage import definition's resource identification number.
- payload Opportunitycontactlinkageimportindividual2 - The request body contains details of the opportunity contact linkage import definition.
Return Type
- json|error - OK.
deleteOpportunityContactLinkageImportIndividual
Isolated FunctionRemote Function
Delete an opportunity contact linkage import definition
Parameters
- id int - The opportunity contact linkage import definition's resource identification number.
postOpportunityContactLinkageImportData
Isolated FunctionRemote Function
Upload data for an opportunity contact linkage import definition
Parameters
- id int - The opportunity contact linkage import definition's resource identification number.
- payload record {}[] - The request body contains details of the opportunity contact linkage import data.
Return Type
- json|error - OK.
deleteOpportunityContactLinkageImportData
Isolated FunctionRemote Function
Delete the synced data for an opportunity contact linkage import definition
Parameters
- id int - The opportunity contact linkage import definition's resource identification number.
getOpportunityFieldIndividual
Isolated FunctionRemote Function
Retrieve an opportunity field definition
Parameters
- id int - The opportunity field definition's resource identification number.
Return Type
- json|error - OK.
getOpportunityFieldSearch
Isolated FunctionRemote Function
function getOpportunityFieldSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of opportunity fields
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getOpportunityImportSearch
Isolated FunctionRemote Function
function getOpportunityImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of opportunity import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postOpportunityImportIndividual
Isolated FunctionRemote Function
function postOpportunityImportIndividual(OpportunityImportIndividual payload) returns json|errorCreate an opportunity import definition
Parameters
- payload OpportunityImportIndividual - The request body contains details of the opportunity import definition.
Return Type
- json|error - OK.
getOpportunityImportIndividual
Isolated FunctionRemote Function
Retrieve an opportunity import definition
Parameters
- id int - The opportunity import definition's resource identification number.
Return Type
- json|error - OK.
putOpportunityImportIndividual
Isolated FunctionRemote Function
function putOpportunityImportIndividual(int id, Opportunityimportindividual2 payload) returns json|errorUpdate an opportunity import definition
Parameters
- id int - The opportunity import definition's resource identification number.
- payload Opportunityimportindividual2 - The request body contains details of the opportunity import definition.
Return Type
- json|error - OK.
deleteOpportunityImportIndividual
Isolated FunctionRemote Function
Delete an opportunity import definition
Parameters
- id int - The opportunity import definition's resource identification number.
postOpportunityImportData
Isolated FunctionRemote Function
Upload data for an opportunity import definition
Parameters
- id int - The opportunity import definition's resource identification number.
- payload record {}[] - The request body contains details of the opportunity data.
Return Type
- json|error - OK.
deleteOpportunityImportData
Isolated FunctionRemote Function
Delete the synced data for an opportunity import definition
Parameters
- id int - The opportunity import definition's resource identification number.
readIndividualUser
Isolated FunctionRemote Function
function readIndividualUser(int id, string? depth) returns UserRest10|errorRetrieve a user
Parameters
- id int - Id of the user to retrieve.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- UserRest10|error - OK.
updateUser
Isolated FunctionRemote Function
function updateUser(int id, UserRest10 payload) returns UserRest10|errorUpdate a user
Parameters
- id int - Id of the user to update.
- payload UserRest10 - The request body defines the details of the user to be updated.
Return Type
- UserRest10|error - OK.
searchListOfUsers
Isolated FunctionRemote Function
function searchListOfUsers(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultUserRest10|error?Retrieve a list of users
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the user was last updated. This is a read-only property.
Return Type
- QueryResultUserRest10|error? - OK.
createAccounts
Isolated FunctionRemote Function
function createAccounts(AccountRest10 payload) returns AccountRest10|errorCreate an account
Parameters
- payload AccountRest10 - The request body defines the details of the account to be created.
Return Type
- AccountRest10|error - Success
readIndividualAccount
Isolated FunctionRemote Function
function readIndividualAccount(int id, string? depth, int? viewId) returns AccountRest10|errorRetrieve an account
Parameters
- id int - Id of the account.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- viewId int? (default ()) - Id of the account view.
Return Type
- AccountRest10|error - OK
updateAccount
Isolated FunctionRemote Function
function updateAccount(int id, AccountRest10 payload) returns AccountRest10|errorUpdate an account
Return Type
- AccountRest10|error - OK
deleteAccounts
Isolated FunctionRemote Function
Delete an account
Parameters
- id int - Id of the account.
retrieveListofAccounts
Isolated FunctionRemote Function
function retrieveListofAccounts(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt, int? viewId, int? ownedByUserId) returns QueryResultAccountRest10|error?Retrieve a list of accounts
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered
- lastUpdatedAt int? (default ()) - The date and time the account was last updated. This is a read-only property.
- viewId int? (default ()) - Id of the account view to filter results. Must be a valid account view id. Example: <code>/api/REST/1.0/data/accounts?viewId=100005</code>.
- ownedByUserId int? (default ()) - Set this query parameter to an Eloqua User ID to return all Accounts linked to that Eloqua User. You can link Users to Accounts using the Bulk API. For instructions on how to link Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>.
Return Type
searchFormData
Isolated FunctionRemote Function
function searchFormData(int id, int? count, int? page, int? startAt, int? endAt) returns QueryResultFormSubmissionRest10|errorRetrieve processed form data for a single form
Parameters
- id int - ID of the form.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
- startAt int? (default ()) - The earliest date time for which the request will retrieve data, expressed in Unix time.
- endAt int? (default ()) - The latest date time for which the request will retrieve data, expressed in Unix time.
Return Type
createFormData
Isolated FunctionRemote Function
function createFormData(int id, FormDataRest10 payload) returns FormDataRest10|errorCreate form data for a single form
Parameters
- id int - ID of the form.
- payload FormDataRest10 - The request body defines the details of the form data to be created.
Return Type
- FormDataRest10|error - Success.
getAsyncFormSubmissionGETRest10
Isolated FunctionRemote Function
function getAsyncFormSubmissionGETRest10(string formId, string formSubmitJobId) returns Response|errorRetrieve a single form submit job
Parameters
- formId string - ID of the form.
- formSubmitJobId string - ID of the asynchronous form submission job.
Return Type
searchAsyncFormSubmissionGETRest10
Isolated FunctionRemote Function
function searchAsyncFormSubmissionGETRest10(string formId, string? count, string? page, string? search, int? startAt) returns Response|errorRetrieve all form submit jobs for a single form
Parameters
- formId string - ID of the form.
- count string? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page string? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- startAt int? (default ()) - The earliest date time for which the request will retrieve data, expressed in Unix time.
Return Type
createLandingPage
Isolated FunctionRemote Function
function createLandingPage(LandingPageRest10 payload) returns LandingPageRest10|errorCreate a landing page
Parameters
- payload LandingPageRest10 - The request body defines the details of the landing page to be created.
Return Type
- LandingPageRest10|error - Success.
readIndividualLandingPage
Isolated FunctionRemote Function
function readIndividualLandingPage(int id, string? depth) returns LandingPageRest10|errorRetrieve a landing page
Parameters
- id int - Id of the landing page to retrieve.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- LandingPageRest10|error - OK.
updateLandingPage
Isolated FunctionRemote Function
function updateLandingPage(int id, LandingPageRest10 payload) returns LandingPageRest10|errorUpdate a landing page
Parameters
- id int - Id of the landing page to update.
- payload LandingPageRest10 - The request body defines the details of the landing page to be updated.
Return Type
- LandingPageRest10|error - OK.
deleteLandingPageREST10
Isolated FunctionRemote Function
Delete a landing page
Parameters
- id int - Id of the landing page to delete.
searchListofLandingPages
Isolated FunctionRemote Function
function searchListofLandingPages(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultLandingPageRest10|errorRetrieve a list of landing pages
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the external asset was last updated.
Return Type
createEmail
Isolated FunctionRemote Function
function createEmail(EmailRest10 payload) returns EmailRest10|errorCreate an email
Parameters
- payload EmailRest10 - The request body defines the details of the email to be created.
Return Type
- EmailRest10|error - Success
readIndividualEmail
Isolated FunctionRemote Function
function readIndividualEmail(int id, string? depth) returns EmailRest10|errorRetrieve an email
Parameters
- id int - Id of the email.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- EmailRest10|error - OK
updateEmail
Isolated FunctionRemote Function
function updateEmail(int id, EmailRest10 payload) returns EmailRest10|errorUpdate an email
Parameters
- id int - Id of the email.
- payload EmailRest10 - The request body defines the details of the email to be updated.
Return Type
- EmailRest10|error - OK
deleteEmail
Isolated FunctionRemote Function
Delete an email
Parameters
- id int - Id of the email.
searchListOfEmails
Isolated FunctionRemote Function
function searchListOfEmails(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultEmailRest10|errorRetrieve a list of emails
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the email was last updated.
Return Type
createIndividualObjectDataPOSTRest20
Isolated FunctionRemote Function
function createIndividualObjectDataPOSTRest20(int parentId, CustomObjectDataRest20 payload) returns CustomObjectDataRest20|errorCreate custom object data
Parameters
- parentId int - Id of the parent.
- payload CustomObjectDataRest20 - The request body defines the details of the custom object data to be created.
Return Type
- CustomObjectDataRest20|error - Success.
readIndividualCustomObjectDataGETRest20
Isolated FunctionRemote Function
function readIndividualCustomObjectDataGETRest20(int parentId, int id, string? depth) returns CustomObjectDataRest20|errorRetrieve custom object data
Parameters
- parentId int - Id of the parent.
- id int - Id of the custom object data.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- CustomObjectDataRest20|error - OK.
updateIndividualCustomObjectPUTRest20
Isolated FunctionRemote Function
function updateIndividualCustomObjectPUTRest20(int parentId, int id, CustomObjectDataRest20 payload) returns CustomObjectDataRest20|errorUpdate custom object data
Parameters
- parentId int - Id of the parent.
- id int - Id of the custom object data.
- payload CustomObjectDataRest20 - The request body defines the details of the custom object data to be updated.
Return Type
- CustomObjectDataRest20|error - OK.
deleteCustomObjectData
Isolated FunctionRemote Function
Delete custom object data
searchListOfCustomObjectDataGETRest20
Isolated FunctionRemote Function
function searchListOfCustomObjectDataGETRest20(int parentId, string? depth, int? count, int? page, string? search, string? orderBy) returns QueryResultCustomObjectDataRest20|errorRetrieve a list of custom object data
Parameters
- parentId int - Id of the parent.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - Specifies which page of custom object data assets to return (the count parameter defines the number of custom object data assets per page). If the page parameter is not supplied, 1 will be used by default.
- search string? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
Return Type
searchFormDataGETRest20
Isolated FunctionRemote Function
function searchFormDataGETRest20(int id, int? count, int? page, int? startAt, int? endAt) returns QueryResultFormSubmissionRest20|errorRetrieve processed form data for a single form
Parameters
- id int - The ID of the form
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
- startAt int? (default ()) - The earliest date time for which the request will retrieve data, expressed in Unix time.
- endAt int? (default ()) - The latest date time for which the request will retrieve data, expressed in Unix time.
Return Type
createIndividualFormPOSTRest20
Isolated FunctionRemote Function
function createIndividualFormPOSTRest20(int id, FormDataRest20 payload) returns FormDataRest20|errorCreate form data for a single form
Parameters
- id int - The ID of the form
- payload FormDataRest20 - The request body defines the details of the form data to be created.
Return Type
- FormDataRest20|error - Success.
deleteFormData
Isolated FunctionRemote Function
Delete form data
getAsyncFormSubmissionGETRest20
Isolated FunctionRemote Function
function getAsyncFormSubmissionGETRest20(string formId, string formSubmitJobId) returns Response|errorRetrieve a single form submit job
Parameters
- formId string - The ID of the form
- formSubmitJobId string - The ID of the asynchronous form submission job
Return Type
searchAsyncFormSubmissionGETRest20
Isolated FunctionRemote Function
function searchAsyncFormSubmissionGETRest20(string formId, string? count, string? page, string? search, int? startAt) returns Response|errorRetrieve all form submit jobs for a single form
Parameters
- formId string - The ID of the form
- count string? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page string? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- startAt int? (default ()) - The earliest date time for which the request will retrieve data, expressed in Unix time.
Return Type
searchFormSpamSubmissionGETRest20
Isolated FunctionRemote Function
function searchFormSpamSubmissionGETRest20(string formId, int? count, int? page, string? search, int? startAt) returns Response|errorRetrieve all spam form submit jobs for a single form
Parameters
- formId string - ID of the form.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- startAt int? (default ()) - The earliest date time for which the request will retrieve data, expressed in Unix time.
Return Type
createBatchRequestPOSTRest20
Isolated FunctionRemote Function
function createBatchRequestPOSTRest20(int id, AsyncFormSubmissionBatchRest20 payload, string? depth) returns AsyncFormSubmissionBatchRest20|errorCreate form data in batch for a single form
Parameters
- id int - The ID of the form
- payload AsyncFormSubmissionBatchRest20 - The request body defines the details of the form data in a batch to be created.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- AsyncFormSubmissionBatchRest20|error - Success.
getAsyncFormSubmissionBatchByBatchIdGETRest20
Isolated FunctionRemote Function
function getAsyncFormSubmissionBatchByBatchIdGETRest20(int formId, string batchId, string? depth) returns AsyncFormSubmissionBatchRest20|errorRetrieve batch form submission details by batchId
Parameters
- formId int - The ID of the form
- batchId string - The ID of the batch
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
getAsyncFormSubmissionBatchByBatchCorrelationIdGETRest20
Isolated FunctionRemote Function
function getAsyncFormSubmissionBatchByBatchCorrelationIdGETRest20(int formId, string batchCorrelationId, string? depth) returns AsyncFormSubmissionBatchRest20|errorRetrieve batch form submission details by batchCorrelationId
Parameters
- formId int - The ID of the form
- batchCorrelationId string - The Correlation ID of the batch
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
listGroupMembershipForContactGETRest20
Isolated FunctionRemote Function
function listGroupMembershipForContactGETRest20(int id) returns ContactListRest20|errorRetrieve contact list membership information for a contact
Parameters
- id int - Id of the contact to retrieve.
Return Type
- ContactListRest20|error - OK.
searchContactsSEARCHRest20
Isolated FunctionRemote Function
function searchContactsSEARCHRest20(string xHttpMethodOverride, EntitySearchByIdsRest20 payload) returns ContactRest20|errorRetrieve contact information
Parameters
- xHttpMethodOverride string - The request header <code>X-HTTP-Method-Override</code> must be set with value <code>SEARCH</code>.
- payload EntitySearchByIdsRest20 - The request body defines the details of the request.
Return Type
- ContactRest20|error - OK.
createIndividualFormsPOSTRest20
Isolated FunctionRemote Function
function createIndividualFormsPOSTRest20(FormRest20 payload) returns FormRest20|errorCreate a form
Parameters
- payload FormRest20 - The request body defines the details of the form to be created.
Return Type
- FormRest20|error - Success.
readIndividualFormGETRest20
Isolated FunctionRemote Function
function readIndividualFormGETRest20(int id, string? depth) returns FormRest20|errorRetrieve a form
Parameters
- id int - Id of the form.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- FormRest20|error - OK.
updateIndividualFormPUTRest20
Isolated FunctionRemote Function
function updateIndividualFormPUTRest20(int id, FormRest20 payload) returns FormRest20|errorUpdate a form
Parameters
- id int - Id of the form.
- payload FormRest20 - The request body defines the details of the form to be updated.
Return Type
- FormRest20|error - OK.
deleteFormRest20
Isolated FunctionRemote Function
Delete a form
Parameters
- id int - Id of the form.
patchContentPATCHRest20
Isolated FunctionRemote Function
function patchContentPATCHRest20(int id, FormRest20 payload) returns FormRest20|errorPartially update a form
Parameters
- id int - Id of the form.
- payload FormRest20 - The request body defines the details of the form for which properties are to be updated.
Return Type
- FormRest20|error - OK.
archiveIndividualFormPOSTRest20
Isolated FunctionRemote Function
function archiveIndividualFormPOSTRest20(int id, ArchiveParameterRest20 payload) returns FormRest20|errorArchive a form
Parameters
- id int - ID of the form to be archived.
- payload ArchiveParameterRest20 - The request body defines the parameters for archiving the form.
Return Type
- FormRest20|error - Success.
unarchiveIndividualFormPOSTRest20
Isolated FunctionRemote Function
function unarchiveIndividualFormPOSTRest20(int id, ArchiveParameterRest20 payload) returns FormRest20|errorUnarchive a form
Parameters
- id int - ID of the form to be unarchived.
- payload ArchiveParameterRest20 - The request body defines the parameters for unarchiving the form.
Return Type
- FormRest20|error - Success.
searchFormListGETRest20
Isolated FunctionRemote Function
function searchFormListGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt, boolean? includeAvailable, boolean? includeArchived) returns QueryResultFormRest20|errorRetrieve a list of forms
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the form was last updated.
- includeAvailable boolean? (default ()) - Specifies whether to include unarchived forms in the results, considered true if not specified.
- includeArchived boolean? (default ()) - Specifies whether to include archived forms in the results, considered false if not specified.
Return Type
- QueryResultFormRest20|error - OK.
createIndividualCampaignsPOSTRest20
Isolated FunctionRemote Function
function createIndividualCampaignsPOSTRest20(CampaignRest20 payload) returns CampaignRest20|errorCreate a campaign
Parameters
- payload CampaignRest20 - The request body defines the details of the campaign to be created.
Return Type
- CampaignRest20|error - Success
readIndividualCampaignGETRest20
Isolated FunctionRemote Function
function readIndividualCampaignGETRest20(int id, string? depth) returns CampaignRest20|errorRetrieve a campaign
Parameters
- id int - Id of the campaign.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- CampaignRest20|error - OK
updateIndividualCampaignPUTRest20
Isolated FunctionRemote Function
function updateIndividualCampaignPUTRest20(string id, CampaignRest20 payload) returns CampaignRest20|errorUpdate a campaign
Parameters
- id string - Id of the campaign.
- payload CampaignRest20 - The request body defines the details of the campaign to be updated.
Return Type
- CampaignRest20|error - OK
deleteCampaign
Isolated FunctionRemote Function
Delete a campaign
Parameters
- id int - Id of the campaign.
activateCampaignPOSTRest20
Isolated FunctionRemote Function
function activateCampaignPOSTRest20(int id, string? scheduledFor, int? runAsUserId, boolean? activateNow) returns CampaignRest20|errorActivate a campaign
Parameters
- id int - Id of the campaign.
- scheduledFor string? (default ()) - The date and time for the campaign to activate on expressed in Unix time. Alternatively, you can activate the campaign immediately by specifying 'now'.
- runAsUserId int? (default ()) - The username to activate the campaign.
- activateNow boolean? (default ()) - Whether or not to activate the campaign immediately.
Return Type
- CampaignRest20|error - Success
deactivateCampaignPOSTRest20
Isolated FunctionRemote Function
function deactivateCampaignPOSTRest20(int id) returns CampaignRest20|errorDeactivate a campaign
Parameters
- id int - Id of the campaign.
Return Type
- CampaignRest20|error - Success
searchListOfCampaignsGETRest20
Isolated FunctionRemote Function
function searchListOfCampaignsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultCampaignRest20|errorRetrieve a list of campaigns
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. The default value is <code>minimal</code>.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the campaign was last updated.
Return Type
createIndividualAccountGroupsPOSTRest20
Isolated FunctionRemote Function
function createIndividualAccountGroupsPOSTRest20(AccountGroupRest20 payload) returns AccountGroupRest20|errorCreate an account group
Parameters
- payload AccountGroupRest20 - The request body defines the details of the account group to be created.
Return Type
- AccountGroupRest20|error - Success
readIndividualAccountGroupGETRest20
Isolated FunctionRemote Function
function readIndividualAccountGroupGETRest20(int id, string? depth) returns AccountGroupRest20|errorRetrieve an account group
Parameters
- id int - Id of the account group.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- AccountGroupRest20|error - OK
updateIndividualAccountGroupPUTRest20
Isolated FunctionRemote Function
function updateIndividualAccountGroupPUTRest20(int id, AccountGroupRest20 payload) returns AccountGroupRest20|errorUpdate an account group
Parameters
- id int - Id of the account group.
- payload AccountGroupRest20 - The request body defines the details of the account group to be updated.
Return Type
- AccountGroupRest20|error - OK
deleteAccountGroup
Isolated FunctionRemote Function
Delete an account group
Parameters
- id int - Id of the account group.
searchListOfAccountGroupsGETRest20
Isolated FunctionRemote Function
function searchListOfAccountGroupsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultAccountGroupRest20|errorRetrieve a list of account groups
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which account group results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the account group was last updated.
Return Type
createIndividualEmailDeploymentPOSTRest20
Isolated FunctionRemote Function
function createIndividualEmailDeploymentPOSTRest20(EmailDeploymentRest20 payload, boolean? preMerge) returns EmailDeploymentRest20|errorCreate and send an email deployment
Parameters
- payload EmailDeploymentRest20 - The request body defines the details of the email deployment to be created.
- preMerge boolean? (default ()) - Whether or not the email header and footer is inserted into the email body. If <code>true</code>, the email header and footer will not be inserted into the email body. If <code>false</code>, the email header and footer will be inserted into the email body.
Return Type
- EmailDeploymentRest20|error - Success
readIndividualEmailDeploymentGETRest20
Isolated FunctionRemote Function
function readIndividualEmailDeploymentGETRest20(int id, string? depth) returns EmailDeploymentRest20|errorRetrieve an email deployment
Parameters
- id int - Id of the email deployment.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>. Any other values passed are reset to complete by default.
Return Type
createIndividualEmailPOSTRest20
Isolated FunctionRemote Function
function createIndividualEmailPOSTRest20(EmailRest20 payload) returns EmailRest20|errorCreate an email
Parameters
- payload EmailRest20 - The request body defines the details of the email to be created.
Return Type
- EmailRest20|error - Success
readIndividualEmailGETRest20
Isolated FunctionRemote Function
function readIndividualEmailGETRest20(int id, string? depth, boolean? preMerge, boolean? noMergeContent) returns EmailRest20|errorRetrieve an email
Parameters
- id int - Id of the email.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- preMerge boolean? (default ()) - This property is used by Oracle Engage.
- noMergeContent boolean? (default ()) - Whether email components are dynamically populated upon retrieve. If set to true, email components are populated. If set to false, the default content of the email component will be returned. The default is true.
Return Type
- EmailRest20|error - OK
updateIndividualEmailPUTRest20
Isolated FunctionRemote Function
function updateIndividualEmailPUTRest20(int id, EmailRest20 payload) returns EmailRest20|errorUpdate an email
Parameters
- id int - Id of the email.
- payload EmailRest20 - The request body defines the details of the email to be updated.
Return Type
- EmailRest20|error - OK
deleteEmailRest20
Isolated FunctionRemote Function
Delete an email
Parameters
- id int - Id of the email.
searchListOfEmailsGETRest20
Isolated FunctionRemote Function
function searchListOfEmailsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt, boolean? includeAvailable, boolean? includeArchived) returns QueryResultEmailRest20|errorRetrieve a list of emails
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the email was last updated.
- includeAvailable boolean? (default ()) - Specifies whether to include unarchived emails in the results, considered true if not specified.
- includeArchived boolean? (default ()) - Specifies whether to include archived emails in the results, considered false if not specified.
Return Type
archiveIndividualEmailPOSTRest20
Isolated FunctionRemote Function
function archiveIndividualEmailPOSTRest20(int id, ArchiveParameterRest20 payload) returns EmailRest20|errorArchive an email
Parameters
- id int - ID of the email to be archived.
- payload ArchiveParameterRest20 - The request body defines the parameters for archiving the email.
Return Type
- EmailRest20|error - Success.
unarchiveIndividualEmailPOSTRest20
Isolated FunctionRemote Function
function unarchiveIndividualEmailPOSTRest20(int id, ArchiveParameterRest20 payload) returns EmailRest20|errorUnarchive an email
Parameters
- id int - ID of the email to be unarchived.
- payload ArchiveParameterRest20 - The request body defines the parameters for unarchiving the email.
Return Type
- EmailRest20|error - Success.
searchCustomObjectData
Isolated FunctionRemote Function
function searchCustomObjectData(int id, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultCustomObjectDataRest10|error?Retrieve a list of custom object data
Parameters
- id int - Id of the custom object.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the custom object was last updated. This is a read-only property.
Return Type
createCustomObject
Isolated FunctionRemote Function
function createCustomObject(int id, CustomObjectDataRest10 payload) returns CustomObjectDataRest10|errorCreate custom object data
Parameters
- id int - Id of the custom object.
- payload CustomObjectDataRest10 - The request body defines the details of the custom object data to be created.
Return Type
- CustomObjectDataRest10|error - Success.
createContacts
Isolated FunctionRemote Function
function createContacts(ContactRest10 payload) returns ContactRest10|errorCreate a contact
Parameters
- payload ContactRest10 - The request body defines the details of the contact to be created.
Return Type
- ContactRest10|error - Success
readIndividualContact
Isolated FunctionRemote Function
function readIndividualContact(int id, string? depth, int? viewId) returns ContactRest10|errorRetrieve a contact
Parameters
- id int - Id of the contact.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- viewId int? (default ()) - Id of the contact view.
Return Type
- ContactRest10|error - OK
updateContact
Isolated FunctionRemote Function
function updateContact(int id, ContactRest10 payload) returns ContactRest10|errorUpdate a contact
Parameters
- id int - Id of the contact.
- payload ContactRest10 - The request body defines the details of the contact to be updated.
Return Type
- ContactRest10|error - OK
deleteContact
Isolated FunctionRemote Function
Delete a contact
Parameters
- id int - Id of the contact
searchListOfContacts
Isolated FunctionRemote Function
function searchListOfContacts(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt, int? viewId) returns QueryResultContactRest10|error?Retrieve a list of contacts
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the contact was last updated. This is a read-only property.
- viewId int? (default ()) - Id of the contact view to filter results. Must be a valid contact view id. Example: <code>?viewId=100006</code>.
Return Type
getActivitiesGETRest10
Isolated FunctionRemote Function
function getActivitiesGETRest10(int id, string 'type, int startDate, int endDate, int? count) returns ActivityRest10|error?Retrieve a list of activities
Parameters
- id int - Id of the activity.
- 'type string - The type of activity you wish to retrieve from the specified contact: <code>emailOpen</code>, <code>emailSend</code>, <code>emailClickThrough</code>, <code>emailSubscribe</code>, <code>emailUnsubscribe</code>, <code>formSubmit</code>, <code>webVisit</code>, or <code>campaignMembership</code>.
- startDate int - The start date and time (10 digit integer Unix time).
- endDate int - The end date and time (10 digit integer Unix time).
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
Return Type
- ActivityRest10|error? - OK
createIndividualUserPOSTRest20
Isolated FunctionRemote Function
function createIndividualUserPOSTRest20(UserRest20 payload) returns UserRest20|errorCreate a user
Parameters
- payload UserRest20 - The request body defines the details of the user to be created.
Return Type
- UserRest20|error - Success
readIndividualUserGETRest20
Isolated FunctionRemote Function
function readIndividualUserGETRest20(int id, string? depth) returns UserRest20|errorRetrieve a user
Parameters
- id int - The user ID to retrieve
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- UserRest20|error - OK
updateIndividualUserPUTRest20
Isolated FunctionRemote Function
function updateIndividualUserPUTRest20(int id, UserRest20 payload) returns UserRest20|errorUpdate a user
Parameters
- id int - The ID of the user to update
- payload UserRest20 - The request body defines the details of the user to be updated
Return Type
- UserRest20|error - OK
deleteUser
Isolated FunctionRemote Function
Delete a user
Parameters
- id int - The user ID to delete
getCurrentUserGETRest20
Isolated FunctionRemote Function
function getCurrentUserGETRest20(string? depth) returns UserRest20|errorRetrieve the current user
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- UserRest20|error - OK
updatePasswordPUTRest20
Isolated FunctionRemote Function
function updatePasswordPUTRest20(int id, UserPasswordRest20 payload) returns Response|errorUpdate a user's password
Parameters
- id int - The id of the user to update the password
- payload UserPasswordRest20 - The request body defines the details of the request
updateEnabledPUTRest20
Isolated FunctionRemote Function
function updateEnabledPUTRest20(int id, UserEnabledRest20 payload) returns UserEnabledRest20|errorEnable or disable a user
Parameters
- id int - The ID of the user to enable or disable
- payload UserEnabledRest20 - The request body defines whether to enable or disable the user with the specified ID
Return Type
- UserEnabledRest20|error - OK
searchListOfUsersGETRest20
Isolated FunctionRemote Function
function searchListOfUsersGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultUserRest20|errorRetrieve a list of users
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. The default value is <code>minimal</code>.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the user was last updated.
Return Type
createContactSegments
Isolated FunctionRemote Function
function createContactSegments(ContactSegmentRest10 payload) returns ContactSegmentRest10|errorCreate a contact segment
Parameters
- payload ContactSegmentRest10 - The request body defines the details of the contact segment to be created.
Return Type
- ContactSegmentRest10|error - Success
readIndividualContactSegment
Isolated FunctionRemote Function
function readIndividualContactSegment(int id, string? depth) returns ContactSegmentRest10|errorRetrieve a contact segment
Parameters
- id int - Id of the contact segment.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
updateContactSegment
Isolated FunctionRemote Function
function updateContactSegment(int id, ContactSegmentRest10 payload) returns ContactSegmentRest10|errorUpdate a contact segment
Parameters
- id int - Id of the contact segment.
- payload ContactSegmentRest10 - The request body defines the details of the contact segment to be update.
Return Type
deleteContactSegment
Isolated FunctionRemote Function
Delete a contact segment
Parameters
- id int - Id of the contact segment.
searchListOfContactSegments
Isolated FunctionRemote Function
function searchListOfContactSegments(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultSegmentRest10|errorRetrieve a list of contact segments
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the contact segment was last updated.
Return Type
createContactList
Isolated FunctionRemote Function
function createContactList(ContactListRest10 payload) returns ContactListRest10|errorCreate a contact list
Parameters
- payload ContactListRest10 - The request body defines the details of the contact list to be created.
Return Type
- ContactListRest10|error - Success
readContactList
Isolated FunctionRemote Function
function readContactList(int id, string? depth) returns ContactListRest10|errorRetrieve a contact list
Parameters
- id int - Id of the contact list.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- ContactListRest10|error - OK
updateContactList
Isolated FunctionRemote Function
function updateContactList(int id, ContactListRest10 payload) returns ContactListRest10|errorUpdate a contact list
Parameters
- id int - Id of the contact list.
- payload ContactListRest10 - The request body defines the details of the contact list to be updated.
Return Type
- ContactListRest10|error - OK
deleteContactList
Isolated FunctionRemote Function
Delete a contact list
Parameters
- id int - Id of the contact list.
searchListOfContactList
Isolated FunctionRemote Function
function searchListOfContactList(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultListRest10|errorRetrieve a list of contact lists
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the contact list was last updated.
Return Type
readOptionList
Isolated FunctionRemote Function
function readOptionList(int id, string? depth) returns OptionListRest10|errorRetrieve an option list
Parameters
- id int - Id of the option list.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- OptionListRest10|error - OK.
updateOptionList
Isolated FunctionRemote Function
function updateOptionList(int id, OptionListRest10 payload) returns OptionListRest10|errorUpdate an option list
Parameters
- id int - Id of the option list. This is a read-only property.
- payload OptionListRest10 - The request body defines the details of the option list to be updated.
Return Type
- OptionListRest10|error - OK.
deleteOptionList
Isolated FunctionRemote Function
Delete an option list
Parameters
- id int - Id of the option list
searchListOfOptions
Isolated FunctionRemote Function
function searchListOfOptions(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultOptionListRest10|errorRetrieve a list of option lists
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the option list was last updated.
Return Type
createOptionLists
Isolated FunctionRemote Function
function createOptionLists(OptionListRest10 payload) returns OptionListRest10|errorCreate an option list
Parameters
- payload OptionListRest10 - The request body defines the details of the option list to be created.
Return Type
- OptionListRest10|error - Success.
createMicrosites
Isolated FunctionRemote Function
function createMicrosites(MicrositeRest10 payload) returns MicrositeRest10|errorCreate a microsite
Parameters
- payload MicrositeRest10 - The request body defines the details of the microsite to be updated.
Return Type
- MicrositeRest10|error - Success.
readMicrosite
Isolated FunctionRemote Function
function readMicrosite(int id, string? depth) returns MicrositeRest10|errorRetrieve a microsite
Parameters
- id int - Id of the microsite.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- MicrositeRest10|error - OK.
updateMicrosite
Isolated FunctionRemote Function
function updateMicrosite(int id, MicrositeRest10 payload) returns MicrositeRest10|errorUpdate a microsite
Parameters
- id int - Id of the microsite.
- payload MicrositeRest10 - The request body defines the details of the microsite to be created.
Return Type
- MicrositeRest10|error - OK.
deleteMicrosite
Isolated FunctionRemote Function
Delete a microsite
Parameters
- id int - Id of the microsite. This is a read-only property.
searchListOfMicrosites
Isolated FunctionRemote Function
function searchListOfMicrosites(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultMicrositeRest10|errorRetrieve a list of microsites
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the microsite was last updated.
Return Type
readImage
Isolated FunctionRemote Function
function readImage(int id, string? depth) returns ImageFileRest10|errorRetrieve an image
Parameters
- id int - Id of the image.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- ImageFileRest10|error - OK.
updateImage
Isolated FunctionRemote Function
function updateImage(int id, ImageFileRest10 payload) returns ImageFileRest10|errorUpdate an image
Parameters
- id int - Id of the image to update.
- payload ImageFileRest10 - The request body defines the details of the image to be created.
Return Type
- ImageFileRest10|error - OK.
deleteImage
Isolated FunctionRemote Function
Delete an image
Parameters
- id int - Id of the image to delete.
createUploadImagePOSTRest10
Isolated FunctionRemote Function
function createUploadImagePOSTRest10() returns ImageFileRest10|errorUpload an image
Return Type
- ImageFileRest10|error - Success.
searchListOfImages
Isolated FunctionRemote Function
function searchListOfImages(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultImageRest10|errorRetrieve a list of images
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the image was last updated.
Return Type
- QueryResultImageRest10|error - OK.
createForms
Isolated FunctionRemote Function
function createForms(FormRest10 payload) returns FormRest10|errorCreate a form
Parameters
- payload FormRest10 - The request body defines the details of the form to be created.
Return Type
- FormRest10|error - Success.
readForm
Isolated FunctionRemote Function
function readForm(int id, string? depth) returns FormRest10|errorRetrieve a form
Parameters
- id int - Id of the form.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- FormRest10|error - OK.
updateForm
Isolated FunctionRemote Function
function updateForm(int id, FormRest10 payload) returns FormRest10|errorUpdate a form
Parameters
- id int - Id of the form.
- payload FormRest10 - The request body defines the details of the form to be updated.
Return Type
- FormRest10|error - OK.
deleteForm
Isolated FunctionRemote Function
Delete a form
Parameters
- id int - Id of the form.
searchListOfForms
Isolated FunctionRemote Function
function searchListOfForms(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultFormRest10|errorRetrieve a list of forms
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the form was last updated.
Return Type
- QueryResultFormRest10|error - OK.
createEmailFolders
Isolated FunctionRemote Function
function createEmailFolders(FolderRest10 payload) returns FolderRest10|errorCreate an email folder
Parameters
- payload FolderRest10 - The request body defines the details of the email folder to be created.
Return Type
- FolderRest10|error - Success.
readEmailAsset
Isolated FunctionRemote Function
function readEmailAsset(int id, string? depth) returns FolderRest10|errorRetrieve an email folder
Parameters
- id int - Id of the email folder to retrieve.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- FolderRest10|error - OK.
updateEmailFolder
Isolated FunctionRemote Function
function updateEmailFolder(int id, FolderRest10 payload) returns FolderRest10|errorUpdate an email folder
Parameters
- id int - Id of the email folder to update.
- payload FolderRest10 - The request body defines the details of the email folder to be updated.
Return Type
- FolderRest10|error - OK.
deleteEmailFolder
Isolated FunctionRemote Function
Delete an email folder
Parameters
- id int - Id of the email folder to delete.
searchEmailFolders
Isolated FunctionRemote Function
function searchEmailFolders(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultFolderRest10|errorRetrieve a list of email folders
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - When the email folder was last updated.
Return Type
- QueryResultFolderRest10|error - OK.
createEmailHeaders
Isolated FunctionRemote Function
function createEmailHeaders(EmailHeaderRest10 payload) returns EmailHeaderRest10|errorCreate an email header
Parameters
- payload EmailHeaderRest10 - The request body defines the details of the email header to be updated.
Return Type
- EmailHeaderRest10|error - Success
readEmailHeaders
Isolated FunctionRemote Function
function readEmailHeaders(int id, string? depth) returns EmailHeaderRest10|errorRetrieve an email header
Parameters
- id int - Id of the email header to be retrieved.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- EmailHeaderRest10|error - OK.
updateEmailHeader
Isolated FunctionRemote Function
function updateEmailHeader(int id, EmailHeaderRest10 payload) returns EmailHeaderRest10|errorUpdate an email header
Parameters
- id int - Id of the email header to update.
- payload EmailHeaderRest10 - The request body defines the details of the email header to be created.
Return Type
- EmailHeaderRest10|error - OK.
deleteEmailHeaders
Isolated FunctionRemote Function
Delete an email header
Parameters
- id int - Id of the email header to be deleted.
searchEmailHeaders
Isolated FunctionRemote Function
function searchEmailHeaders(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultHeaderRest10|errorRetrieve a list of email headers
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - When the email header was last updated.
Return Type
- QueryResultHeaderRest10|error - OK.
createEmailGroups
Isolated FunctionRemote Function
function createEmailGroups(EmailGroupRest10 payload) returns EmailGroupRest10|errorCreate an email group
Parameters
- payload EmailGroupRest10 - The request body defines the details of the email group to be created.
Return Type
- EmailGroupRest10|error - Success.
readEmailGroup
Isolated FunctionRemote Function
function readEmailGroup(int id, string? depth) returns EmailGroupRest10|errorRetrieve an email group
Parameters
- id int - Id of the email group.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- EmailGroupRest10|error - OK.
updateEmailGroup
Isolated FunctionRemote Function
function updateEmailGroup(int id, EmailGroupRest10 payload) returns EmailGroupRest10|errorUpdate an email group
Parameters
- id int - Id of the email group to update.
- payload EmailGroupRest10 - The request body defines the details of the email group to be updated.
Return Type
- EmailGroupRest10|error - OK.
deleteEmailGroups
Isolated FunctionRemote Function
Delete an email group
Parameters
- id int - Id of the email group to delete.
searchEmailGroups
Isolated FunctionRemote Function
function searchEmailGroups(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultGroupRest10|errorRetrieve a list of email groups
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the email group was last updated.
Return Type
- QueryResultGroupRest10|error - OK.
createEmailFooters
Isolated FunctionRemote Function
function createEmailFooters(EmailFooterRest10 payload) returns EmailFooterRest10|errorCreate an email footer
Parameters
- payload EmailFooterRest10 - The request body defines the details of the email footer to be created.
Return Type
- EmailFooterRest10|error - Success.
readEmailFooter
Isolated FunctionRemote Function
function readEmailFooter(int id, string? depth) returns EmailFooterRest10|errorRetrieve an email footer
Parameters
- id int - Id of the email footer.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- EmailFooterRest10|error - OK.
updateEmailFooter
Isolated FunctionRemote Function
function updateEmailFooter(int id, EmailFooterRest10 payload) returns EmailFooterRest10|errorUpdate an email footer
Parameters
- id int - Id of the email footer to update.
- payload EmailFooterRest10 - The request body defines the details of the email footer to be updated.
Return Type
- EmailFooterRest10|error - OK.
deleteEmailFooters
Isolated FunctionRemote Function
Delete an email footer
Parameters
- id int - Id of the email footer to delete.
searchListOfEmailFooters
Isolated FunctionRemote Function
function searchListOfEmailFooters(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultFooterRest10|errorRetrieve a list of email footers
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the email footer was last updated.
Return Type
- QueryResultFooterRest10|error - OK.
createCustomObjects
Isolated FunctionRemote Function
function createCustomObjects(CustomObjectRest10 payload) returns CustomObjectRest10|errorCreate a custom object
Parameters
- payload CustomObjectRest10 - The request body defines the details of the custom object to be created.
Return Type
- CustomObjectRest10|error - Success
readCustomObjects
Isolated FunctionRemote Function
function readCustomObjects(int id, string? depth) returns CustomObjectRest10|errorRetrieve a custom object
Parameters
- id int - Id of the custom object.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- CustomObjectRest10|error - OK.
updateCustomObject
Isolated FunctionRemote Function
function updateCustomObject(int id, CustomObjectRest10 payload) returns CustomObjectRest10|errorUpdate a custom object
Parameters
- id int - Id of the custom object.
- payload CustomObjectRest10 - The request body defines the details of the custom object to be updated.
Return Type
- CustomObjectRest10|error - OK.
deleteCustomObjectSyncActionOperationData
Isolated FunctionRemote Function
Delete a custom object
Parameters
- id int - Id of the custom object.
searchCustomObjects
Isolated FunctionRemote Function
function searchCustomObjects(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultCustomObjectRest10|error?Retrieve a list of custom objects
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the custom object was last updated.
Return Type
createContentSections
Isolated FunctionRemote Function
function createContentSections(ContentSectionRest10 payload) returns ContentSectionRest10|errorCreate a content section
Parameters
- payload ContentSectionRest10 - The request body defines the details of the content section to be created.
Return Type
- ContentSectionRest10|error - Success
readContentSections
Isolated FunctionRemote Function
function readContentSections(int id, string? depth) returns ContentSectionRest10|errorRetrieve a content section
Parameters
- id int - Id of the content section.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
updateContentSection
Isolated FunctionRemote Function
function updateContentSection(int id, ContentSectionRest10 payload) returns ContentSectionRest10|errorUpdate a content section
Parameters
- id int - Id of the content section.
- payload ContentSectionRest10 - The request body defines the details of the content section to be updated.
Return Type
deleteContentSection
Isolated FunctionRemote Function
Delete a content section
Parameters
- id int - Id of the content section.
searchContentSections
Isolated FunctionRemote Function
function searchContentSections(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultContentSectionRest10|errorRetrieve a list of content sections
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the content section was last updated.
Return Type
readContactFields
Isolated FunctionRemote Function
function readContactFields(int id, string? depth) returns ContactFieldRest10|errorRetrieve a contact field
Parameters
- id int - Id of the contact field to be retrieved.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- ContactFieldRest10|error - OK
updateContactField
Isolated FunctionRemote Function
function updateContactField(int id, ContactFieldRest10 payload) returns ContactFieldRest10|errorUpdate a contact field
Parameters
- id int - Id of the contact field to be updated.
- payload ContactFieldRest10 - List of contact fields.
Return Type
- ContactFieldRest10|error - OK
deleteContactFields
Isolated FunctionRemote Function
Delete a contact field
Parameters
- id int - Id of the contact field to delete.
createContactFields
Isolated FunctionRemote Function
function createContactFields(ContactFieldRest10 payload) returns ContactFieldRest10|errorCreate a contact field
Parameters
- payload ContactFieldRest10 - The request body defines the details of the contact field to be created.
Return Type
- ContactFieldRest10|error - Success
searchContactFields
Isolated FunctionRemote Function
function searchContactFields(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultContactFieldRest10|error?Retrieve a list of contact fields
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the contact field was last updated.
Return Type
searchSecurityGroupsGETRest20
Isolated FunctionRemote Function
function searchSecurityGroupsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultSecurityGroupRest20|errorRetrieve security groups
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. The default value is <code>minimal</code>.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the security group was last updated.
Return Type
getUsersGETRest20
Isolated FunctionRemote Function
function getUsersGETRest20(int id) returns QueryResultSecurityGroupUserRest20|errorRetrieve a list of users
Parameters
- id int - The security group id, from which you want to retrieve users
Return Type
searchVisitorDataGETRest20
Isolated FunctionRemote Function
function searchVisitorDataGETRest20(int? count, int? page, string? search, string? orderBy, string? depth) returns QueryResultVisitorViewDataRest20|errorRetrieve visitor data
Parameters
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - Specifies which page of visitors to return (the <code>count</code> parameter defines the number of visitors per page). If the <code>page</code> parameter is not supplied, 1 will be used by default.
- search string? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered. Possible values include: <code>visitorId</code>, <code>contactId</code>, <code>externalId</code>, <code>customerGuid</code>, <code>v_IPAddress</code>, and <code>v_LastVisitDateAndTime</code>.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
Return Type
searchPostSEARCHRest20
Isolated FunctionRemote Function
function searchPostSEARCHRest20(string xHttpMethodOverride, EntitySearchByExternalIdsRest20 payload) returns QueryResultVisitorViewDataRest20|errorRetrieve visitor data by visitor GUID
Parameters
- xHttpMethodOverride string - The request header <code>X-HTTP-Method-Override</code> must be set with value <code>SEARCH</code>.
- payload EntitySearchByExternalIdsRest20 - The request body defines the details of the request.
Return Type
queueReportExportPOSTRest20
Isolated FunctionRemote Function
function queueReportExportPOSTRest20(AuditLogReportRequestRest20 payload) returns Response|errorInitiate an audit log export
Parameters
- payload AuditLogReportRequestRest20 - Audit log export request
Return Type
listGroupMembershipForAccountGETRest20
Isolated FunctionRemote Function
function listGroupMembershipForAccountGETRest20(int id) returns AccountGroupRest20|errorRetrieve account group membership information for an account
Parameters
- id int - Id of the account to retrieve.
Return Type
- AccountGroupRest20|error - OK.
searchAccountsSEARCHRest20
Isolated FunctionRemote Function
function searchAccountsSEARCHRest20(string xHttpMethodOverride, EntitySearchByIdsRest20 payload) returns AccountRest20|errorRetrieve account information
Parameters
- xHttpMethodOverride string - The request header <code>X-HTTP-Method-Override</code> must be set with value <code>SEARCH</code>.
- payload EntitySearchByIdsRest20 - The request body defines the details of the request.
Return Type
- AccountRest20|error - OK.
createIndividualExternalActivityPOSTRest20
Isolated FunctionRemote Function
function createIndividualExternalActivityPOSTRest20(ExternalActivitiesRest20 payload) returns ExternalActivitiesRest20|errorCreate an external activity
Parameters
- payload ExternalActivitiesRest20 - The request body defines the details of the external activity to be created.
Return Type
- ExternalActivitiesRest20|error - Success.
readIndividualExternalActivityGETRest20
Isolated FunctionRemote Function
function readIndividualExternalActivityGETRest20(int id) returns ExternalActivitiesRest20|errorRetrieve an external activity
Parameters
- id int - Id of the external activity to retrieve.
Return Type
createIndividualEventRegistrantsPOSTRest20
Isolated FunctionRemote Function
function createIndividualEventRegistrantsPOSTRest20(int parentId, EventRegistrationDataRest20 payload) returns EventRegistrationDataRest20|errorCreate an event registrant
Parameters
- parentId int - Id of the parent event.
- payload EventRegistrationDataRest20 - The request body defines the details of the event registrant to be created.
Return Type
- EventRegistrationDataRest20|error - Success.
readIndividualEventRegistrantGETRest20
Isolated FunctionRemote Function
function readIndividualEventRegistrantGETRest20(int parentId, int id, string? depth) returns EventRegistrationDataRest20|errorRetrieve an event registrant
Parameters
- parentId int - Id of the parent event.
- id int - Id of the event registrant.
- depth string? (default ()) - This parameter is not used for this endpoint.
Return Type
updateIndividualEventRegistrantPUTRest20
Isolated FunctionRemote Function
function updateIndividualEventRegistrantPUTRest20(int parentId, int id, EventRegistrationDataRest20 payload) returns EventRegistrationDataRest20|errorUpdate an event registrant
Parameters
- parentId int - Id of the parent event.
- id int - Id of the event registrant.
- payload EventRegistrationDataRest20 - The request body defines the details of the event registrant to be updated. Note: Only <code>fieldValues</code> and <code>contactId</code> can be updated. <code>fieldValues</code> is required, even if not updating any fields. To update <code>contactId</code>, include <code>fieldValues</code> with an empty array.
Return Type
deleteEvent
Isolated FunctionRemote Function
Delete an event registrant
searchListOfEventRegistrantsGETRest20
Isolated FunctionRemote Function
function searchListOfEventRegistrantsGETRest20(int parentId, string? depth, int? count, int? page, string? search, string? orderBy) returns QueryResultEventRegistrationDataRest20|errorRetrieve a list of event registrants
Parameters
- parentId int - Id of the parent event.
- depth string? (default ()) - This parameter is not used for this endpoint.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - Specifies which page of event registrant to return (the count parameter defines the number of event registrant assets per page). If the page parameter is not supplied, 1 will be used by default.
- search string? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
Return Type
createIndividualLandingPagePOSTRest20
Isolated FunctionRemote Function
function createIndividualLandingPagePOSTRest20(LandingPageRest20 payload) returns LandingPageRest20|errorCreate a landing page
Parameters
- payload LandingPageRest20 - The request body defines the details of the landing page to be created.
Return Type
- LandingPageRest20|error - Success.
readIndividualLandingPageGETRest20
Isolated FunctionRemote Function
function readIndividualLandingPageGETRest20(int id, string? depth, boolean? noMergeContent) returns LandingPageRest20|errorRetrieve a landing page
Parameters
- id int - Id of the landing page to retrieve.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- noMergeContent boolean? (default ()) - Whether landing page components are dynamically populated upon retrieve. If set to true, landing page components are populated. If set to false, the default content of the landing page component will be returned. The default is true.
Return Type
- LandingPageRest20|error - OK.
updateIndividualLandingPagePUTRest20
Isolated FunctionRemote Function
function updateIndividualLandingPagePUTRest20(int id, LandingPageRest20 payload) returns LandingPageRest20|errorUpdate a landing page
Parameters
- id int - Id of the landing page to update.
- payload LandingPageRest20 - The request body defines the details of the landing page to be updated.
Return Type
- LandingPageRest20|error - OK.
deleteLandingPage
Isolated FunctionRemote Function
Delete a landing page
Parameters
- id int - Id of the landing page to delete.
searchListOfLandingPagesGETRest20
Isolated FunctionRemote Function
function searchListOfLandingPagesGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultLandingPageRest20|errorRetrieve a list of landing pages
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered, and the direction. The direction will default to ASC if not specified. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAC/APIRequests_URLParameters.html'>URL parameters</a> for information.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the external asset was last updated.
Return Type
createIndividualEventPOSTRest20
Isolated FunctionRemote Function
function createIndividualEventPOSTRest20(EventRegistrationRest20 payload) returns EventRegistrationRest20|errorCreate an event
Parameters
- payload EventRegistrationRest20 - The request body defines the details of the event to be created.
Return Type
- EventRegistrationRest20|error - Success.
readIndividualEventGETRest20
Isolated FunctionRemote Function
function readIndividualEventGETRest20(int id, string? depth) returns EventRegistrationRest20|errorRetrieve an event
Parameters
- id int - Id of the event.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- EventRegistrationRest20|error - OK.
updateIndividualEventPUTRest20
Isolated FunctionRemote Function
function updateIndividualEventPUTRest20(int id, EventRegistrationRest20 payload) returns EventRegistrationRest20|errorUpdate an event
Parameters
- id int - Id of the event.
- payload EventRegistrationRest20 - The request body defines the details of the event to be updated.
Return Type
- EventRegistrationRest20|error - OK.
deleteEventRest20
Isolated FunctionRemote Function
Delete an event
Parameters
- id int - Id of the event.
searchListOfEventsGETRest20
Isolated FunctionRemote Function
function searchListOfEventsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultEventRegistrationRest20|errorRetrieve a list of events
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the event was last updated.
Return Type
createIndividualExternalAssetPOSTRest20
Isolated FunctionRemote Function
function createIndividualExternalAssetPOSTRest20(ExternalAssetRest20 payload) returns ExternalAssetRest20|errorCreate an external asset
Parameters
- payload ExternalAssetRest20 - The request body defines the details of the external asset to be created.
Return Type
- ExternalAssetRest20|error - Success.
readIndividualExternalAssetGETRest20
Isolated FunctionRemote Function
function readIndividualExternalAssetGETRest20(int id, string? depth) returns ExternalAssetRest20|errorRetrieve an external asset
Parameters
- id int - Id of the external asset.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- ExternalAssetRest20|error - OK.
updateIndividualExternalAssetPUTRest20
Isolated FunctionRemote Function
function updateIndividualExternalAssetPUTRest20(int id, ExternalAssetRest20 payload) returns ExternalAssetRest20|errorUpdate an external asset
Parameters
- id int - Id of the external asset.
- payload ExternalAssetRest20 - The request body defines the details of the external asset to be updated.
Return Type
- ExternalAssetRest20|error - OK.
deleteExternalAsset
Isolated FunctionRemote Function
Delete an external asset
Parameters
- id int - Id of the external asset to delete.
searchListOfExternalAssetsGETRest20
Isolated FunctionRemote Function
function searchListOfExternalAssetsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultExternalAssetRest20|errorRetrieve a list of external assets
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the external asset was last updated.
Return Type
createIndividualExternalAssetTypePOSTRest20
Isolated FunctionRemote Function
function createIndividualExternalAssetTypePOSTRest20(ExternalAssetTypeRest20 payload) returns ExternalAssetTypeRest20|errorCreate an external asset type
Parameters
- payload ExternalAssetTypeRest20 - The request body defines the details of the external asset type to be created.
Return Type
- ExternalAssetTypeRest20|error - Success.
readIndividualExternalAssetTypeGETRest20
Isolated FunctionRemote Function
function readIndividualExternalAssetTypeGETRest20(int id, string? depth) returns ExternalAssetTypeRest20|errorRetrieve an external asset type
Parameters
- id int - Id of the external asset type to retrieve.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- ExternalAssetTypeRest20|error - OK.
updateIndividualExternalAssetTypesPUTRest20
Isolated FunctionRemote Function
function updateIndividualExternalAssetTypesPUTRest20(int id, ExternalAssetTypeRest20 payload) returns ExternalAssetTypeRest20|errorUpdate an external asset type
Parameters
- id int - Id of the external asset type to update.
- payload ExternalAssetTypeRest20 - The request body defines the details of the external asset type to be updated.
Return Type
- ExternalAssetTypeRest20|error - OK.
deleteExternalAssetType
Isolated FunctionRemote Function
Delete an external asset type
Parameters
- id int - Id of the external asset type.
searchListOfExternalAssetTypesGETRest20
Isolated FunctionRemote Function
function searchListOfExternalAssetTypesGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultExternalAssetTypeRest20|errorRetrieve a list of external asset types
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the external asset was last updated.
Return Type
createIndividualCustomObjectPOSTRest20
Isolated FunctionRemote Function
function createIndividualCustomObjectPOSTRest20(CustomObjectRest20 payload) returns CustomObjectRest20|errorCreate a custom object
Parameters
- payload CustomObjectRest20 - The request body defines the details of the custom object to be created.
Return Type
- CustomObjectRest20|error - Success.
readIndividualCustomObjectGETRest20
Isolated FunctionRemote Function
function readIndividualCustomObjectGETRest20(int id, string? depth) returns CustomObjectRest20|errorRetrieve a custom object
Parameters
- id int - Id of the custom object
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- CustomObjectRest20|error - OK.
updateIndividualCustomObjectsPUTRest20
Isolated FunctionRemote Function
function updateIndividualCustomObjectsPUTRest20(int id, CustomObjectRest20 payload) returns CustomObjectRest20|errorUpdate a custom object
Parameters
- id int - Id of the custom object.
- payload CustomObjectRest20 - The request body defines the details of the custom object to be updated.
Return Type
- CustomObjectRest20|error - OK.
deleteCustomObject
Isolated FunctionRemote Function
Delete a custom object
Parameters
- id int - Id of the custom object
searchListOfCustomObjectsGETRest20
Isolated FunctionRemote Function
function searchListOfCustomObjectsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultCustomObjectRest20|errorRetrieve a list of custom objects
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the custom object was last updated.
Return Type
getVisitorProfileFieldsGETRest20
Isolated FunctionRemote Function
function getVisitorProfileFieldsGETRest20(int? page, int? count) returns QueryResultProfileFieldRest20|errorRetrieve a list of visitor profile fields
Parameters
- page int? (default ()) - Specifies which page of visitor profile fields to return (the count parameter defines the number of visitor profile fields per page). If the page parameter is not supplied, 1 will be used by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
Return Type
createIndividualProgramsPOSTRest20
Isolated FunctionRemote Function
function createIndividualProgramsPOSTRest20(ProgramRest20 payload) returns ProgramRest20|errorCreate a program
Parameters
- payload ProgramRest20 - The request body defines the details of the program to be created.
Return Type
- ProgramRest20|error - Created
readIndividualProgramGETRest20
Isolated FunctionRemote Function
function readIndividualProgramGETRest20(int id, string? depth) returns ProgramRest20|errorRetrieve a program
Parameters
- id int - Id of the program to retrieve.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
- ProgramRest20|error - OK
updateIndividualProgramsPUTRest20
Isolated FunctionRemote Function
function updateIndividualProgramsPUTRest20(int id, ProgramRest20 payload) returns ProgramRest20|errorUpdate a program
Parameters
- id int - Id of the program to update.
- payload ProgramRest20 - The request body defines the details of the program to be updated.
Return Type
- ProgramRest20|error - OK
deleteProgram
Isolated FunctionRemote Function
Delete a program
Parameters
- id int - Id of the program to delete.
activateProgramPOSTRest20
Isolated FunctionRemote Function
function activateProgramPOSTRest20(int id, string? scheduledFor, int? runAsUserId) returns ProgramRest20|errorActivate a program
Parameters
- id int - Id of the program.
- scheduledFor string? (default ()) - The date and time for the program to activate on expressed in Unix time. Alternatively, you can activate the campaign immediately by specifying <code>now</code>.
- runAsUserId int? (default ()) - The username to activate the program
Return Type
- ProgramRest20|error - Created
deactivateProgramPOSTRest20
Isolated FunctionRemote Function
function deactivateProgramPOSTRest20(int id) returns ProgramRest20|errorDeactivate a program
Parameters
- id int - Id of the program to deactivate.
Return Type
- ProgramRest20|error - Created
pauseIndividualPOSTRest20
Isolated FunctionRemote Function
function pauseIndividualPOSTRest20(int id) returns ProgramRest20|errorPause a program
Parameters
- id int - Id of the program to pause.
Return Type
- ProgramRest20|error - Success
searchListOfProgramsGETRest20
Isolated FunctionRemote Function
function searchListOfProgramsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultProgramRest20|errorRetrieve a list of programs
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. The default value is <code>minimal</code>.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - The date and time the program was last updated.
Return Type
createIndividualContactPOSTRest20
Isolated FunctionRemote Function
function createIndividualContactPOSTRest20(ContactSegmentRest20 payload) returns ContactSegmentRest20|errorCreate a contact segment
Parameters
- payload ContactSegmentRest20 - The request body defines the details of the contact segment to be created.
Return Type
- ContactSegmentRest20|error - Success
createCopyPOSTRest20
Isolated FunctionRemote Function
function createCopyPOSTRest20(int id, ContactSegmentRest20 payload) returns ContactSegmentRest20|errorCreate a copy of a contact segment
Parameters
- id int - Id of the segment to copy.
- payload ContactSegmentRest20 - The request body defines the details of the contact segment to be created from the source contact segment.
Return Type
- ContactSegmentRest20|error - Created
readIndividualContactGETRest20
Isolated FunctionRemote Function
function readIndividualContactGETRest20(int id, string? depth) returns ContactSegmentRest20|errorRetrieve a contact segment
Parameters
- id int - Id of the contact segment.
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
Return Type
updateIndividualContactSegmentsPUTRest20
Isolated FunctionRemote Function
function updateIndividualContactSegmentsPUTRest20(int id, ContactSegmentRest20 payload) returns ContactSegmentRest20|errorUpdate a contact segment
Parameters
- id int - Id of the contact segment.
- payload ContactSegmentRest20 - The request body defines the details of the contact segment to be update.
Return Type
deleteContactSegmentRest20
Isolated FunctionRemote Function
Delete a contact segment
Parameters
- id int - Id of the contact segment.
searchListOfContactSegmentsGETRest20
Isolated FunctionRemote Function
function searchListOfContactSegmentsGETRest20(string? depth, int? count, int? page, string? search, string? orderBy, int? lastUpdatedAt) returns QueryResultSegmentRest20|errorRetrieve a list of contact segments
Parameters
- depth string? (default ()) - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.
- count int? (default ()) - Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
- page int? (default ()) - 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? (default ()) - Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
- orderBy string? (default ()) - Specifies the field by which list results are ordered.
- lastUpdatedAt int? (default ()) - Unix timestamp for the date and time the contact segment was last updated.
Return Type
getContactExportSearch
Isolated FunctionRemote Function
function getContactExportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact export definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postContactExportIndividual
Isolated FunctionRemote Function
function postContactExportIndividual(ContactExportIndividual payload) returns json|errorCreate a contact export definition
Parameters
- payload ContactExportIndividual - The request body contains details of the contact export definition.
Return Type
- json|error - Success.
getContactExportIndividual
Isolated FunctionRemote Function
Retrieve a contact export definition
Parameters
- id int - Part of the uri used to identify the contact export.
Return Type
- json|error - OK.
putContactExportIndividual
Isolated FunctionRemote Function
function putContactExportIndividual(int id, Contactexportindividual2 payload) returns json|errorUpdate a contact export definition
Parameters
- id int - Part of the uri used to identify the contact export.
- payload Contactexportindividual2 - The request body contains details of the contact export definition.
Return Type
- json|error - OK.
deleteContactExportIndividual
Isolated FunctionRemote Function
Delete a contact export definition
Parameters
- id int - Part of the uri used to identify the contact export.
getContactExportDataQuery
Isolated FunctionRemote Function
function getContactExportDataQuery(int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve a contact export definition's synced data
Parameters
- id int - Part of the uri used to identify the contact export.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
deleteContactExportDataQuery
Isolated FunctionRemote Function
Delete a contact export definition's data
Parameters
- id int - Part of the uri used to identify the contact export.
getContactFieldIndividual
Isolated FunctionRemote Function
Retrieve a contact field definition
Parameters
- id int - Part of the uri used to identify the contact field.
Return Type
- json|error - OK.
getContactFieldSearch
Isolated FunctionRemote Function
function getContactFieldSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact field definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getContactFilterIndividual
Isolated FunctionRemote Function
Retrieve a contact filter
Parameters
- id int - Number of results returned in the request.
Return Type
- json|error - OK.
getContactFilterSearch
Isolated FunctionRemote Function
function getContactFilterSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact filters
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getContactImportSearch
Isolated FunctionRemote Function
function getContactImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postContactImportIndividual
Isolated FunctionRemote Function
function postContactImportIndividual(ContactImportIndividual payload) returns json|errorCreate a contact import definition
Parameters
- payload ContactImportIndividual - The request body contains details of the contact import definition.
Return Type
- json|error - Success.
getContactImportIndividual
Isolated FunctionRemote Function
Retrieve a contact import definition
Parameters
- id int - Part of the uri used to identify the contact import.
Return Type
- json|error - OK.
putContactImportIndividual
Isolated FunctionRemote Function
function putContactImportIndividual(int id, Contactimportindividual2 payload) returns json|errorUpdate a contact import definition
Parameters
- id int - Part of the uri used to identify the contact import.
- payload Contactimportindividual2 - The request body contains details of the contact import definition.
Return Type
- json|error - OK.
deleteContactImportIndividual
Isolated FunctionRemote Function
Delete a contact import definition
Parameters
- id int - Part of the uri used to identify the contact import.
postContactImportData
Isolated FunctionRemote Function
Upload data for a contact import definition
Parameters
- id int - Part of the uri used to identify the contact import.
- payload record {}[] - The request body contains data to be uploaded to the contact import definition.
Return Type
- json|error? - Success.
deleteContactImportData
Isolated FunctionRemote Function
Delete a contact import definition's data
Parameters
- id int - Part of the uri used to identify the contact import.
getContactListIndividual
Isolated FunctionRemote Function
Retrieve a contact list
Parameters
- id int - Part of the uri used to identify the contact list.
Return Type
- json|error - OK.
getContactListSearch
Isolated FunctionRemote Function
function getContactListSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact lists
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getLeadScoreModelIndividual
Isolated FunctionRemote Function
Retrieve a lead scoring model
Parameters
- id int - Id of the lead scoring model.
Return Type
- json|error - OK.
getLeadScoreModelSearch
Isolated FunctionRemote Function
function getLeadScoreModelSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of lead scoring models
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getContactSegmentIndividual
Isolated FunctionRemote Function
Retrieve a contact segment
Parameters
- id int - Part of the uri used to identify the contact segment.
Return Type
- json|error - OK.
getContactSegmentSearch
Isolated FunctionRemote Function
function getContactSegmentSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact segments
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a segment of relations separated by comma ",". For example, ?links=canonical,next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getContactSyncActionOperationSearch
Isolated FunctionRemote Function
function getContactSyncActionOperationSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of contact sync action definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postContactSyncActionOperationIndividual
Isolated FunctionRemote Function
function postContactSyncActionOperationIndividual(ContactSyncActionOperationIndividual payload) returns json|errorCreate a contact sync action definition
Parameters
- payload ContactSyncActionOperationIndividual - The request body contains details of the contact sync action definition.
Return Type
- json|error - Success.
getContactSyncActionOperationIndividual
Isolated FunctionRemote Function
Retrieve a contact sync action definition
Parameters
- id int - The sync action definition's resource identification number.
Return Type
- json|error - OK.
putContactSyncActionOperationIndividual
Isolated FunctionRemote Function
function putContactSyncActionOperationIndividual(int id, Contactsyncactionoperationindividual2 payload) returns json|errorUpdate a contact sync action definition
Parameters
- id int - The sync action definition's resource identification number.
- payload Contactsyncactionoperationindividual2 - The request body contains details of the contact sync action definition.
Return Type
- json|error - OK.
deleteContactSyncActionOperationIndividual
Isolated FunctionRemote Function
Delete a contact sync action definition
Parameters
- id int - The sync action definition's resource identification number.
postContactSyncActionOperationData
Isolated FunctionRemote Function
Upload contact sync action data
Parameters
- id int - The sync action definition's resource identification number.
- payload record {}[] - The request body contains details of the contact sync action data.
Return Type
- json|error? - Success.
deleteContactSyncActionOperationData
Isolated FunctionRemote Function
Delete sync data for a contact sync action definition
Parameters
- id int - The sync action definition's resource identification number.
getAccountExportSearch
Isolated FunctionRemote Function
function getAccountExportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of account export definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postAccountExportIndividual
Isolated FunctionRemote Function
function postAccountExportIndividual(AccountExportIndividual payload) returns json|errorCreate an account export definition
Parameters
- payload AccountExportIndividual - The request body contains details of the account export definition.
Return Type
- json|error - Success.
getAccountExportIndividual
Isolated FunctionRemote Function
Retrieve an account export definition
Parameters
- id int - Part of the uri used to identify the account export.
Return Type
- json|error - OK.
putAccountExportIndividual
Isolated FunctionRemote Function
function putAccountExportIndividual(int id, Accountexportindividual2 payload) returns json|errorUpdate an account export definition
Parameters
- id int - Part of the uri used to identify the account export.
- payload Accountexportindividual2 - The request body contains details of the account export definition.
Return Type
- json|error - OK.
deleteAccountExportIndividual
Isolated FunctionRemote Function
Delete an account export definition
Parameters
- id int - Part of the uri used to identify the account export.
getAccountExportDataQuery
Isolated FunctionRemote Function
function getAccountExportDataQuery(int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve an account export definition's synced data
Parameters
- id int - Part of the uri used to identify the account export.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
deleteAccountExportDataQuery
Isolated FunctionRemote Function
Delete an account export definition's data
Parameters
- id int - Part of the uri used to identify the account export.
getAccountFieldIndividual
Isolated FunctionRemote Function
Retrieve an account field definition
Parameters
- id int - Part of the uri used to identify the account field.
Return Type
- json|error - OK.
getAccountFieldSearch
Isolated FunctionRemote Function
function getAccountFieldSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of account field definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getAccountImportSearch
Isolated FunctionRemote Function
function getAccountImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of account import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postAccountImportIndividual
Isolated FunctionRemote Function
function postAccountImportIndividual(AccountImportIndividual payload) returns json|errorCreate an account import definition
Parameters
- payload AccountImportIndividual - The request body contains details of the account import definition.
Return Type
- json|error - Success.
getAccountImportIndividual
Isolated FunctionRemote Function
Retrieve an account import definition
Parameters
- id int - Part of the uri used to identify the account import.
Return Type
- json|error - OK.
putAccountImportIndividual
Isolated FunctionRemote Function
function putAccountImportIndividual(int id, Accountimportindividual2 payload) returns json|errorUpdate an account import definition
Parameters
- id int - Part of the uri used to identify the account import.
- payload Accountimportindividual2 - The request body contains details of the account import definition.
Return Type
- json|error - OK.
deleteAccountImportIndividual
Isolated FunctionRemote Function
Delete an account import definition
Parameters
- id int - Part of the uri used to identify the account import.
postAccountImportData
Isolated FunctionRemote Function
Upload data for a specified account import definition
Parameters
- id int - Part of the uri used to identify the account import.
- payload record {}[] - The request body contains data to be uploaded to the account import definition.
Return Type
- json|error? - Success.
deleteAccountImportData
Isolated FunctionRemote Function
Delete an account import definition's data
Parameters
- id int - Part of the uri used to identify the account import.
getAccountListIndividual
Isolated FunctionRemote Function
Retrieve an account list definition
Parameters
- id int - The account field definition's unique resource identifier.
Return Type
- json|error - OK.
getAccountListSearch
Isolated FunctionRemote Function
function getAccountListSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of account list definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getAccountSyncActionOperationSearch
Isolated FunctionRemote Function
function getAccountSyncActionOperationSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of account sync action definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postAccountSyncActionOperationIndividual
Isolated FunctionRemote Function
function postAccountSyncActionOperationIndividual(AccountSyncActionOperationIndividual payload) returns json|errorCreate an account sync action definition
Parameters
- payload AccountSyncActionOperationIndividual - The request body defines details of the account sync action definition.
Return Type
- json|error - Success.
getAccountSyncActionOperationIndividual
Isolated FunctionRemote Function
Retrieve an account sync action definition
Parameters
- id int - The sync action definition's resource identification number.
Return Type
- json|error - Success.
putAccountSyncActionOperationIndividual
Isolated FunctionRemote Function
function putAccountSyncActionOperationIndividual(int id, Accountsyncactionoperationindividual2 payload) returns json|errorUpdate an account sync action definition
Parameters
- id int - The sync action definition's resource identification number.
- payload Accountsyncactionoperationindividual2 - The request body defines details of the account sync action definition.
Return Type
- json|error - Success.
deleteAccountSyncActionOperationIndividual
Isolated FunctionRemote Function
Delete an account sync action definition
Parameters
- id int - The sync action definition's resource identification number.
postAccountSyncActionOperationData
Isolated FunctionRemote Function
Upload account sync action data
Parameters
- id int - The sync action definition's resource identification number.
- payload record {}[] - The request body contains details of the account sync action data.
Return Type
- json|error? - Success.
deleteAccountSyncActionOperationData
Isolated FunctionRemote Function
Delete sync data for an account sync action definition
Parameters
- id int - The sync action definition's resource identification number.
getActivityExportSearch
Isolated FunctionRemote Function
function getActivityExportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of activity export definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postActivityExportIndividual
Isolated FunctionRemote Function
function postActivityExportIndividual(ActivityExportIndividual payload) returns json|errorCreate an activity export definition
Parameters
- payload ActivityExportIndividual - The request body contains details of the activity export definition.
Return Type
- json|error - Success.
getActivityExportIndividual
Isolated FunctionRemote Function
Retrieve an activity export definition
Parameters
- id int - Part of the uri used to identify the activity export.
Return Type
- json|error - OK.
putActivityExportIndividual
Isolated FunctionRemote Function
function putActivityExportIndividual(int id, Activityexportindividual2 payload) returns json|errorUpdate an activity export definition
Parameters
- id int - Part of the uri used to identify the activity export.
- payload Activityexportindividual2 - The request body contains details of the activity export definition.
Return Type
- json|error - OK.
deleteActivityExportIndividual
Isolated FunctionRemote Function
Delete an activity export definition
Parameters
- id int - Part of the uri used to identify the activity export.
getActivityExportDataQuery
Isolated FunctionRemote Function
function getActivityExportDataQuery(int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve an activity export's synced data
Parameters
- id int - Part of the uri used to identify the activity export.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
deleteActivityExportDataQuery
Isolated FunctionRemote Function
Delete an activity export definition's data
Parameters
- id int - Part of the uri used to identify the activity export.
getActivityFieldIndividual
Isolated FunctionRemote Function
Retrieve an activity field definition
Parameters
- id int - Part of the uri used to identify the activity field.
Return Type
- json|error - OK.
getActivityFieldSearch
Isolated FunctionRemote Function
function getActivityFieldSearch(string? activityType, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of activity field definitions
Parameters
- activityType string? (default ()) - The activity type to filter results. Possible values include: <code>EmailOpen</code>, <code>EmailClickthrough</code>, <code>EmailSend</code>, <code>Subscribe</code>, <code>Unsubscribe</code>, <code>Bounceback</code>, <code>WebVisit</code>, <code>PageView</code>, and <code>FormSubmit</code>. Refer to <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ActivityFields'>Activity Fields</a> for a list of activity fields for each activity type.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getActivityImportSearch
Isolated FunctionRemote Function
function getActivityImportSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of activity import definitions
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postActivityImportIndividual
Isolated FunctionRemote Function
function postActivityImportIndividual(ActivityImportIndividual payload) returns json|errorCreate an activity import definition
Parameters
- payload ActivityImportIndividual - The request body contains details of the activity import defintion.
Return Type
- json|error - Success.
getActivityImportIndividual
Isolated FunctionRemote Function
Retrieve an activity import definition
Parameters
- id int - The activity import definition's resource identification number.
Return Type
- json|error - OK.
putActivityImportIndividual
Isolated FunctionRemote Function
function putActivityImportIndividual(int id, Activityimportindividual2 payload) returns json|errorUpdate an activity import definition
Parameters
- id int - The activity import definition's resource identification number.
- payload Activityimportindividual2 - The request body contains details of the activity import defintion.
Return Type
- json|error - OK.
deleteActivityImportIndividual
Isolated FunctionRemote Function
Delete an activity import definition
Parameters
- id int - The activity import definition's resource identification number.
postActivityImportData
Isolated FunctionRemote Function
Upload data for a specified activity import definition
Parameters
- id int - The activity import definition's resource identification number.
- payload record {}[] - The request body contains data to be uploaded to the activity import definition.
Return Type
- json|error? - OK.
deleteActivityImportData
Isolated FunctionRemote Function
Delete an activity import definition's data
Parameters
- id int - The activity import definition's resource identification number.
getCustomObjectIndividual
Isolated FunctionRemote Function
Retrieve a custom object
Parameters
- parentId int - The sync action definition's resource identification number.
Return Type
- json|error - OK.
getCustomObjectExportSearch
Isolated FunctionRemote Function
function getCustomObjectExportSearch(int parentId, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of export definitions for a custom object
Parameters
- parentId int - The sync action definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postCustomObjectExportIndividual
Isolated FunctionRemote Function
function postCustomObjectExportIndividual(int parentId, CustomObjectExportIndividual payload) returns json|errorCreate an export definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- payload CustomObjectExportIndividual - The request body contains details of the custom object export definition.
Return Type
- json|error - Success.
getCustomObjectFieldSearch
Isolated FunctionRemote Function
function getCustomObjectFieldSearch(int parentId, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of the fields for a custom object
Parameters
- parentId int - The sync action definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
getCustomObjectImportSearch
Isolated FunctionRemote Function
function getCustomObjectImportSearch(int parentId, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of import definitions for a custom object
Parameters
- parentId int - The sync action definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postCustomObjectImportIndividual
Isolated FunctionRemote Function
function postCustomObjectImportIndividual(int parentId, CustomObjectImportIndividual payload) returns json|errorCreate an import definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- payload CustomObjectImportIndividual - The request body contains details of the custom object import definition.
Return Type
- json|error - Success.
getCustomObjectSyncActionOperationSearch
Isolated FunctionRemote Function
function getCustomObjectSyncActionOperationSearch(int parentId, int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of sync action definitions for a custom object
Parameters
- parentId int - The sync action definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
postCustomObjectSyncActionOperationIndividual
Isolated FunctionRemote Function
function postCustomObjectSyncActionOperationIndividual(int parentId, CustomObjectSyncActionOperationIndividual payload) returns json|errorCreate a custom object sync action definition
Parameters
- parentId int - The custom object's resource identification number.
- payload CustomObjectSyncActionOperationIndividual - The request body contains details of the custom object sync action definition.
Return Type
- json|error - Success.
getCustomObjectExportIndividual
Isolated FunctionRemote Function
Retrieve the specified export definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- id int - The custom object export definition's resource identification number.
Return Type
- json|error - OK.
putCustomObjectExportIndividual
Isolated FunctionRemote Function
function putCustomObjectExportIndividual(int parentId, int id, Customobjectexportindividual2 payload) returns json|errorUpdate an export definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- id int - The custom object export definition's resource identification number.
- payload Customobjectexportindividual2 - The request body contains details of the custom object export definition.
Return Type
- json|error - OK.
deleteCustomObjectExportIndividual
Isolated FunctionRemote Function
Delete a custom object export definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The custom object export definition's resource identification number.
getCustomObjectExportDataQuery
Isolated FunctionRemote Function
function getCustomObjectExportDataQuery(int parentId, int id, int? 'limit, string? links, int? offset, boolean? totalResults) returns json|errorRetrieve the synced data for a custom object export definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The custom object export definition's resource identification number.
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
deleteCustomObjectExportDataQuery
Isolated FunctionRemote Function
Delete the synced data for a custom object export definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The custom object export definition's resource identification number.
getCustomObjectFieldIndividual
Isolated FunctionRemote Function
Retrieve a custom object field definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The custom object's resource identification number.
Return Type
- json|error - OK.
getCustomObjectImportIndividual
Isolated FunctionRemote Function
Retrieve an import definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- id int - The import definition's resource identification number.
Return Type
- json|error - OK.
putCustomObjectImportIndividual
Isolated FunctionRemote Function
function putCustomObjectImportIndividual(int parentId, int id, Customobjectimportindividual2 payload) returns json|errorUpdate an import definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- id int - The import definition's resource identification number.
- payload Customobjectimportindividual2 - The request body contains details of the custom object import definition.
Return Type
- json|error - OK.
deleteCustomObjectImportIndividual
Isolated FunctionRemote Function
Delete a custom object import definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The import definition's resource identification number.
postCustomObjectImportData
Isolated FunctionRemote Function
Upload data for a custom object import definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The import definition's resource identification number.
- payload record {}[] - The request body contains data to be uploaded to the custom object import definition.
Return Type
- json|error? - Success.
deleteCustomObjectImportData
Isolated FunctionRemote Function
Delete synced data for a custom object import definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The import definition's resource identification number.
getCustomObjectSyncActionOperationIndividual
Isolated FunctionRemote Function
Retrieve a custom object sync action definition for a custom object
Parameters
- parentId int - The custom object's resource identification number.
- id int - The sync action definition's resource identification number.
Return Type
- json|error - OK.
putCustomObjectSyncActionOperationIndividual
Isolated FunctionRemote Function
function putCustomObjectSyncActionOperationIndividual(int parentId, int id, Customobjectsyncactionoperationindividual2 payload) returns json|errorUpdate a custom object sync action definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The sync action definition's resource identification number.
- payload Customobjectsyncactionoperationindividual2 - The request body contains details of the custom object sync action definition.
Return Type
- json|error - OK.
deleteCustomObjectSyncActionOperationIndividual
Isolated FunctionRemote Function
function deleteCustomObjectSyncActionOperationIndividual(int parentId, int id) returns Response|errorDelete a custom object sync action definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The sync action definition's resource identification number.
postCustomObjectSyncActionOperationData
Isolated FunctionRemote Function
function postCustomObjectSyncActionOperationData(int parentId, int id, record {}[] payload) returns json|error?Upload custom object sync action data
Parameters
- parentId int - The custom object's resource identification number.
- id int - The sync action definition's resource identification number.
- payload record {}[] - The request body contains details of the custom object sync action definition.
Return Type
- json|error? - Success.
deleteRest20CustomObjectSyncActionOperationData
Isolated FunctionRemote Function
function deleteRest20CustomObjectSyncActionOperationData(int parentId, int id) returns Response|errorDelete sync data for a custom object sync action definition
Parameters
- parentId int - The custom object's resource identification number.
- id int - The sync action definition's resource identification number.
getCustomObjectSearch
Isolated FunctionRemote Function
function getCustomObjectSearch(int? 'limit, string? links, int? offset, string? orderBy, string? q, boolean? totalResults) returns json|errorRetrieve a list of custom objects
Parameters
- 'limit int? (default ()) - A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.
- links string? (default ()) - The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
- offset int? (default ()) - Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.
- orderBy string? (default ()) - Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.
- q string? (default ()) - A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=Test"</code> will find all the entities where the "name" field contains the string "Test".
- totalResults boolean? (default ()) - Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
Return Type
- json|error - OK.
Records
eloqua: AccountExportIndividual
The request body defines the details of the account export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountexportindividual1
The request body defines the details of the account export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountexportindividual2
The request body defines the details of the account export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountexportindividual3
The request body defines the details of the account export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: AccountGroupRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the account group.
- currentStatus string? - The account group's current status. This is a read-only property.
- name string? - The account group's name.
- description string? - The description of the account group.
- permissions string[]? - The permissions for the account group granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the account group.
- sourceTemplateId string? - Id of the template used to create the account group.
- createdBy string? - The login id of the user who created the account group.
- createdAt string? - The date and time the account group was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the account group.
- updatedAt string? - Unix timestamp for the date and time the account group was last updated.
- accessedAt string? - The date and time the account group was last accessed, expressed in Unix time.
- scheduledFor string? - The date the account group is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- count string? - The number of companies within the account group. This is a read-only property.
- isArchived string? - The account group is archived or not. This is a read-only property.
eloqua: AccountImportIndividual
The request body defines the details of the account import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkUsers boolean? - A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to <code>true</code>, one of the following CRM User ID fields is required in the Account import definition: <code>CRMOSCUserId</code>, <code>CRMSfdcUserId</code>, <code>CRMMSDUserId</code>, or <code>CRMSODUserId</code>. Refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a> for an example.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountimportindividual1
The request body defines the details of the account import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkUsers boolean? - A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to <code>true</code>, one of the following CRM User ID fields is required in the Account import definition: <code>CRMOSCUserId</code>, <code>CRMSfdcUserId</code>, <code>CRMMSDUserId</code>, or <code>CRMSODUserId</code>. Refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a> for an example.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountimportindividual2
The request body defines the details of the account import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkUsers boolean? - A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to <code>true</code>, one of the following CRM User ID fields is required in the Account import definition: <code>CRMOSCUserId</code>, <code>CRMSfdcUserId</code>, <code>CRMMSDUserId</code>, or <code>CRMSODUserId</code>. Refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a> for an example.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountimportindividual3
The request body defines the details of the account import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkUsers boolean? - A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to <code>true</code>, one of the following CRM User ID fields is required in the Account import definition: <code>CRMOSCUserId</code>, <code>CRMSfdcUserId</code>, <code>CRMMSDUserId</code>, or <code>CRMSODUserId</code>. Refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a> for an example.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: AccountRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the account. This is a read-only property.
- currentStatus string? - The account's current status.
- name string? - The name of the account.
- description string? - The description of the account.
- permissions string? - The permissions for the account granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the account.
- createdAt string? - The date and time the account was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the account.
- updatedAt string? - Unix timestamp for the date and time the account was last updated.
- accessedAt string? - The date and time the account was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fieldValues FieldValueRest10[]? - Array containing <code>type</code> and <code>id</code> values for all of the accountFields associated with a given account.
- address1 string? - The account's first address.
- address2 string? - The account's second address.
- address3 string? - The account's third address.
- city string? - The account's city.
- province string? - The account's province.
- postalCode string? - The account's postal code.
- country string? - The account's country.
- businessPhone string? - The account's business phone number.
- crmSystemMappings CrmSystemMappingRest10[]? - Lists CRM Users linked to the Account. Each <code>crmSystemMappings</code> contains a <code>type</code>, <code>CRMUsername</code>(s), and Eloqua <code>loginName</code> values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>. This property is also only returned when the request depth is <code>complete</code>.
eloqua: AccountRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the account. This is a read-only property.
- currentStatus string? - The account's current status.
- name string? - The name of the account.
- description string? - The description of the account.
- permissions string[]? - The permissions for the account granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the account.
- sourceTemplateId string? - Id of the template used to create the asset.
- createdBy string? - The login id of the user who created the account.
- createdAt string? - The date and time the account was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the account.
- updatedAt string? - Unix timestamp for the date and time the account was last updated.
- accessedAt string? - The date and time the account was last accessed, expressed in Unix time.
- scheduledFor string? - The date the account is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- address1 string? - The account's first address.
- address2 string? - The account's second address.
- address3 string? - The account's third address.
- city string? - The account's city.
- province string? - The account's province.
- postalCode string? - The account's postal code.
- country string? - The account's country.
- businessPhone string? - The account's business phone number.
- fieldValues FieldValueRest20[]? - Array containing <code>type</code> and <code>id</code> values for all of the accountFields associated with a given account.
- crmSystemMappings CrmSystemMappingRest20[]? - Lists CRM Users linked to the Account. Each <code>crmSystemMappings</code> contains a <code>type</code>, <code>CRMUsername</code>(s), and Eloqua <code>loginName</code> values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>. This property is also only returned when the request depth is <code>complete</code>.
eloqua: AccountSyncActionOperationIndividual
The request body defines the details of the account sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountsyncactionoperationindividual1
The request body defines the details of the account sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountsyncactionoperationindividual2
The request body defines the details of the account sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Accountsyncactionoperationindividual3
The request body defines the details of the account sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: ActivityExportIndividual
The request body defines the details of the activity export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Activityexportindividual1
The request body defines the details of the activity export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Activityexportindividual2
The request body defines the details of the activity export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Activityexportindividual3
The request body defines the details of the activity export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: ActivityImportIndividual
The request body defines the details of the activity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Activityimportindividual1
The request body defines the details of the activity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Activityimportindividual2
The request body defines the details of the activity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Activityimportindividual3
The request body defines the details of the activity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: ActivityRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the activity. This is a read-only property.
- contact string? - Id of the contact whose activity is being returned expressed in 10 digit integer Unix time. This is a read-only property.
- activityType string? - The activity's type. This is a read-only property.
- activityDate string? - The date the activity was performed expressed in 10 digit integer Unix time. This is a read-only property.
- asset string? - Id of the associated asset. This is a read-only property.
- assetType string? - Type of the associated asset. This is a read-only property.
- details record {}[]? - An array of detail values, specific to individual activity types.
eloqua: ArchiveParameterRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- targetFolderId string? - The target folder to which the asset should be moved upon archive/unarchive. If not passed, the root folder will be used.
eloqua: AsyncFormSubmissionBatchRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property
- id string? - The ID of the asynchronous form submission batch. This is a read-only property
- currentStatus string? - Current status of form submission batch when submitted through asynchronous submission
- callbackUrl string? - The URL to be called back once processing of form submisssion batch is completed
- batchCorrelationId string? - The unique identifier of the batch. Optional String field. If present, must be unique across created batches. If <code>batchCorrelationId</code> is not unique, then the entire batch will fail. The <code>batchCorrelationId</code> is persisted and could be used to retrieve form batch details.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- elements FormDataRest20[]? - A list of form data elements
- currentBatchStatus string? - The current status of the batch. Possible values: Queued, InProgress, Warning, Error, Success. This is a read-only property.
- processingStatus string? - The processing status of the batch. This is a read-only property.
eloqua: AuditLogReportRequestRest20
Fields
- 'type string? - This property is not used.
- auditReportType string? - Specifies the Audit Report Type to generate. Possible values include: <code>assets</code> (asset history), <code>securityGroup</code> (security group history), <code>userProfile</code> (user profile history), <code>userLogin</code> (user login history), <code>dataExport</code> (export history), and <code>dataUpload</code> (upload history).
- startDate string? - The start date and time (10 digit integer Unix time). This property is required.
- endDate string? - The end date and time (10 digit integer Unix time). This property is required.
- notificationEmail string? - Email address for export notification. This property is required.
- fileFormat string? - File format to be exported. Possible values include: <code>delimitedFile</code> or <code>Excel2007</code>.
- assetTypes string? - The asset type for the Audit log. Required if <code>auditReportType</code> is set to <code>assets</code>. Possible values include: <code>forms</code>, <code>programs</code>, <code>campaigns</code>, <code>emails</code>, and <code>landingPages</code>. Specify multiple asset types by comma separating values.
- actionName string? - The event action to filter for the audit log. Possible values include: <code>all</code>, <code>create</code>, <code>modify</code>, <code>delete</code>, <code>archive</code> and <code>unarchive</code>. For campaigns, possible values also include: <code>activated</code>, <code>deactivated</code>, <code>pause</code>, and <code>scheduleForActivation</code>. If not specified, defaults to <code>all</code>.
- status string? - For <code>dataUpload</code> and <code>dataExport</code> audit reports, you can filter on the status. Possible values include: <code>completed</code>, <code>in progress</code>, <code>queued</code>, <code>waiting</code>, <code>failed</code>, and <code>inactive</code>.
- userName string? - The user name to filter on.
eloqua: CampaignElementRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the campaign element. This is a read-only property.
- currentStatus string? - The campaign element's current status.
- name string? - Name of the campaign element. This is a read-only property.
- description string? - The description of the campaign element.
- permissions string[]? - The permissions for the campaign element granted to your current instance. This is a read-only property.
- folderId string? - Id of the associated folder.
- sourceTemplateId string? - The id of the source template.
- createdBy string? - The login id of the user who created the campaign element.
- createdAt string? - The date and time the campaign element was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the campaign element.
- updatedAt string? - Unix timestamp for the date and time the campaign element was last updated.
- accessedAt string? - The date and time the campaign element was last accessed.
- scheduledFor string? - The date the campaign element is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- position PositionRest20? -
- outputTerminals CampaignOutputTerminalRest20[]? - A list of the campaign element ids within the campaign. This is a read-only property.
- memberCount string? - Amount of members within the campaign element. This is a read-only property.
- memberErrorCount string? - Amount of members within the campaign element in errored status. This is a read-only property.
eloqua: CampaignOutputTerminalRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the campaign output terminal. This is a read-only property.
- currentStatus string? - The campaign output terminal's current status.
- name string? - Name of the campaign output terminal.
- description string? - The description of the campaign output terminal.
- permissions string[]? - The permissions for the campaign output terminal granted to your current instance.
- folderId string? - Id of the associated folder.
- sourceTemplateId string? - The id of the source template.
- createdBy string? - The login id of the user who created the campaign output terminal.
- createdAt string? - The date and time the campaign output terminal was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the campaign output terminal.
- updatedAt string? - Unix timestamp for the date and time the campaign output terminal was last updated. This is a read-only property.
- accessedAt string? - The date and time the campaign output terminal was last accessed.
- scheduledFor string? - The date the campaign output terminal is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- terminalType string? - The campaign output terminal type. This is a read-only property.
- connectedType string? - The campaign output terminal's connection type. This is a read-only property.
- connectedId string? - The connected id of the campaign output terminal. This is a read-only property.
eloqua: CampaignResponseExportIndividual
The request body defines the details of the campaign response export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Campaignresponseexportindividual1
The request body defines the details of the campaign response export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Campaignresponseexportindividual2
The request body defines the details of the campaign response export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Campaignresponseexportindividual3
The request body defines the details of the campaign response export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: CampaignResponseImportIndividual
The request body defines the details of the campaign response import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - This property is not used.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- serviceInstanceId string? - Your service instance id.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Campaignresponseimportindividual1
The request body defines the details of the campaign response import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - This property is not used.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- serviceInstanceId string? - Your service instance id.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Campaignresponseimportindividual2
The request body defines the details of the campaign response import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - This property is not used.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- serviceInstanceId string? - Your service instance id.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Campaignresponseimportindividual3
The request body defines the details of the campaign response import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - This property is not used.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- serviceInstanceId string? - Your service instance id.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: CampaignRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the campaign.
- currentStatus string? - The campaign's current status: <code>Active</code>, <code>Draft</code>, <code>Scheduled</code>, or <code>Completed</code>.
- name string? - The name of the campaign.
- description string? - The description of the campaign.
- permissions string[]? - The permissions for the campaign granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the campaign.
- sourceTemplateId string? - Id of the template used to create the asset.
- createdBy string? - The login id of the user who created the campaign.
- createdAt string? - The date and time the campaign was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the campaign.
- updatedAt string? - Unix timestamp for the date and time the campaign was last updated. This is a read-only property.
- accessedAt string? - The date and time the campaign was last accessed, expressed in Unix time.
- scheduledFor string? - The date the campaign is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- elements CampaignElementRest20[]? - A list of campaign elements.
- isReadOnly string? - Whether or not the campaign is read only.
- runAsUserId string? - The login id of the user to activate the campaign.
- startAt string? - The date time for which the campaign will activate, expressed in Unix time.
- endAt string? - The date and time the campaign will end.
- budgetedCost string? - The campaign's projected cost.
- actualCost string? - The campaign's actual cost.
- isMemberAllowedReEntry string? - Whether or not members are allowed to re-enter the campaign.
- fieldValues FieldValueRest20[]? - Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact. For campaigns, "fieldValues" include all custom campaign fields (type, id, value).
- campaignType string? - The campaign's type.
- product string? - The campaign's product value.
- region string? - The campaign's region value.
- clrEndDate string? - The end date of the clr.
- adCampaignId string? - Campaign_Field_AdCampaignId_Description
- campaignClassification string? - Campaign_Field_CampaignClassification_Description
- referenceProduct string? - Campaign_Field_ReferenceProduct_Description
- crmId string? - The id of the customer relationship management application. When sending update requests, if <code>crmId</code> is not included in the request and a <code>crmId</code> value exists, it will be blanked.
- isSyncedWithCRM string? - Whether or not the campaign is synced with a customer relationship management application.
- isIncludedInROI string? - Whether or not the campaign is included in return on investment.
- badgeId string? - The badge id of the campaign.
- isEmailMarketingCampaign string? - Whether or not the campaign is an email marketing campaign.
- campaignCategory string? - Defines whether a Campaign is simple or multi-step. The value <code>emailMarketing</code> should be used for simple campaigns, and <code>contact</code> for multi-step campaigns.
- firstActivation string? - The date and time the campaign was originally activated.
- memberCount string? - The amount of members in the campaign. This property is only returned when <code>depth</code> is set to <code>partial</code> or <code>complete</code>. This is a read-only property.
eloqua: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
eloqua: CloudComponentInstanceRest20
Fields
- 'type string? - The asset's type in Eloqua.
- id string? - The cloud content's unique identifier.
- componentId string? - The component id of the cloud content.
- configurationUrl string? - The configuration URL for the cloud content.
- configurationUrlModalSize string? - The modal size of the configuration window. Possible values are <code>large</code> or <code>small</code>.
- editorImageUrl string? - The image url for an image that Eloqua will display in the editor's design surface. <code>editorImageUrl</code> is not a templated URL.
- height CloudComponentRest20? -
- width CloudComponentRest20? -
- enabledConfigStatus string? - Whether or not the cloud content is configured. Possible values include: <code>None</code>, <code>Installing</code>, <code>EnableProcess</code>, <code>Error</code>, <code>Ready</code>, <code>Disabled</code>, <code>DisabledError</code>, <code>MarkedForDeletion</code>.
- appStatus string? - The status of the cloud content. Possible values include: <code>Up</code>, <code>Down</code>, and <code>Maintenance</code>.
- requiresConfiguration string? - Whether user configuration is required before the cloud content can be used. If set to <code>true</code>, users will be unable to save an email or landing page asset containing the unconfigured app service instance. Eloqua will display an error message.
eloqua: CloudComponentRest20
eloqua: ConditionRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
eloqua: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
eloqua: ContactExportIndividual
The request body defines details of the contact export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactexportindividual1
The request body defines details of the contact export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactexportindividual2
The request body defines details of the contact export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactexportindividual3
The request body defines details of the contact export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: ContactFieldRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact field. This is a read-only property.
- currentStatus string? - The email footer's current status.
- name string? - The name of the contact field.
- description string? - The description of the contact field.
- permissions string? - The permissions for the contact field granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the contact field. This is a read-only property.
- createdAt string? - The date and time the contact field was created, expressed in Unix time. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the contact field.
- updatedAt string? - Unix timestamp for the date and time the contact field was last updated.
- accessedAt string? - The date and time the contact field was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- internalName string? - The contact field's internal name.
- optionListId string? - The id of the associated option list.
- checkedValue string? - The checked value.
- uncheckedValue string? - The unchecked value of a checkbox custom object field.
- displayType string? - The contact field's display type.
- dataType string? - The contact field's data type. This is a read-only property.
- defaultValue string? - The contact field's default value.
- isReadOnly string? - Whether or not the contact field is read only.
- isRequired string? - Whether or not the contact field is required.
- isStandard string? - Whether or not the contact field is standard.
- outputFormatId string? - The id of the output format.
- updateType string? - Denotes under what circumstances the contact field is updated.
- showTrustedVisitorsOnly string? - Whether or not a contact field is displayed only to trusted visitors.
eloqua: ContactImportIndividual
The request body defines the details of the contact import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactimportindividual1
The request body defines the details of the contact import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactimportindividual2
The request body defines the details of the contact import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactimportindividual3
The request body defines the details of the contact import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: ContactListRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact list.
- currentStatus string? - The contact list's current status. This is a read-only property.
- name string? - The contact list's name.
- description string? - The description of the contact list.
- permissions string? - The permissions for the contact list granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the contact list. This is a read-only property.
- createdAt string? - The date and time the contact segment was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact list.
- updatedAt string? - Unix timestamp for the date and time the contact list was last updated.
- accessedAt string? - The date and time the contact list was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- scope string? - The contact list's scope: either <code>local</code> or <code>global</code>.
- count string? - The number of contacts in the contact list. This is a read-only property.
- membershipAdditions string[]? - The number of contact membership additions in the contact list.
- membershipDeletions string[]? - The number of contact membership deletions in the contact list.
- dataLookupId string? - The contact list's data lookup Id. This is a read-only property.
eloqua: ContactListRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact list.
- currentStatus string? - The contact list's current status. This is a read-only property.
- name string? - The contact list's name.
- description string? - The description of the contact list.
- permissions string[]? - The permissions for the contact list granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the contact list.
- sourceTemplateId string? - Id of the template used to create the contact list.
- createdBy string? - The login id of the user who created the contact list.
- createdAt string? - The date and time the contact segment was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact list.
- updatedAt string? - Unix timestamp for the date and time the contact list was last updated.
- accessedAt string? - The date and time the contact list was last accessed, expressed in Unix time.
- scheduledFor string? - The date the contact list is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- scope string? - The contact list's scope: either local or global.
- count string? - The number of contacts in the contact list. This is a read-only property.
- membershipAdditions string[]? - The number of contact membership additions in the contact list.
- membershipDeletions string[]? - The number of contact membership deletions in the contact list.
- dataLookupId string? - The contact list's data lookup Id. This is a read-only property.
eloqua: ContactRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact. This is a read-only property.
- currentStatus string? - The contact's current status.
- name string? - The name of the contact.
- description string? - The description of the contact.
- permissions string? - The permissions for the contact granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the contact.
- createdAt string? - The date and time the contact was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact.
- updatedAt string? - Unix timestamp for the date and time the contact was last updated.
- accessedAt string? - The date and time the contact was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- firstName string? - The contact's first name.
- lastName string? - The contact's last name.
- emailAddress string? - The contact's email address.
- emailFormatPreference string? - The contact's email format preference.
- isSubscribed string? - Whether or not the contact is subscribed.
- isBounceback string? - Whether or not the contact has any associated bouncebacks.
- accountName string? - The account name in which the contact belongs.
- accountId string? - The account id in which the contact belongs. This is a read-only property.
- title string? - The contact's title.
- subscriptionDate string? - The contact's subscription date.
- unsubscriptionDate string? - The contact's unsubscription date.
- bouncebackDate string? - The contact's bounceback date.
- fieldValues FieldValueRest10[]? - Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.
- address1 string? - The contact's first address.
- address2 string? - The contact's second address.
- address3 string? - The contact's third address.
- city string? - The contact's city.
- province string? - The contact's province.
- postalCode string? - The contact's postal code.
- country string? - The contact's country.
- businessPhone string? - The contact's business phone number.
- mobilePhone string? - The contact's mobile phone number.
- fax string? - The contact's fax number.
- salesPerson string? - The contact's account representative.
eloqua: ContactRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact. This is a read-only property.
- currentStatus string? - The contact's current status.
- name string? - The name of the contact.
- description string? - The description of the contact.
- permissions string[]? - The permissions for the contact granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the contact.
- sourceTemplateId string? - Id of the template used to create the asset.
- createdBy string? - The login id of the user who created the contact.
- createdAt string? - The date and time the contact was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact.
- updatedAt string? - Unix timestamp for the date and time the contact was last updated.
- accessedAt string? - The date and time the contact was last accessed, expressed in Unix time.
- scheduledFor string? - The date the contact is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- firstName string? - The contact's first name.
- lastName string? - The contact's last name.
- emailAddress string? - The contact's email address.
- emailFormatPreference string? - The contact's email format preference.
- isSubscribed string? - Whether or not the contact is subscribed.
- isSmsSubscribed string? - Contact_Field_IsSmsSubscribed_Description
- isBounceback string? - Whether or not the contact has any associated bouncebacks.
- accountName string? - The account name in which the contact belongs.
- accountId string? - The account id in which the contact belongs. This is a read-only property.
- title string? - The contact's title.
- subscriptionDate string? - The contact's subscription date.
- unsubscriptionDate string? - The contact's unsubscription date.
- bouncebackDate string? - The contact's bounceback date.
- fieldValues FieldValueRest20[]? - Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.
- address1 string? - The contact's first address.
- address2 string? - The contact's second address.
- address3 string? - The contact's third address.
- city string? - The contact's city.
- province string? - The contact's province.
- postalCode string? - The contact's postal code.
- country string? - The contact's country.
- businessPhone string? - The contact's business phone number.
- mobilePhone string? - The contact's mobile phone number.
- fax string? - The contact's fax number.
- salesPerson string? - The contact's account representative.
- stepEntryTime string? - The time the contact was added to a step. This is a read-only property. This property can only be retrieved when a <code>stepid</code> is provided.
- nextEvaluationTime string? - The time when the contact is scheduled to be processed. This is a read-only property. This property can only be retrieved when a <code>stepid</code> is provided.
eloqua: ContactSegmentRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact segment. This is a read-only property.
- currentStatus string? - The contact segment's current status. This is a read-only property.
- name string? - The contact segment's name.
- description string? - The description of the contact segment.
- permissions string? - The permissions for the contact segment granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the contact segment.
- createdAt string? - The date and time the contact segment was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact segment.
- updatedAt string? - Unix timestamp for the date and time the contact segment was last updated.
- accessedAt string? - The date and time the contact segment was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- elements SegmentElementRest10[]? - Array of contact segment elements.
- count string? - The number of contacts in the contact segment. This is a read-only property.
- lastCalculatedAt string? - The date and time of the most recent calculation. This is a read-only property.
eloqua: ContactSegmentRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact segment. This is a read-only property.
- currentStatus string? - This property is not used for contact segments.
- name string? - The contact segment's name.
- description string? - This property is not used for contact segments.
- permissions string[]? - The permissions for the contact segment granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the contact segment.
- sourceTemplateId string? - This property is not used for contact segments.
- createdBy string? - The login id of the user who created the contact segment.
- createdAt string? - The date and time the contact segment was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact segment.
- updatedAt string? - Unix timestamp for the date and time the contact segment was last updated.
- accessedAt string? - This property is not used for contact segments.
- scheduledFor string? - This property is not used for contact segments.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- elements SegmentElementRest20[]? - Array of contact segment elements.
- count string? - The number of contacts in the contact segment. This is a read-only property.
- lastCalculatedAt string? - The date and time of the most recent calculation. This is a read-only property.
- isStale string? - Whether or not the contact segment has been refreshed in the last 24 hours by the user performing the request.
eloqua: ContactSyncActionOperationIndividual
The request body defines details of the contact sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactsyncactionoperationindividual1
The request body defines details of the contact sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactsyncactionoperationindividual2
The request body defines details of the contact sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Contactsyncactionoperationindividual3
The request body defines details of the contact sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: ContentSectionRest10
Fields
- 'type string? - The content section's type in Eloqua. This is a read-only property.
- id string? - Id of the content section. This is a read-only property.
- currentStatus string? - The content section's current status. This is a read-only property.
- name string? - The name of the content section.
- description string? - The description of the content section.
- permissions string? - The permissions for the content section granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the content section.
- createdAt string? - The date and time the content section was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the content section.
- updatedAt string? - Unix timestamp for the date and time the content section was last updated.
- accessedAt string? - The date and time the content section was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- contentHtml string? - The content section's HTML content.
- contentText string? - The content section's text content.
- scope string? - The content sections's scope: either <code>local</code> or <code>global</code>.
- forms FormRest10[]? - A list of associated Form assets.
- images ImageFileRest10[]? - A list of associated Image assets.
- hyperlinks HyperlinkRest10[]? - A list of hyperlinks contained within the content section.
- size SizeRest10? -
eloqua: ContentSectionRest20
Fields
- 'type string? - The content section's type in Eloqua. This is a read-only property.
- id string? - Id of the content section. This is a read-only property.
- currentStatus string? - The content section's current status. This is a read-only property.
- name string? - The name of the content section.
- description string? - The description of the content section.
- permissions string[]? - The permissions for the content section granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the content section.
- sourceTemplateId string? - Id of the template used to create the asset.
- createdBy string? - The login id of the user who created the content section.
- createdAt string? - The date and time the content section was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the content section.
- updatedAt string? - Unix timestamp for the date and time the content section was last updated.
- accessedAt string? - The date and time the content section was last accessed, expressed in Unix time.
- scheduledFor string? - The date the content section is scheduled. This is a read-only property.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- contentHtml string? - The content section's HTML content.
- contentText string? - The content section's text content.
- scope string? - The content sections's scope: either local or global.
- forms FormRest20[]? - A list of associated Form assets.
- images ImageFileRest20[]? - A list of associated Image assets.
- hyperlinks HyperlinkRest20[]? - A list of hyperlinks contained within the content section.
- files ImportedFileRest20[]? - A list of associated files.
- size SizeRest20? -
eloqua: CriterionRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the criterion. This is a read-only property.
- currentStatus string? - The criterion's current status. This is a read-only property.
- name string? - Name of the criterion.
- description string? - The description of the criterion.
- permissions string? - The permissions for the criterion granted to your current instance.
- createdBy string? - The login id of the user who created the criterion.
- createdAt string? - The date and time the criterion was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the criterion.
- updatedAt string? - Unix timestamp for the date and time the criterion was last updated.
- accessedAt string? - The date and time the criterion was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
eloqua: CriterionRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the criterion. This is a read-only property.
- currentStatus string? - The criterion's current status. This is a read-only property.
- name string? - Name of the criterion.
- description string? - The description of the criterion.
- permissions string[]? - The permissions for the criterion granted to your current instance.
- folderId string? - Id of the folder. This is a read-only property.
- sourceTemplateId string? - Id of the source template. This is a read-only property.
- createdBy string? - The login id of the user who created the criterion.
- createdAt string? - The date and time the criterion was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the criterion.
- updatedAt string? - Unix timestamp for the date and time the criterion was last updated.
- accessedAt string? - The date and time the criterion was last accessed.
- scheduledFor string? - The date and time the criterion is scheduled for.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
eloqua: CrmSystemMappingRest10
Fields
- 'type string? -
- id string? -
- currentStatus string? -
- name string? -
- description string? -
- permissions string? -
- createdBy string? -
- createdAt string? -
- updatedBy string? -
- updatedAt string? -
- accessedAt string? -
- depth string? -
- loginName string? -
- MSDUserName string? -
- OSCUserName string? -
- SFDCUserName string? -
- SODUserName string? -
eloqua: CrmSystemMappingRest20
Fields
- 'type string? -
- id string? -
- currentStatus string? -
- name string? -
- description string? -
- permissions string[]? -
- folderId string? -
- sourceTemplateId string? -
- createdBy string? -
- createdAt string? -
- updatedBy string? -
- updatedAt string? -
- accessedAt string? -
- scheduledFor string? -
- depth string? -
- loginName string? -
- MSDUserName string? -
- OSCUserName string? -
- SFDCUserName string? -
- SODUserName string? -
eloqua: CrmUserNamesRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- SFDCUserName string? -
- MSDUserName string? -
- OSCUserName string? -
- SODUserName string? -
eloqua: CustomObjectDataRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the custom object. This is a read-only property.
- currentStatus string? - The custom object's current status. This is a read-only property.
- contactId string? - Id of the contact. This is a read-only property.
- fieldValues FieldValueRest10[]? - Array containing <code>type</code> and <code>id</code> values for all of the fields associated with a given custom object data asset. Custom object date field values must be in Unix time format.
eloqua: CustomObjectDataRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the custom object data.
- currentStatus string? - The custom object data's current status.
- name string? - The name of the custom object data.
- description string? - The description of the custom object data.
- permissions string[]? - The permissions for the custom object data granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the custom object data.
- sourceTemplateId string? - Id of the template used to create the asset.
- createdBy string? - The login id of the user who created the custom object data. This is a read-only property.
- createdAt string? - The date and time the custom object data was created, expressed in Unix time. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the custom object data.
- updatedAt string? - Unix timestamp for the date and time the custom object data was last updated.
- accessedAt string? - The date and time the custom object data was last accessed, expressed in Unix time.
- scheduledFor string? - The date the custom object data is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- contactId string? - The contact record Id associated to this custom object data.
- accountId string? - The account record Id associated to this custom object data. This is a read-only property.
- uniqueCode string? - The unique code associated to the custom object data.
- customObjectRecordStatus string? - The record status of the custom object data.
- fieldValues FieldValueRest20[]? - Array containing <code>type</code> and <code>id</code> values for all of the fields associated with a given custom object data asset. Custom object date field values must be in Unix time format.
- isMapped string? - Whether or not the custom object data is mapped to a custom object.
eloqua: CustomObjectExportIndividual
The request body defines the details of the custom object export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectexportindividual1
The request body defines the details of the custom object export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectexportindividual2
The request body defines the details of the custom object export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectexportindividual3
The request body defines the details of the custom object export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: CustomObjectFieldRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the custom object field. This is a read-only property. Use negative ids to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
- currentStatus string? - This property is not used for custom objects.
- description string? - This property is not used for custom object fields.
- permissions string? - This property is not used.
- createdBy string? - This property is not used for custom object fields.
- createdAt string? - This property is not used for custom object fields.
- updatedBy string? - This property is not used for custom object fields.
- updatedAt string? - This property is not used for custom object fields.
- accessedAt string? - This property is not used for custom object fields.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- name string? - The name of the custom object field.
- displayType string? - The custom object field's display type.
- dataType string? - The custom object field's data type.
- defaultValue string? - The custom object field's default value.
eloqua: CustomObjectFieldRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the custom object field. This is a read-only property. Use negative ids in order to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
- currentStatus string? - This property is not used for custom object fields.
- description string? - This property is not used for custom object fields.
- permissions string[]? - This property is not used.
- folderId string? - This property is not used for custom object fields.
- sourceTemplateId string? - This property is not used for custom object fields.
- createdBy string? - This property is not used for custom object fields.
- createdAt string? - This property is not used for custom object fields.
- updatedBy string? - This property is not used for custom object fields.
- updatedAt string? - This property is not used for custom object fields.
- accessedAt string? - This property is not used for custom object fields.
- scheduledFor string? - This property is not used for custom object fields.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- name string? - The name of the custom object field.
- displayType string? - The custom object field's display type.
- dataType string? - The custom object field's data type.
- defaultValue string? - The custom object field's default value.
- internalName string? - The custom object field's internal name. This is a read-only property.
- optionListId string? - The option list id for a single select custom object field.
- checkedValue string? - The checked value of a checkbox custom object field.
- uncheckedValue string? - The unchecked value of a checkbox custom object field.
eloqua: CustomObjectImportIndividual
The request body defines the details of the custom object import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectimportindividual1
The request body defines the details of the custom object import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectimportindividual2
The request body defines the details of the custom object import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectimportindividual3
The request body defines the details of the custom object import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: CustomObjectRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the custom object.
- currentStatus string? - This property is not used for custom object fields.
- name string? - The name of the custom object.
- description string? - The description of the custom object.
- permissions string? - The permissions for the custom object granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the custom object.
- createdAt string? - The date and time the custom object was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the custom object.
- updatedAt string? - Unix timestamp for the date and time the custom object was last updated.
- accessedAt string? - The date and time the custom object was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fields CustomObjectFieldRest10[]? - Array consisting of custom object field properties.
- displayNameFieldId string? - For your custom object record to have a meaningful name field, you must create a custom object field which will act as a name. You can then use the desired custom object field's id as the value for this parameter.
- uniqueCodeFieldId string? - For your custom object record to have a unique identifier, you must create a custom object field which will act as a GUID. You can then use the desired custom object field's id as the value for this parameter.
- deleteLinkedCustomObjectData string? - Whether or not custom object records are deleted when linked contact records are deleted. Does not apply to records that are unmapped or account deletion. Deleting records is irreversible and data cannot be recovered. The default value is <code>false</code>. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to <a href='https://support.oracle.com/epmos/faces/MosIndex.jspx'>My Oracle Support</a>.
eloqua: CustomObjectRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the custom object.
- currentStatus string? - This property is not used for custom objects.
- name string? - The name of the custom object.
- description string? - The description of the custom object.
- permissions string[]? - The permissions for the custom object granted to your current instance. This is a read-only property.
- folderId string? - This property is not used for custom objects.
- sourceTemplateId string? - This property is not used for custom objects.
- createdBy string? - The login id of the user who created the custom object.
- createdAt string? - The date and time the custom object was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the custom object.
- updatedAt string? - Unix timestamp for the date and time the custom object was last updated.
- accessedAt string? - The date and time the custom object was last accessed, expressed in Unix time.
- scheduledFor string? - This property is not used for custom objects.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fields CustomObjectFieldRest20[]? - Array consisting of custom object field properties.
- emailAddressFieldId string? - For your custom object record to have an email address field, you must create a custom object field which will act as an email address. You can then use the desired custom object field's id as the value for this parameter.
- displayNameFieldId string? - For your custom object record to have a meaningful name field, you must create a custom object field which will act as a name. You can then use the desired custom object field's id as the value for this parameter.
- uniqueCodeFieldId string? - For your custom object record to have a unique identifier, you must create a <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#Developers/RESTAPI/2.0%20Endpoints/Custom%20objects/Custom-object-fields.htm'>custom object field</a> which will act as a GUID. You can then use the desired custom object field's id as the value for this parameter.
- deleteLinkedCustomObjectData string? - Whether or not custom object records are deleted when linked contact records are deleted. Does not apply to records that are unmapped or account deletion. Deleting records is irreversible and data cannot be recovered. The default value is <code>false</code>. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to <a href='https://support.oracle.com/epmos/faces/MosIndex.jspx'>My Oracle Support</a>.
eloqua: CustomObjectSyncActionOperationIndividual
The request body defines details of the custom object sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectsyncactionoperationindividual1
The request body defines details of the custom object sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectsyncactionoperationindividual2
The request body defines details of the custom object sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Customobjectsyncactionoperationindividual3
The request body defines details of the custom object sync action definition.
Fields
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the sync action. This is a read-only property.
- fields string[]? - The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered upon uploading data.
- kbUsed int? - The amount of space used in kb. This is a read-only property.
- name string? - The name of the sync action definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: DynamicContentRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the dynamic content. This is a read-only property.
- currentStatus string? - The dynamic content's current status.
- name string? - Name of the dynamic content.
- description string? - The description of the dynamic content.
- permissions string? - The permissions for the dynamic content granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the dynamic content.
- createdAt string? - The date and time the dynamic content was last accessed, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the dynamic content. This is a read-only property.
- updatedAt string? - Unix timestamp for the date and time the dynamic content was last updated. This is a read-only property.
- accessedAt string? - The date and time the dynamic content was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- defaultContentSection ContentSectionRest10? -
- rules DynamicContentRuleRest10[]? - The dynamic content's rules.
eloqua: DynamicContentRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the dynamic content. This is a read-only property.
- currentStatus string? - The dynamic content's current status.
- name string? - Name of the dynamic content.
- description string? - The description of the dynamic content.
- permissions string[]? - The permissions for the dynamic content granted to your current instance. This is a read-only property.
- folderId string? - The id of the associated folder.
- sourceTemplateId string? - The id of the source template.
- createdBy string? - The login id of the user who created the dynamic content.
- createdAt string? - The date and time the dynamic content was last accessed, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the dynamic content.
- updatedAt string? - Unix timestamp for the date and time the dynamic content was last updated.
- accessedAt string? - The date and time the dynamic content was last accessed.
- scheduledFor string? - The date the dynamic content is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- defaultContentSection ContentSectionRest20? -
- rules DynamicContentRuleRest20[]? - The dynamic content's rules.
- isContentPublic boolean? - Whether or not the dynamic content is public.
eloqua: DynamicContentRuleRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- currentStatus string? - The Dynamic Content Rule 's current status.
- id string? - Id of the dynamic content rule. This is a read-only property.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- contentSection ContentSectionRest10? -
- criteria CriterionRest10[]? - The criteria of the dynamic content rule.
- statement string? - The statement of the dynamic content rule.
eloqua: DynamicContentRuleRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- currentStatus string? - The Dynamic Content Rule 's current status.
- id string? - Id of the dynamic content rule. This is a read-only property.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- contentSection ContentSectionRest20? -
- criteria CriterionRest20[]? - The criteria of the dynamic content rule.
- statement string? - The statement of the dynamic content rule.
- name string? - The name of the dynamic content rule.
eloqua: EloquaApiRestContractsDataVisitorsVisitorviewdatarest20
Fields
- 'type string? - The visitor's type in Eloqua.
- visitorId string? - The Id of the visitor profile.
- createdAt string? - The date and time the visitor was created, expressed in Unix time.
- contactId string? - The contact record Id associated to this profile, if any.
- id int? - The id of the visitor.
eloqua: EmailAddressImportIndividual
The request body defines the details of the email address import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Emailaddressimportindividual1
The request body defines the details of the email address import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Emailaddressimportindividual2
The request body defines the details of the email address import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Emailaddressimportindividual3
The request body defines the details of the email address import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: EmailDeploymentRest20
Fields
- 'type string? - The type of email deployment. Possible values include: <ul> <li><code>EmailTestDeployment</code></li> <li><code>EmailLowVolumeDeployment</code></li> </ul> Note that the activity's Email Send Type will appear as <code>QuickSend</code>.
- id string? - Unique identifier of the email deployment.
- currentStatus string? - Current deployment status. Possible values are: <code>normal</code>, <code>locked</code>, <code>forceComplete</code>, <code>inError</code>, or <code>resend</code>.
- name string? - The name of the deployment.
- description string? - Description of the deployment.
- permissions string[]? - Permission values of the deployment granted to the current user.
- folderId string? - Id of the folder.
- sourceTemplateId string? - Id of the source template.
- createdBy string? - The login id of the user who created the email deployment.
- createdAt string? - The date and time the email deployment was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email deployment.
- updatedAt string? - Unix timestamp for the date and time the email deployment was last updated.
- accessedAt string? - The date and time the email deployment was last accessed, expressed in Unix time.
- scheduledFor string? - The date and time the email deployment is scheduled.
- depth string? - The request's level of detail.
- email EmailRest20? -
- successfulSendCount string? - The number of emails which have been successfully sent so far.
- failedSendCount string? - The number of emails which failed during send so far.
- endAt string? - The date and time the email deployment ended.
- sentContent string? - The content type of the email.
- sentSubject string? - The subject line of the email.
- sendDate string? - EmailDeployment_Field_SendDate_Description
eloqua: EmailFooterRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the email footer. This is a read-only property.
- currentStatus string? - The email footer's current status.
- name string? - The name of the email footer.
- description string? - The description of the email footer.
- permissions string? - The permissions for the email footer granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the email footer.
- createdAt string? - The date and time the email footer was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email footer.
- updatedAt string? - Unix timestamp for the date and time the email footer was last updated.
- accessedAt string? - The date and time the email footer was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- body string? - The email footers's html text content.
- text string? - The raw text from the "body" parameter.
- fieldMerges FieldMergeRest10[]? - A list of associated Field Merges.
- hyperlinks HyperlinkRest10[]? - A list of hyperlinks contained within the email footer.
eloqua: EmailGroupRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the email group. This is a read-only property.
- currentStatus string? - The email group's current status.
- name string? - The name of the email group.
- description string? - The description of the email group.
- permissions string? - The permissions for the email group granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the email group.
- createdAt string? - The date and time the email group was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email group.
- updatedAt string? - Unix timestamp for the date and time the email group was last updated.
- accessedAt string? - The date and time the email group was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- emailHeaderId string? - Id of the email header.
- subscriptionLandingPageId string? - Id of the subscription landing page.
- unsubscriptionLandingPageId string? - Id of the unsubscribe landing page.
- isVisibleInPublicSubscriptionList string? - Whether or not the email group is visible in the public subscriptions list.
- isVisibleInOutlookPlugin string? - Whether or not the email group is visible in the Outlook plugin.
- emailIds string[]? - Array containing the unique identifiers of the emails in the email group.
- displayName string? - The display name of the email group.
- subscriptionListId string? - Id of the subscription list. This is a read-only property.
- unSubscriptionListId string? - Id of the unsubscribe list. This is a read-only property.
- subscriptionListDataLookupId string? - Id of the subscription list's data lookup.
- unSubscriptionListDataLookupId string? - Id of the unsubscribe list's data lookup.
eloqua: EmailHeaderRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the email header. This is a read-only property.
- currentStatus string? - The asset's current status. This is a read-only property.
- name string? - The name of the email header.
- description string? - The description of the email header.
- permissions string? - The permissions for the email header granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the email header.
- createdAt string? - The date and time the email header was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email header.
- updatedAt string? - Unix timestamp for the date and time the email header was last updated.
- accessedAt string? - The date and time the email header was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- body string? - The email header's html text content.
- text string? - The raw text from the "body" parameter.
- fieldMerges FieldMergeRest10[]? - A list of associated Field Merges.
- hyperlinks HyperlinkRest10[]? - A list of hyperlinks contained within the asset.
eloqua: EmailRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the email. This is a read-only property.
- currentStatus string? - The asset's current status. This is a read-only property.
- name string? - The name of the email.
- description string? - The description of the email.
- permissions string? - The permissions for the email granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the email.
- createdAt string? - The date and time the email was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email.
- updatedAt string? - Unix timestamp for the date and time the email was last updated.
- accessedAt string? - The date and time the email was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- subject string? - The email's subject line text.
- senderName string? - The sender name recipients of the email will see.
- senderEmail string? - The address the email will appear to be sent from.
- replyToName string? - The sender name recipients of the email will see.
- replyToEmail string? - The email address targeted when recipients click "reply".
- bounceBackEmail string? - The email address which is notified if the email is undeliverable.
- virtualMTAId string? - The identifier of the email's Virtual MTA configuration for custom email sending options. Applicable only if your Eloqua instance has the Premium Branding and Deliverability package. <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/index.html#CSHID=EmailSettings'>Learn more</a>.
- brandId string? - The email's brand ID.
- htmlContent HtmlContentRest10? -
- plainText string? - The email's content in plain text.
- isPlainTextEditable string? - Whether or not the asset's text is editable.
- sendPlainTextOnly string? - Whether or not the sent email is plain text only.
- isTracked string? - Whether or not Eloqua will track the asset.
- layout string? - The email's main layout.
- style string? - The email's main layout style.
- forms FormRest10[]? - A list of associated Form assets.
- images ImageFileRest10[]? - A list of associated Image assets.
- hyperlinks HyperlinkRest10[]? - A list of hyperlinks contained within the email.
- contentSections ContentSectionRest10[]? - A list of associated Content Section assets.
- dynamicContents DynamicContentRest10[]? - A list of associated dynamic content.
- landingPages LandingPageRest10[]? - A list of associated landing page assets.
- files ImportedFileRest10[]? - A list of imported files.
- emailHeaderId string? - Id of the email header.
- emailGroupId string? - Id of the email group.
- encodingId string? - Id of the encoding used.
- fieldMerges FieldMergeRest10[]? - A list of associated Field Merges.
eloqua: EmailRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the email. This is a read-only property.
- currentStatus string? - The asset's current status. This is a read-only property.
- name string? - The name of the email.
- description string? - The description of the email.
- permissions string[]? - The permissions for the email granted to your current instance. This is a read-only property.
- folderId string? - Id of the folder.
- sourceTemplateId string? - Id of the source template.
- createdBy string? - The login id of the user who created the email.
- createdAt string? - The date and time the email was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email.
- updatedAt string? - Unix timestamp for the date and time the email was last updated.
- accessedAt string? - The date and time the email was last accessed, expressed in Unix time.
- scheduledFor string? - The date and time the email is scheduled for.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- subject string? - The email's subject line text.
- previewText string? - The preheader text that email clients will use when displaying a preview of the email. 500 character limit. Different email clients will limit the amount of characters displayed.
- senderName string? - The sender name recipients of the email will see.
- senderEmail string? - The address the email will appear to be sent from.
- replyToName string? - The sender name recipients of the email will see.
- replyToEmail string? - The email address targeted when recipients click "reply".
- bounceBackEmail string? - The email address which is notified if the email is undeliverable.
- virtualMTAId string? - The numeric ID for the Virtual MTA configuration. Virtual MTAs are setup during the Branding and Deliverability package provisioning process. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=EmailSettings'>the Oracle Eloqua Help Center</a>.
- brandId string? - The email's brand ID.
- htmlContent HtmlContentRest20? -
- plainText string? - The email's content in plain text.
- isPlainTextEditable string? - Whether or not the asset's text is editable.
- sendPlainTextOnly string? - Whether or not the sent email is plain text only.
- isTracked string? - Whether or not Eloqua will track the asset.
- isPrivate string? - Whether or not the email is private.
- layout string? - The email's main layout.
- style string? - The email's main layout style.
- forms FormRest20[]? - A list of associated Form assets.
- images ImageFileRest20[]? - A list of associated Image assets.
- hyperlinks HyperlinkRest20[]? - A list of hyperlinks contained within the email.
- contentSections ContentSectionRest20[]? - A list of content sections contained within the email.
- dynamicContents DynamicContentRest20[]? - A list of dynamic contents contained within the email.
- files ImportedFileRest20[]? - A list of imported files.
- contentServiceInstances CloudComponentInstanceRest20[]? -
- emailHeaderId string? - Id of the email header.
- emailGroupId string? - Id of the email group.
- encodingId string? - Id of the encoding used.
- fieldMerges FieldMergeRest20[]? - A list of associated Field Merges.
- attachments ImportedFileRest20[]? - A list of imported files.
- isContentProtected string? - Whether or not the email is in protected mode.
- renderMode string? - The layout of the email when it is sent or previewed. Possible values include: <code>fixed</code> or <code>flow</code>.
- archived string? - Whether or not the email is archived.
eloqua: EntitySearchByExternalIdsRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- depth string? - Level of detail returned by the request. The default will be <code>minimal</code>. <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Learn more about the depth parameter</a>.
- externalIds string[]? - The external ids to retrieve. Maximum of 200 external ids per request. If the array exceeds the 200 limit, a <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>400 Bad Request</a> will be returned.
eloqua: EntitySearchByIdsRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- depth string? - Level of detail returned by the request. The default will be <code>minimal</code>. <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Learn more about the depth parameter</a>.
- ids int[]? - The ids to retrieve. Maximum of 200 ids per request. If the array contains duplicate ids, or exceeds the 200 limit, a <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>400 Bad Request</a> will be returned.
eloqua: EventExportIndividual
The request body defines the details of the event export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Eventexportindividual1
The request body defines the details of the event export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Eventexportindividual2
The request body defines the details of the event export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Eventexportindividual3
The request body defines the details of the event export definition.
Fields
- areSystemTimestampsInUTC boolean? - Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
- fields string[]? - List of fields to be included in the operation.
- filter string? - The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- maxRecords int? - The maximum amount of records.
- name string? - The name of the export definition.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: EventImportIndividual
The request body defines the details of the event import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Eventimportindividual1
The request body defines the details of the event import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Eventimportindividual2
The request body defines the details of the event import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Eventimportindividual3
The request body defines the details of the event import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- id int? - The import definition???s resource identification number.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to <code>false</code> to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- mapDataCards boolean? - Whether or not data cards will be mapped on import. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsCaseSensitiveMatch boolean? - Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityField string? - This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsEntityType string? - This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- mapDataCardsSourceField string? - This field specifies the source document field that will be used for matching. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- parentId int? - The parent object's resource identification number.
- syncActions string[]? - Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>. There currently are not any sync actions available for Events.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: EventRegistrationDataRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the event registrant. This is a read-only property.
- currentStatus string? - This property is not used for event registrants.
- name string? - The name of the event registrant. This is a read-only property.
- description string? - This property is not used for event registrants.
- permissions string[]? - This property is not used for event registrants.
- folderId string? - This property is not used for event registrants.
- sourceTemplateId string? - This property is not used for event registrants.
- createdBy string? - This property is not used for event registrants.
- createdAt string? - The date and time the event registrant was created, expressed in Unix time. This is a read-only property.
- updatedBy string? - This property is not used for event registrants.
- updatedAt string? - Unix timestamp for the date and time the event registrant was last updated. This is a read-only property.
- accessedAt string? - This property is not used for event registrants.
- scheduledFor string? - This property is not used for event registrants.
- depth string? - This property is not used for event registrants.
- contactId string? - The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter.
- accountId string? - The account record Id associated to this event registrant. This is a read-only property.
- uniqueCode string? - The unique value associated to the event registrant. This is a read-only property.
- customObjectRecordStatus string? - The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property.
- fieldValues FieldValueRest20[]? - Array containing <code>type</code>, <code>id</code>, and <code>value</code> for all of the fields associated with a given event registrant.
- isMapped string? - Whether or not the event registrant is mapped to a contact or account. This is a read-only property.
eloqua: EventRegistrationRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the event. This is a read-only property.
- currentStatus string? - This property is not used for events.
- name string? - The name of the event.
- description string? - The description of the event.
- permissions string[]? - This property is not used for events.
- folderId string? - The folder id of the folder which contains the event.
- sourceTemplateId string? - This property is not used for events.
- createdBy string? - The login id of the user who created the event. This is a read-only property.
- createdAt string? - The date and time the event was created, expressed in Unix time. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the event. This is a read-only property.
- updatedAt string? - Unix timestamp for the date and time the event was last updated. This is a read-only property.
- accessedAt string? - This property is not used for events.
- scheduledFor string? - This property is not used for events.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fields CustomObjectFieldRest20[]? - Array consisting of event field properties.
- sessions EventSessionRest20[]? - Array consisting of event sessions.
- sessionFields EventSessionFieldRest20[]? - Array consisting of session fields within a session.
- sessionFieldValues EventSessionFieldValueRest20[]? - Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.
- emailAddressFieldId string? - The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter.
- uniqueCodeFieldId string? - The field id that contains the unique identifier. Use the desired custom object field's negative id as the value for this parameter. See example. To use an Eloqua Identifier, leave this parameter out of the request.
- eventGroupByFieldId string? - The id of the field used to organize multiple sessions. Use the desired custom object field's negative id as the value for this parameter.
eloqua: EventSessionFieldRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the event session field. This is a read-only property.
- currentStatus string? - This property is not used for event session fields.
- name string? - The name of the session field within an event.
- description string? - This property is not used for event session fields.
- permissions string[]? - This property is not used.
- folderId string? - This property is not used for event session fields.
- sourceTemplateId string? - This property is not used for event session fields.
- createdBy string? - This property is not used for event session fields.
- createdAt string? - This property is not used for event session fields.
- updatedBy string? - This property is not used for event session fields.
- updatedAt string? - This property is not used for event session fields.
- accessedAt string? - This property is not used for event session fields.
- scheduledFor string? - This property is not used for event session fields.
- depth string? - This property is not used for event session fields.
- dataType string? - The DataType of the session field.
- outputFormat FieldOutputFormatRest20? -
eloqua: EventSessionFieldValueRest20
Fields
- 'type string? - The asset's type in Eloqua.
- id string? - This property is not used for event session field values.
- currentStatus string? - This property is not used for event session field values.
- name string? - This property is not used for event session field values.
- description string? - This property is not used for event session field values.
- permissions string[]? - This property is not used.
- folderId string? - This property is not used for event session field values.
- sourceTemplateId string? - This property is not used for event session field values.
- createdBy string? - This property is not used for event session field values.
- createdAt string? - This property is not used for event session field values.
- updatedBy string? - This property is not used for event session field values.
- updatedAt string? - This property is not used for event session field values.
- accessedAt string? - This property is not used for event session field values.
- scheduledFor string? - This property is not used for event session field values.
- depth string? - This property is not used for event session field values.
- sessionId string? - The SessionId of the session within an event for which field value is passed.
- sessionFieldId string? - The SessionFieldId of the field. The session field must be created first before creating session field values.
- value string? - The value for the event session field.
eloqua: EventSessionRest20
Fields
- 'type string? - The asset's type in Eloqua.
- id string? - Id of the event session. This is a read-only property.
- currentStatus string? - This property is not used for event sessions.
- name string? - The name of the session.
- description string? - This property is not used for event sessions.
- permissions string[]? - This property is not used.
- folderId string? - This property is not used for event sessions.
- sourceTemplateId string? - This property is not used for event sessions.
- createdBy string? - This property is not used for event sessions.
- createdAt string? - This property is not used for event sessions.
- updatedBy string? - This property is not used for event sessions.
- updatedAt string? - This property is not used for event sessions.
- accessedAt string? - This property is not used for event sessions.
- scheduledFor string? - This property is not used for event sessions.
- depth string? - This property is not used for event sessions.
- participantsLimit int? - The maximum number of participants per session.
eloqua: ExternalActivitiesRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the external activity. This is a read-only property.
- currentStatus string? - The external activity's current status.
- name string? - The name of the external activity.
- description string? - The description of the external activity.
- permissions string[]? - The permissions for the external activity granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the external activity.
- sourceTemplateId string? - Id of the template used to create the external activity.
- createdBy string? - The login id of the user who created the external activity.
- createdAt string? - The date and time the external activity was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the external activity.
- updatedAt string? - Unix timestamp for the date and time the external activity was last updated.
- accessedAt string? - The date and time the external activity was last accessed, expressed in Unix time.
- scheduledFor string? - The date the external activity is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- campaignId int? - Id of the associated campaign. This value must correspond to a valid campaign.
- assetName string? - The name of the associated asset.
- assetType string? - The type of the associated asset.
- activityType string? - The activity's type.
- activityDate string? - The date the external activity was performed by the associated contact.
- contactId int? - The id of the contact who performed the activity. This value must correspond to a valid contact.
- fieldValues record {}[]? - Array containing <code>type</code> and <code>id</code> values for all of the activity fields associated with a given external activity
eloqua: ExternalActivityTypeRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the external activity type.
- currentStatus string? - The external activity type's current status.
- description string? - The description of the external activity type.
- permissions string[]? - The permissions for the external activity type granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the external activity type.
- sourceTemplateId string? - Id of the template used to create the external activity type.
- createdBy string? - The login id of the user who created the external activity type.
- createdAt string? - The date and time the external activity type was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the external activity type.
- updatedAt string? - Unix timestamp for the date and time the external activity type was last updated.
- accessedAt string? - The date and time the external asset type was last accessed, expressed in Unix time.
- scheduledFor string? - The date the external activity type is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- name string? - The name of the external activity type.
eloqua: ExternalAssetRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the external asset. This is a read-only property.
- currentStatus string? - The external asset's current status.
- description string? - The description of the external asset.
- permissions string[]? - The permissions for the external asset granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the external asset.
- sourceTemplateId string? - Id of the template used to create the external asset.
- createdBy string? - The login id of the user who created the external asset.
- createdAt string? - The date and time the external asset was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the external asset.
- updatedAt string? - Unix timestamp for the date and time the external asset was last updated.
- accessedAt string? - The date and time the external asset was last accessed, expressed in Unix time.
- scheduledFor string? - The date the external asset is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- externalAssetTypeId string? - Id of the external asset type.
- name string? - The name of the external asset.
eloqua: ExternalAssetTypeRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the external asset type.
- currentStatus string? - The external asset type's current status.
- description string? - The description of the external asset type.
- permissions string[]? - The permissions for the external asset type granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the external asset type.
- sourceTemplateId string? - Id of the template used to create the external asset type.
- createdBy string? - The login id of the user who created the external asset type.
- createdAt string? - The date and time the external asset type was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the external asset type.
- updatedAt string? - Unix timestamp for the date and time the external asset type was last updated.
- accessedAt string? - The date and time the external asset type was last accessed, expressed in Unix time.
- scheduledFor string? - The date the external asset type is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- activityTypes ExternalActivityTypeRest20[]? - A list of the external activity types associated with the external asset type.
- name string? - The name of the external asset type.
- image ImageFileRest20? -
eloqua: FieldComparisonCriteriaRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the field comparison criteria.
- currentStatus string? - The field comparison criteria's current status.
- name string? - The name of the field comparison criteria.
- description string? - The description of the field comparison criteria.
- permissions string[]? - The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
- folderId string? - Id of the folder. This is a read-only property.
- sourceTemplateId string? - Id of the source template. This is a read-only property.
- createdBy string? - The login id of the user who created the field comparison criteria.
- createdAt string? - The date and time the field comparison criteria was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the field comparison criteria.
- updatedAt string? - Unix timestamp for the date and time the field comparison criteria was last updated.
- accessedAt string? - The date and time the form was last accessed, expressed in Unix time.
- scheduledFor string? - The date and time the field comparison criteria is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fieldId string? - The id of the field comparison criteria.
- condition ConditionRest20? -
eloqua: FieldConditionRest20
Fields
- 'type string? -
- id string? -
- currentStatus string? -
- name string? -
- description string? -
- permissions string[]? -
- folderId string? -
- sourceTemplateId string? -
- createdBy string? -
- createdAt string? -
- updatedBy string? -
- updatedAt string? -
- accessedAt string? -
- scheduledFor string? -
- depth string? -
- fieldId string? -
- condition ConditionRest20? -
eloqua: FieldMergeRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the field merge. This is a read-only property.
- currentStatus string? - The field merge's current status.
- name string? - Name of the field merge.
- description string? - The description of the field merge.
- permissions string? - The permissions for the field merge granted to your current instance.
- createdBy string? - The login id of the user who created the field merge.
- createdAt string? - The date and time the field merge was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the field merge.
- updatedAt string? - Unix timestamp for the date and time the field merge was last updated.
- accessedAt string? - The date and time the field merge was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- syntax string? - The syntax of the field merge.
- defaultValue string? - The default value of the field merge.
- contactFieldId string? - Id of the associated contact field.
- accountFieldId string? - Id of the associated account field.
- eventId string? - Id of the associated event.
- eventFieldId string? - Id of the associated event field.
- eventSessionFieldId string? - Id of the associated event session field.
- mergeType string? - Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>.
eloqua: FieldMergeRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the field merge. This is a read-only property.
- currentStatus string? - The field merge's current status.
- name string? - Name of the field merge.
- description string? - The description of the field merge.
- permissions string[]? - The permissions for the field merge granted to your current instance.
- folderId string? - Id of the associated folder.
- sourceTemplateId string? - The id of the source template.
- createdBy string? - The login id of the user who created the field merge.
- createdAt string? - The date and time the field merge was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the field merge.
- updatedAt string? - Unix timestamp for the date and time the field merge was last updated.
- accessedAt string? - The date and time the field merge was last accessed.
- scheduledFor string? - This property is not used for field merges.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- syntax string? - The syntax of the field merge.
- defaultValue string? - The default value of the field merge.
- contactFieldId string? - Id of the associated contact field.
- accountFieldId string? - Id of the associated account field.
- eventId string? - Id of the associated event.
- eventFieldId string? - Id of the associated event field.
- eventSessionFieldId string? - Id of the associated event session field.
- customObjectId string? - Id of the associated custom object.
- customObjectFieldId string? - Id of the associated custom object field.
- mergeType string? - Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>.
- customObjectSort string? - The associated custom object sort type.
- queryStringKey string? - The key value if the field merge contains a query string. See the <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/FieldMerges/Tasks/CreatingFieldMergeWithQueryString.htm'>Help Center</a> to learn more about field merges with query strings. This is a read-only property.
- fieldConditions FieldConditionRest20[]? - Array of field condition fields.
- allowUrlsInValue string? - Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface.
eloqua: FieldOutputFormatRest20
Fields
- 'type string? -
- currentStatus string? -
- id string? -
- format string? -
- dataType string? -
eloqua: FieldValueRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- value string? - The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
- id string? - The id of the field to be set to the corresponding value.
eloqua: FieldValueRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- value string? - The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
- id string? - The id of the field to be set to the corresponding value.
- name string? - Name of the field value.
eloqua: FolderRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the email folder. This is a read-only property.
- currentStatus string? - The email folder's current status.
- name string? - The name of the email folder.
- description string? - The description of the email folder.
- permissions string? - The permissions for the email folder granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the email folder.
- createdAt string? - The date and time the email folder was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the email folder.
- updatedAt string? - Unix timestamp for the date and time the email folder was last updated.
- accessedAt string? - The date and time the email folder was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- isSystem string? - Whether or not the email folder is a system folder.
eloqua: FormDataRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property
- id string? - ID of the form submit if synchronous or ID of the form submission job if async. This is a read-only property
- currentStatus string? - Current status of form submission when submitted through asynchronous submission
- submittedAt string? - Unix timestamp for the date and time the form data was submitted. This is a read-only property
- submittedByContactId string? - ID of the contact that submitted the form. This is a read-only property
- fieldValues FieldValueRest10[]? - A list of key/value pairs identifying the form data (field name / value)
- processingStepErrors ProcessingStepErrorRest10[]? - A list of Processing Step Errors occurred in current form submission. This is a read-only property
- processedAt string? - Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property
- rowId int? - In case of asynchronous form submission if processed then submit ID of form submission. This is a read-only property
- validationErrors ObjectValidationErrorRest10[]? - Validation errors if any occured in form submission. This is a read-only property
eloqua: FormDataRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property
- id string? - The ID of the form submit if synchronous or ID of the form submission job if asynchronous. This is a read-only property
- currentStatus string? - The current status of the form submission job. Possible values: Queued, InProgress, Error, and Success.
- submittedAt string? - Unix timestamp for the date and time the form data was submitted. This is a read-only property
- submittedByContactId string? - The ID of the contact that submitted the form. This is a read-only property
- fieldValues FieldValueRest20[]? - A list of key/value pairs identifying the form data (field name / value)
- processingStepErrors ProcessingStepErrorRest20[]? - A list of Processing Step Errors occurred in current form submission. This is a read-only property
- processedAt string? - Unix timestamp for the date and time the form data was processed if submitted through asynchronous submission. This is a read-only property
- rowId int? - In case of an asynchronous form submission if processed then submit ID of form submission. This is a read-only property
- validationErrors ObjectValidationErrorRest20[]? - Validation errors if any occured in form submission. This is a read-only property
- correlationId string? - The unique identifier of form submission within the batch. Optional String field. If present, must be unique across created batches. If <code>correlationId</code> is not unique, then the entire batch will fail. The <code>correlationId</code> is persisted and could be used to identify the form submit.
eloqua: FormElementRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the form element. This is a read-only property.
- currentStatus string? - The form element's current status.
- name string? - Name of the form element.
- description string? - The description of the form element.
- permissions string? - The permissions for the form element granted to your current instance.
- createdBy string? - The login id of the user who created the form element.
- createdAt string? - The date and time the form element was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the form element.
- updatedAt string? - Unix timestamp for the date and time the form element was last updated.
- accessedAt string? - The date and time the form element was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- instructions string? - The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
- style string? - The asset's main layout style.
eloqua: FormElementRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - The ID of the form element. This is a read-only property.
- currentStatus string? - The form element's current status.
- name string? - Name of the form element.
- description string? - The description of the form element.
- permissions string[]? - The permissions for the form element granted to your current instance.
- folderId string? - The ID of the associated folder.
- sourceTemplateId string? - The ID of the form element.
- createdBy string? - The login ID of the user who created the form element.
- createdAt string? - The date and time the form element was created, expressed in Unix time.
- updatedBy string? - The login ID of the user that last updated the form element.
- updatedAt string? - Unix timestamp for the date and time the form element was last updated.
- accessedAt string? - The date and time the form element was last accessed.
- scheduledFor string? - The date the form element is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth' target='_blank'>Request depth</a>.
- instructions string? - The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
- style string? - The asset's main layout style.
eloqua: FormFieldUpdateMappingRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the form field update mapping.
- currentStatus string? - The form field update mapping's current status.
- name string? - The name of the form field update mapping.
- description string? - The description of the field comparison criteria.
- permissions string[]? - The permissions for the form field update mapping granted to your current instance. This is a read-only property.
- folderId string? - Id of the folder. This is a read-only property.
- sourceTemplateId string? - Id of the source template. This is a read-only property.
- createdBy string? - The login id of the user who created the form field update mapping.
- createdAt string? - The date and time the form field update mapping was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the form field update mapping.
- updatedAt string? - Unix timestamp for the date and time the form field update mapping was last updated.
- accessedAt string? - The date and time the form field update mapping was last accessed, expressed in Unix time.
- scheduledFor string? - The date and time the form field update mapping is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- sourceFormFieldId string? - Id of the source form field.
- updateType string? - The update type of the form field update mapping.
- targetEntityFieldId string? - Id of the target field.
eloqua: FormProcessingStepRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the form processing step. This is a read-only property.
- currentStatus string? - The form processing step's current status.
- name string? - Name of the form processing step.
- description string? - The description of the form processing step.
- permissions string? - The permissions for the form processing step granted to your current instance.
- createdBy string? - The login id of the user who created the form processing step.
- createdAt string? - The date and time the form processing step was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the form processing step.
- updatedAt string? - Unix timestamp for the date and time the form processing step was last updated.
- accessedAt string? - The date and time the form processing step was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- execute string? - The conditions for which this form processing step will execute. Possible values include: <code>always</code>, <code>conditionally</code>, and <code>never</code>.
- conditionalType string? - The type of value the comparator is validating. Possible values include: 'form field' or 'static value'.
- conditionalFieldId string? - The form field id used to compare form fields within a form processing step condition.
- conditionalComparator string? - The comparator used to validate a condition. Possible values include: <code>exactly</code> or <code>not exactly</code>.
- isConditionallyNegated string? - The conditions for which the processing step will execute. If <code>yes</code>, the processing step will execute when the conditions are met. If <code>no</code>, the processing step will execute when the conditions are not met.
eloqua: FormProcessingStepRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the form processing step. This is a read-only property.
- currentStatus string? - The form processing step's current status.
- name string? - Name of the form processing step.
- permissions string[]? - The permissions for the form processing step granted to your current instance.
- folderId string? - Id of the associated folder.
- sourceTemplateId string? - The ID of the source template.
- createdBy string? - The login ID of the user who created the form processing step.
- createdAt string? - The date and time the form processing step was created, expressed in Unix time.
- updatedBy string? - The login ID of the user that last updated the form processing step.
- updatedAt string? - Unix timestamp for the date and time the form processing step was last updated.
- accessedAt string? - The date and time the form processing step was last accessed.
- scheduledFor string? - The date the form processing step is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- execute string? - The conditions for which this form processing step will execute. Possible values include: <code>always</code>, <code>conditionally</code>, and <code>never</code>.
- condition ProcessingStepConditionRest20? -
- description string? - The description of the form processing step.
- hasValidationIssue string? - ProcessingStep_Field_HasValidationIssue_Description
eloqua: FormRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the form. This is a read-only property.
- currentStatus string? - The form's current status. Example: draft, active, or complete.
- name string? - The name of the form.
- description string? - The description of the form.
- permissions string? - The permissions for the form granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the form.
- createdAt string? - The date and time the form was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the form.
- updatedAt string? - Unix timestamp for the date and time the form was last updated.
- accessedAt string? - The date and time the form was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- htmlName string? - The asset's raw HTML name.
- processingType string? - A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
- emailAddressFormFieldId string? - The email address form field entity's unique identifier.
- submitFailedLandingPageId string? - The landing page id of the failed submit.
- html string? - The asset's raw HTML content.
- style string? - The asset's main layout style.
- elements FormElementRest10[]? - Array consisting of form elements.
- processingSteps FormProcessingStepRest10[]? - 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, and FormStepWebTracking.
- isHidden string? - Whether the form is an internal form. If <code>true</code>, the form is not exposed outside of Eloqua and any form submissions to this form are deleted.
- archived string? - True if form is archived otherwise False. This is a read-only property.
eloqua: FormRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the form.
- currentStatus string? - The form's current status. Example: draft, active, or complete.
- name string? - The name of the form.
- description string? - The description of the form.
- permissions string[]? - The permissions for the form granted to your current instance. This is a read-only property.
- folderId string? - The ID of the containing folder.
- sourceTemplateId string? - Id of the source template.
- createdBy string? - The login ID of the user who created the form.
- createdAt string? - The date and time the form was created, expressed in Unix time.
- updatedBy string? - The login ID of the user that last updated the form.
- updatedAt string? - Unix timestamp for the date and time the form was last updated.
- accessedAt string? - The date and time the form was last accessed, expressed in Unix time.
- scheduledFor string? - This property is not used.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- htmlName string? - The asset's raw HTML name.
- processingType string? - A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
- submitFailedLandingPageId string? - The landing page ID of the failed submit.
- size SizeRest20? -
- html string? - The asset's raw HTML content.
- style string? - The asset's main layout style.
- elements FormElementRest20[]? - Array consisting of form elements.
- processingSteps FormProcessingStepRest20[]? - 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, and FormStepWebTracking.
- defaultKeyFieldMapping FormFieldUpdateMappingRest20? -
- externalIntegrationUrl string? - The external integration URL used for integrating external forms.
- customCSS string? - The custom style applied to the form.
- isHidden string? - 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.
- formJson string? - 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 <code>{"type":"responsiveForm","version":"1"}</code>.
- isResponsive string? - Indicates whether the form is responsive. Returns <code>true</code> for a responsive form, <code>false</code> for a legacy form. Avoid sending this property when creating and updating forms. This is a read-only property.
- archived string? - True if form is archived otherwise False. This is a read-only property.
- isFormSpamProtectionEnabled string? - Indicates whether spam protection is enabled on the form.
eloqua: FormSpamDataRest20
Fields
- 'type string? - FormSpamSubmission_Field_Type_Description
- id string? - FormSpamSubmission_Field_InternalId_Description
- currentStatus string? - FormSpamSubmission_Field_Status_Description
- submittedAt string? - Unix timestamp for the date and time the form data was submitted. This is a read-only property
- fieldValues FieldValueRest20[]? - A list of key/value pairs identifying the form data (field name / value)
- formSubmissionSource string? - Specifies the source of the form submission
- blockReason string? - Specifies the reason the form was blocked as spam
eloqua: HtmlContentRest10
Fields
- 'type string? -
eloqua: HtmlContentRest20
Fields
- 'type string? -
- contentSource string? -
eloqua: HyperlinkRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the hyperlink. This is a read-only property.
- currentStatus string? - The hyperlink's current status.
- name string? - Name of the hyperlink.
- description string? - The description of the hyperlink.
- permissions string? - The permissions for the hyperlink granted to your current instance.
- createdBy string? - The login id of the user who created the hyperlink.
- createdAt string? - The date and time the hyperlink was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the hyperlink.
- updatedAt string? - Unix timestamp for the date and time the hyperlink was last updated.
- accessedAt string? - The date and time the hyperlink was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- href string? - Href value of the hyperlink.
- hyperlinkType string? - The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
- referencedEntityId string? - Id of the referenced entity.
eloqua: HyperlinkRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the hyperlink. This is a read-only property.
- currentStatus string? - The hyperlink's current status.
- name string? - Name of the hyperlink.
- description string? - The description of the hyperlink.
- permissions string[]? - The permissions for the hyperlink granted to your current instance.
- folderId string? - Id of the containing folder.
- sourceTemplateId string? - Id of the source template.
- createdBy string? - The login id of the user who created the hyperlink.
- createdAt string? - The date and time the hyperlink was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the hyperlink.
- updatedAt string? - Unix timestamp for the date and time the hyperlink was last updated.
- accessedAt string? - The date and time the hyperlink was last accessed.
- scheduledFor string? - The date the hyperlink is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- href string? - Href value of the hyperlink.
- hyperlinkType string? - The type of hyperlink. Possible values include: <code>ExternalURL</code>, <code>ICSCalendarURL</code>, <code>LandingPageURL</code>, <code>ReferrerURL</code>, <code>RSSURL</code>, or <code>TrackedExternalURL</code>.
- referencedEntityId string? - Id of the referenced entity.
eloqua: ImageFileRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the image. This is a read-only property.
- currentStatus string? - The image's current status.
- name string? - The name of the image.
- description string? - The description of the image.
- permissions string? - The permissions for the image granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the image.
- createdAt string? - The date and time the image was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the image.
- updatedAt string? - Unix timestamp for the date and time the image was last updated.
- accessedAt string? - The date and time the image was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fullImageUrl string? - The image's complete URL. This is a read-only property.
- size SizeRest10? -
- thumbnailUrl string? - The image's thumbnail URL. This is a read-only property.
eloqua: ImageFileRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the image.
- currentStatus string? - The image's current status.
- name string? - The name of the image.
- description string? - The description of the image.
- permissions string[]? - The permissions for the image granted to your current instance. This is a read-only property.
- folderId string? - Id of the folder.
- sourceTemplateId string? - Id of the source template.
- createdBy string? - The login id of the user who created the image.
- createdAt string? - The date and time the image was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the image.
- updatedAt string? - Unix timestamp for the date and time the image was last updated.
- accessedAt string? - The date and time the image was last accessed, expressed in Unix time.
- scheduledFor string? - The date and time the image is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fullImageUrl string? - The image's complete URL. This is a read-only property.
- size SizeRest20? -
- thumbnailUrl string? - The image's thumbnail URL. This is a read-only property.
- 'source string? - The image's source location.
- syncDate string? - The date and time the image was last synced, expressed in Unix time. This is a read-only property.
eloqua: ImportedFileRest10
Fields
- 'type string? - The date and time the imported file was last accessed. This is a read-only property.
- id string? - Id of the imported file. This is a read-only property.
- currentStatus string? - The imported file's current status.
- name string? - Name of the imported file.
- description string? - The description of the imported file.
- permissions string? - The permissions for the imported file granted to your current instance.
- createdBy string? - The login id of the user who created the imported file.
- createdAt string? - The date and time the imported file was last accessed, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the imported file. This is a read-only property.
- updatedAt string? - Unix timestamp for the date and time the imported file was last updated. This is a read-only property.
- accessedAt string? - The date and time the imported file was last accessed.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fileName string? - The file name of the imported file.
- link string? - The imported file's complete URL. This is a read-only property.
- trackedLink string? - The imported file's tracked complete URL. This is a read-only property.
- brandId string? - ImportedFile_Field_BrandId_Description
eloqua: ImportedFileRest20
Fields
- 'type string? - The date and time the imported file was last accessed. This is a read-only property.
- id string? - Id of the imported file. This is a read-only property.
- currentStatus string? - The imported file's current status.
- name string? - Name of the imported file.
- description string? - The description of the imported file.
- permissions string[]? - The permissions for the imported file granted to your current instance.
- folderId string? - Id of the folder. This is a read-only property.
- sourceTemplateId string? - Id of the source template. This is a read-only property.
- createdBy string? - The login id of the user who created the imported file.
- createdAt string? - The date and time the imported file was last accessed, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the imported file.
- updatedAt string? - Unix timestamp for the date and time the imported file was last updated.
- accessedAt string? - The date and time the imported file was last accessed.
- scheduledFor string? - The date and time the file is scheduled for. This is a read-only property.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- fileName string? - The file name of the imported file.
- link string? - The imported file's complete URL. This is a read-only property.
- trackedLink string? - The imported file's tracked complete URL. This is a read-only property.
- redirectLink string? - The imported file's redirect URL. This is a read-only property.
- brandId string? - ImportedFile_Field_BrandId_Description
eloqua: InterfacePermissionRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- interfaceCode string? -
- nestedInterfacePermissions InterfacePermissionRest20[]? -
- name string? -
eloqua: LandingPageRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the landing page. This is a read-only property.
- currentStatus string? - The landing page's current status. This is a read-only property.
- name string? - The name of the landing page.
- description string? - The description of the landing page.
- permissions string? - The permissions for the landing page granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the landing page.
- createdAt string? - The date and time the landing page was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the landing page.
- updatedAt string? - Unix timestamp for the date and time the landing page was last updated.
- accessedAt string? - The date and time the landing page was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- deployedAt string? - Unix timestamp for the date and time the landing page was deployed. This is a read-only property.
- micrositeId string? - Id of the associated microsite.
- refreshedAt string? - Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property.
- htmlContent HtmlContentRest10? -
- layout string? - The landing page's main layout.
- style string? - The landing page's main layout style.
- forms FormRest10[]? - A list of forms contained within the landing page.
- images ImageFileRest10[]? - A list of images contained within the landing page.
- hyperlinks HyperlinkRest10[]? - A list of hyperlinks contained within the landing page.
- contentSections ContentSectionRest10[]? - A list of content sections contained within the landing page.
- dynamicContents DynamicContentRest10[]? - A list of dynamic contents contained within the landing page.
- files ImportedFileRest10[]? - A list of files contained within the landing page.
- autoRedirectUrl string? - The landing page's auto re-direct URL.
- autoRedirectWaitFor string? - The amount of time the service will wait before redirecting to the auto re-direct URL.
- autoCloseWaitFor string? - The amount of time the service will wait before closing.
- relativePath string? - The relative path of the landing page.
eloqua: LandingPageRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the landing page. This is a read-only property.
- currentStatus string? - The landing page's current status. This is a read-only property.
- name string? - The name of the landing page.
- description string? - The description of the landing page.
- permissions string[]? - The permissions for the landing page granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the landing page.
- sourceTemplateId string? - Id of the template used to create the landing page.
- createdBy string? - The login id of the user who created the landing page.
- createdAt string? - The date and time the landing page was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the landing page.
- updatedAt string? - Unix timestamp for the date and time the landing page was last updated.
- accessedAt string? - This property is not used.
- scheduledFor string? - This property is not used.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- deployedAt string? - Unix timestamp for the date and time the landing page was deployed. This is a read-only property.
- micrositeId string? - Id of the associated microsite.
- refreshedAt string? - Unix timestamp for the date and time the landing page was last refreshed. This is a read-only property.
- htmlContent HtmlContentRest20? -
- layout string? - The landing page's main layout.
- style string? - The landing page's main layout style.
- forms FormRest20[]? - A list of forms contained within the landing page.
- images ImageFileRest20[]? - A list of images contained within the landing page.
- hyperlinks HyperlinkRest20[]? - A list of hyperlinks contained within the landing page.
- contentSections ContentSectionRest20[]? - A list of content sections contained within the landing page.
- dynamicContents DynamicContentRest20[]? - A list of dynamic contents contained within the landing page.
- files ImportedFileRest20[]? - A list of files contained within the landing page.
- contentServiceInstances CloudComponentInstanceRest20[]? -
- autoRedirectUrl string? - The URL to redirect window used with <code>autoRedirectWaitFor</code>.
- autoRedirectWaitFor string? - Amount of seconds to automatically redirect window to URL specified with <code>autoRedirectUrl</code>. This setting cannot be used with <code>autoCloseWaitFor</code>. Only one can be selected, and a validation error will be returned if including both.
- autoCloseWaitFor string? - Amount of seconds to automatically close window. This setting cannot be used with <code>autoRedirectWaitFor</code>. Only one can be selected, and a validation error will be returned if including both.
- relativePath string? - The relative path of the landing page.
- excludeFromAuthentication string? - Whether or not the landing page is excluded from authentication.
- isContentProtected string? - Whether or not the landing page is in protected mode.
- isHidden string? - Whether or not the landing page is visible to external visitors.
eloqua: MicrositeRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the microsite. This is a read-only property.
- currentStatus string? - The campaign's current status.
- name string? - The name of the microsite.
- description string? - The description of the microsite.
- permissions string? - The permissions for the microsite granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the microsite.
- createdAt string? - The date and time the microsite was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the microsite.
- updatedAt string? - Unix timestamp for the date and time the microsite was last updated.
- accessedAt string? - The date and time the microsite was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- domains string[]? - A collection of associated sub domains.
- defaultLandingPageId string? - The id for the associated default landing page.
- isAllowedInFrame string? - Whether pages associated to the microsite can be embedded within frames, iframes, or objects. <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/index.html#CSHID=PreventEmbedding'>Learn more</a>.
eloqua: ObjectKeyRest10
Fields
- 'type string? -
- objectType string? -
- objectId string? -
- container ObjectKeyRest10? -
eloqua: ObjectKeyRest20
Fields
- 'type string? -
- objectType string? -
- objectId string? -
- container ObjectKeyRest20? -
eloqua: ObjectValidationErrorRest10
Fields
- 'type string? -
- container ObjectKeyRest10? -
- property string? -
- value string? -
- requirement RequirementRest10? -
eloqua: ObjectValidationErrorRest20
Fields
- 'type string? -
- container ObjectKeyRest20? -
- property string? -
- value string? -
- requirement RequirementRest20? -
eloqua: OpportunityContactLinkageImportIndividual
The request body defines details of the opportunity contact linkage import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to false to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkOpportunitiesCaseSensitiveMatchField boolean? - Whether or not to perform a case sensitive search on the match field.
- linkOpportunitiesCaseSensitiveSourceField boolean? - Whether or not to perform a case sensitive search on the source field.
- linkOpportunitiesEntityType string? - Specifies the entity of the contact linkage import. Allowed values are "Contact" or "Account".
- linkOpportunitiesMatchFieldName string? - Specifies the field name for matching.
- linkOpportunitiesMultipleSourceMatches boolean? - Whether or not imported data will be mapped to multiple matching records.
- linkOpportunitiesSourceField string? - Specifies the source field name for matching.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Opportunitycontactlinkageimportindividual1
The request body defines details of the opportunity contact linkage import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to false to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkOpportunitiesCaseSensitiveMatchField boolean? - Whether or not to perform a case sensitive search on the match field.
- linkOpportunitiesCaseSensitiveSourceField boolean? - Whether or not to perform a case sensitive search on the source field.
- linkOpportunitiesEntityType string? - Specifies the entity of the contact linkage import. Allowed values are "Contact" or "Account".
- linkOpportunitiesMatchFieldName string? - Specifies the field name for matching.
- linkOpportunitiesMultipleSourceMatches boolean? - Whether or not imported data will be mapped to multiple matching records.
- linkOpportunitiesSourceField string? - Specifies the source field name for matching.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Opportunitycontactlinkageimportindividual2
The request body defines details of the opportunity contact linkage import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to false to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkOpportunitiesCaseSensitiveMatchField boolean? - Whether or not to perform a case sensitive search on the match field.
- linkOpportunitiesCaseSensitiveSourceField boolean? - Whether or not to perform a case sensitive search on the source field.
- linkOpportunitiesEntityType string? - Specifies the entity of the contact linkage import. Allowed values are "Contact" or "Account".
- linkOpportunitiesMatchFieldName string? - Specifies the field name for matching.
- linkOpportunitiesMultipleSourceMatches boolean? - Whether or not imported data will be mapped to multiple matching records.
- linkOpportunitiesSourceField string? - Specifies the source field name for matching.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Opportunitycontactlinkageimportindividual3
The request body defines details of the opportunity contact linkage import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not imported data will be mapped to multiple existing records. For contact imports, the <code>isUpdatingMultipleMatchedRecords</code> property must be set to false to update <code>Contact.Field(C_EmailAddress)</code>.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- linkOpportunitiesCaseSensitiveMatchField boolean? - Whether or not to perform a case sensitive search on the match field.
- linkOpportunitiesCaseSensitiveSourceField boolean? - Whether or not to perform a case sensitive search on the source field.
- linkOpportunitiesEntityType string? - Specifies the entity of the contact linkage import. Allowed values are "Contact" or "Account".
- linkOpportunitiesMatchFieldName string? - Specifies the field name for matching.
- linkOpportunitiesMultipleSourceMatches boolean? - Whether or not imported data will be mapped to multiple matching records.
- linkOpportunitiesSourceField string? - Specifies the source field name for matching.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: OpportunityImportIndividual
The request body defines the details of the opportunity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isIdentifierFieldCaseSensitive boolean? - Whether or not to perform a case sensitive search on the identifier field.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not multiple matched records are being updated.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Opportunityimportindividual1
The request body defines the details of the opportunity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isIdentifierFieldCaseSensitive boolean? - Whether or not to perform a case sensitive search on the identifier field.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not multiple matched records are being updated.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Opportunityimportindividual2
The request body defines the details of the opportunity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isIdentifierFieldCaseSensitive boolean? - Whether or not to perform a case sensitive search on the identifier field.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not multiple matched records are being updated.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Opportunityimportindividual3
The request body defines the details of the opportunity import definition.
Fields
- autoDeleteDuration string? - Time until the definition will be deleted, expressed using the ISO-8601 standard.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- dataRetentionDuration string? - The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation.
- fields string[]? - List of fields to be included in the operation.
- identifierFieldName string? - The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long. The following field types are not supported: Large Text, Date, and Boolean.
- importPriorityUri string? - Must reference an existing <code>/imports/priorities/{id}</code>. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- isIdentifierFieldCaseSensitive boolean? - Whether or not to perform a case sensitive search on the identifier field.
- isSyncTriggeredOnImport boolean? - Whether or not the sync is triggered on import.
- isUpdatingMultipleMatchedRecords boolean? - Whether or not multiple matched records are being updated.
- kbUsed int? - The amount of space used in kilobytes. This is a read-only property.
- name string? - The name of the import definition.
- nullIdentifierFieldName boolean? - Whether or not to null the identifier field.
- updatedAt string? - The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the entity. This is a read-only property.
- updateRule RuleType? - The rule used when doing updates on existing data. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
- updateRuleByField string[]? - Import.Import_Field_updateRuleByField_Description
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: OptionListRest10
Fields
- 'type string? - The option list's type in Eloqua. This is a read-only property.
- id string? - The option list's unique identifier.
- currentStatus string? - The option list's current status.
- name string? - The name of the option list.
- description string? - The description of the option list.
- permissions string? - The permissions for the option list granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the option list.
- createdAt string? - Unix timestamp for the date and time the option list was created.
- updatedBy string? - The login id of the user that last updated the option list.
- updatedAt string? - Unix timestamp for the date and time the option list was last updated.
- accessedAt string? - The date and time the option list was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- elements OptionRest10[]? - A list of option elements.
eloqua: OptionRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property. This asset is an "Option".
- displayName string? - The display name for the option that is displayed within the option list.
- value string? - The option's internal value. This value is not displayed externally.
eloqua: PositionRest20
Fields
- 'type string? - The campaign element's type. This is a read-only property.
- x string? - The position of the campaign element on the x axis.
- y string? - The position of the campaign element on the y axis.
eloqua: ProcessingStepConditionRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- isConditionallyNegated string? - 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.
- conditionalFieldCriteria FieldComparisonCriteriaRest20[]? - The conditional field criteria for the form processing step condition.
eloqua: ProcessingStepErrorRest10
Fields
- 'type string? - The asset's type in Eloqua.
- processingStepId string? - Processing step id during which error ocurred
- processingStepTypeId string? - Type of the processing step during which error ocurred
- processingStepDisplayName string? - DisplayName of the processing step including description (if configured)
- errorCode int? - Unique Error Code for current error
- errorMessage string? - Error message for current error code
- errorDescription string? - Detailed information about current error
eloqua: ProcessingStepErrorRest20
Fields
- 'type string? - The asset's type in Eloqua.
- processingStepId string? - Processing step id during which error ocurred
- processingStepTypeId string? - Type of the processing step during which error ocurred
- processingStepDisplayName string? - DisplayName of the processing step including description (if configured)
- errorCode int? - Unique Error Code for current error
- errorMessage string? - Error message for current error code
- errorDescription string? - Detailed information about current error
eloqua: ProductPermissionRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- productCode string? -
eloqua: ProfileFieldRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the visitor profile field. This is a read-only property.
- name string? - The name of the visitor profile field.
- internalName string? - The internal name of the visitor profile field.
- dataType string? - The visitor profile field's data type. Possible values are: text, 'text', 'largeText', 'date', or 'number'.
- length string? - The value length of the field expressed in bytes.
eloqua: ProgramRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the program.
- currentStatus string? - The program's current status: Active, Draft, Scheduled, Paused, or Completed.
- name string? - The name of the program.
- description string? - The description of the program.
- permissions string[]? - The permissions for the program granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the program.
- sourceTemplateId string? - Id of the template used to create the asset.
- createdBy string? - The login id of the user who created the program.
- createdAt string? - The date and time the program was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the program.
- updatedAt string? - Unix timestamp for the date and time the program was last updated. This is a read-only property.
- accessedAt string? - The date and time the program was last accessed, expressed in Unix time.
- scheduledFor string? - The date the program is scheduled.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- elements CampaignElementRest20[]? - A list of program elements.
- isReadOnly string? - Whether or not the program is read only.
- runAsUserId string? - The login id of the user to activate the program.
- isMemberAllowedDuplicates string? - Whether contacts are allowed to enter the program more than once. If false, once a contact enters the program, the contact cannot enter the program again from another entry point.
- defaultEntityType string? - The program type, possible values are Contact or CustomObjectRecords.
- defaultEntityId string? - The id of the custom object data set. Only used for custom object programs.
eloqua: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
eloqua: QueryResultAccountGroupRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements AccountGroupRest20[]? - Array of account group fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultAccountRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements AccountRest10[]? - Array of account fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultAsyncFormSubmissionRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements FormDataRest10[]? - Array of form submission data fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultAsyncFormSubmissionRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements FormDataRest20[]? - Array of form submission data fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultCampaignRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements CampaignRest20[]? - Array of campaign fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultContactFieldRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements ContactFieldRest10[]? - Array of contact fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultContactRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements ContactRest10[]? - Array of contact fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultContentSectionRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements ContentSectionRest10[]? - Array of content section fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultCustomObjectDataRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements CustomObjectDataRest10[]? - Array of custom object field elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultCustomObjectDataRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements CustomObjectDataRest20[]? - Array of custom object field elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultCustomObjectRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements CustomObjectRest10[]? - Array of custom object fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultCustomObjectRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements CustomObjectRest20[]? - Array of custom object fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultEmailRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements EmailRest10[]? - Array of email fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultEmailRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements EmailRest20[]? - Array of email data.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultEventRegistrationDataRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements EventRegistrationDataRest20[]? - Array of event field elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultEventRegistrationRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements EventRegistrationRest20[]? - Array of event field elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultExternalAssetRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements ExternalAssetRest20[]? - Array of external asset fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultExternalAssetTypeRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements ExternalAssetTypeRest20[]? - Array of account group fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultFolderRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements FolderRest10[]? - Array of folder fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultFooterRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements EmailFooterRest10[]? - Array of footer fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultFormRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements FormRest10[]? - Array of form fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultFormRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements FormRest20[]? - Array of form elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultFormSpamSubmissionRest20
Fields
- 'type string? - QueryResult1FormSpamSubmission_Field_Type_Description
- elements FormSpamDataRest20[]? - QueryResult1FormSpamSubmission_Field_Elements_Description
- total int? - QueryResult1FormSpamSubmission_Field_TotalElements_Description
- pageSize int? - QueryResult1FormSpamSubmission_Field_PageSize_Description
- page int? - QueryResult1FormSpamSubmission_Field_PageIndex_Description
eloqua: QueryResultFormSubmissionRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements FormDataRest10[]? - Array of form data elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultFormSubmissionRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements FormDataRest20[]? - Array of form data elements.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultGroupRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements EmailGroupRest10[]? - Array of fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultHeaderRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements EmailHeaderRest10[]? - Array of header fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultImageRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements ImageFileRest10[]? - Array of image fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultLandingPageRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements LandingPageRest10[]? - Array of landing page fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultLandingPageRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements LandingPageRest20[]? - Array of landing page fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultListRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements ContactListRest10[]? - Array of contact list fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultMicrositeRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements MicrositeRest10[]? - Array of microsite fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultOptionListRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements OptionListRest10[]? - Array of option list fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultProfileFieldRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements ProfileFieldRest20[]? - Array of visitor profile fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultProgramRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements ProgramRest20[]? - Array of program fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultSecurityGroupRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements SecurityGroupRest20[]? - Array of security group fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultSecurityGroupUserRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements SecurityGroupUserRest20[]? - Array of security group user data.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultSegmentRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements ContactSegmentRest10[]? - Array of segment fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultSegmentRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements ContactSegmentRest20[]? - Array of contact segment fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultUserRest10
Fields
- 'type string? - The asset's type in Eloqua.
- elements UserRest10[]? - Array of user fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultUserRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements UserRest20[]? - Array of user fields.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: QueryResultVisitorViewDataRest20
Fields
- 'type string? - The asset's type in Eloqua.
- elements EloquaApiRestContractsDataVisitorsVisitorviewdatarest20[]? - Array of visitor data.
- total int? - The total amount of results.
- pageSize int? - The page size.
- page int? - The specified page.
eloqua: RequirementRest10
Fields
- 'type string? -
eloqua: RequirementRest20
Fields
- 'type string? -
eloqua: SecurityGroupRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the security group.
- currentStatus string? - This property is not used.
- description string? - The description of the security group.
- permissions string[]? - The permissions for the security granted to your current instance.
- folderId string? - Id of the associated folder.
- sourceTemplateId string? - This property is not used.
- createdBy string? - The login id of the user who created the security group.
- createdAt string? - The date and time the security group was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the security group. This is a read-only property.
- updatedAt string? - Unix timestamp for the date and time the security group was last updated. This is a read-only property.
- accessedAt string? - The date and time the security group was last accessed.
- scheduledFor string? - This property is not used.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- name string? - The name of the security group.
- acronym string? - Acronym for the security group
- isReadOnly string? - Indicates if the security group is read only.
- isEffective string? - Indicates if the security group is effective.
eloqua: SecurityGroupUserRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- patchMethod string? - The patch method to perform
- user UserRest20? -
eloqua: SegmentElementRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact segment element. This is a read-only property.
- currentStatus string? - The contact segment element's current status. This is a read-only property.
- name string? - The name of the contact segment element. This is a read-only property.
- description string? - The description of the contact segment element.
- permissions string? - The permissions for the contact segment element granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the contact segment element.
- createdAt string? - The date and time the contact segment element was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact segment element.
- updatedAt string? - Unix timestamp for the date and time the contact segment element was last updated.
- accessedAt string? - The date and time the contact segment element was last accessed, expressed in Unix time.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- isIncluded string? - The total amount of contacts within the segment element.
- count string? - The number of contacts in the contact segment element. This is a read-only property.
- lastCalculatedAt string? - The date and time the contact segment element was last calculated. This is a read-only property.
eloqua: SegmentElementRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the contact segment element. This is a read-only property.
- currentStatus string? - The contact segment element's current status. This is a read-only property.
- name string? - This property is not used for contact segment elements.
- description string? - This property is not used for contact segment elements.
- permissions string[]? - The permissions for the contact segment element granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the contact segment element.
- sourceTemplateId string? - This property is not used for contact segment elements.
- createdBy string? - The login id of the user who created the contact segment element.
- createdAt string? - The date and time the contact segment element was created, expressed in Unix time.
- updatedBy string? - The login id of the user that last updated the contact segment element.
- updatedAt string? - Unix timestamp for the date and time the contact segment element was last updated.
- accessedAt string? - This property is not used for contact segment elements.
- scheduledFor string? - This property is not used for contact segment elements.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- isIncluded string? - The total amount of contacts within the segment element.
- count string? - The number of contacts in the contact segment element. This is a read-only property.
- lastCalculatedAt string? - The date and time the contact segment element was last calculated. This is a read-only property.
eloqua: SizeRest10
Fields
- 'type string? -
eloqua: SizeRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property. The type for this property is 'size'.
- width string? - The width dimensions of the asset expressed in pixels.
- height string? - The height dimensions of the asset expressed in pixels.
eloqua: SyncIndividual
The request body defines the details of the synchronization definition.
Fields
- callbackUrl string? - When a sync completes, Eloqua will make a call to the URL specified in this parameter. The callback can occur during sync creation, before the sync creation response, or immediately after.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- status SyncStatusType? - The status of the synchronization. This is a read-only property.
- syncedInstanceUri string? - This value should be the uri for the export/import definition you wish to sync. When you create an import/export definition, Eloqua will respond with a "uri" parameter, the value of which should be used here.
- syncEndedAt string? - The date and time the sync ended. This is a read-only property.
- syncStartedAt string? - The date and time the sync started. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: Syncindividual1
The request body defines the details of the synchronization definition.
Fields
- callbackUrl string? - When a sync completes, Eloqua will make a call to the URL specified in this parameter. The callback can occur during sync creation, before the sync creation response, or immediately after.
- createdAt string? - The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
- createdBy string? - The login id of the user who created the entity. This is a read-only property.
- status SyncStatusType? - The status of the synchronization. This is a read-only property.
- syncedInstanceUri string? - This value should be the uri for the export/import definition you wish to sync. When you create an import/export definition, Eloqua will respond with a "uri" parameter, the value of which should be used here.
- syncEndedAt string? - The date and time the sync ended. This is a read-only property.
- syncStartedAt string? - The date and time the sync started. This is a read-only property.
- uri string? - System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
eloqua: TypePermissionRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- objectType string? -
- permissions TypePermissionsRest20? -
eloqua: TypePermissionsRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
eloqua: UserEnabledRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- enabled string? - Whether or not the user's account is enabled or disabled. Set <code>{"enabled":true}</code> to enable a user, otherwise <code>{"enabled":false}</code>.
eloqua: UserPasswordRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- password string? - The user's password.
- mustChangePassword string? - Boolean to determine whether the user must change their password upon logging in.
eloqua: UserPreferencesRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- timezoneId string? - The ID of the user's timezone in Eloqua. This is a read-only property.
eloqua: UserPreferencesRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- timezoneId string? - The ID of the user's timezone in Eloqua.
eloqua: UserRest10
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the user. This is a read-only property.
- currentStatus string? - This property is not used.
- name string? - The name of the user. This is a read-only property.
- description string? - The description of the user. This is a read-only property.
- permissions string? - The permissions for the user granted to your current instance. This is a read-only property.
- createdBy string? - The login id of the user who created the user. This is a read-only property.
- createdAt string? - The date and time the user was created, expressed in Unix time. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the user. This is a read-only property.
- updatedAt string? - Unix timestamp for the date and time the user was last updated. This is a read-only property.
- accessedAt string? - The date and time the user was last accessed, expressed in Unix time. This is a read-only property.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>.
- loginName string? - The user's name used to login. This is a read-only property.
- company string? - The name of the user's company/instance. This is a read-only property.
- emailAddress string? - The user's email address. This is a read-only property.
- preferences UserPreferencesRest10? -
- defaultContactViewId string? - The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
- defaultAccountViewId string? - The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
eloqua: UserRest20
Fields
- 'type string? - The asset's type in Eloqua. This is a read-only property.
- id string? - Id of the user. This is a read-only property.
- currentStatus string? - This property is not used.
- name string? - The name of the user. This is a read-only property.
- description string? - The description of the user.
- permissions string[]? - The permissions for the user granted to your current instance. This is a read-only property.
- folderId string? - The folder id of the folder which contains the user. This is a read-only property.
- sourceTemplateId string? - Id of template used to create the user.
- createdBy string? - The login id of the user who created the user. This is a read-only property.
- createdAt string? - The date and time the user was created, expressed in Unix time. This is a read-only property.
- updatedBy string? - The login id of the user that last updated the user. This is a read-only property.
- updatedAt string? - Unix timestamp for the date and time the user was last updated. This is a read-only property.
- accessedAt string? - The date and time the user was last accessed, expressed in Unix time.
- scheduledFor string? - This parameter is not used.
- depth string? - Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>. This is a read-only property.
- loginName string? - The user's name used to login. This is a read-only property.
- emailAddress string? - The user's email address.
- federationId string? - The user's Federation Id.
- firstName string? - The first name of the user.
- lastName string? - The last name of the user.
- preferences UserPreferencesRest20? -
- typePermissions TypePermissionRest20[]? - A list of the user's type permissions.
- capabilities string[]? - A list of strings: the user's capabilities.
- betaAccess string[]? - A list of strings: beta programs the user can access.
- defaultContactViewId string? - The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
- defaultAccountViewId string? - The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
- securityGroups SecurityGroupRest20[]? - The user's security groups.
- interfacePermissions InterfacePermissionRest20[]? - A list of the user's interface permissions.
- productPermissions ProductPermissionRest20[]? - A list of the user's product permissions.
- isUsingBrightenTemplate string? - This parameter is not used.
- shortcuts string[]? - This parameter is not used.
- isDeleted string? - Indicates if the user is deleted.
- isDisabled string? - Indicates if the user is disabled.
- jobTitle string? - Job title of the user.
- companyDisplayName string? - Name of the user's company to be displayed.
- companyUrl string? - URL of the user's company.
- phone string? - Phone number of the user.
- crmUsername string? - User's identifier in default CRM.
- crmUserNames CrmUserNamesRest20? -
- passwordExpires string? - Indicates if user's password can expire.
- sendWelcomeEmail string? - Indicates if "User Welcome" email would be sent to user upon user creation.
- cellPhone string? - Mobile phone number of the user.
- address1 string? - User's address line 1.
- address2 string? - User's address line 2.
- replyToAddress string? - User's email address used as "reply to" address.
- department string? - Name of the user's department.
- fax string? - Fax number of the user.
- personalUrl string? - User's personal URL.
- personalMessage string? - User's personal message.
- ssoOnly string? - Indicates if the user can only login using Single Sign On.
- digitalSignatureId string? - Internal id of user's digital signature.
- personalPhotoId string? - Internal id of user's personal photo.
- city string? - The name of the user's city.
- state string? - The name of the user's state or province.
- country string? - The name of the user's country.
- zipCode string? - User's ZIP or postal code.
- senderEmailAddress string? - User's "Sender Email Address"
- senderDisplayName string? - User's "Sender Display Name"
String types
eloqua: DataType
DataType
The type of data, used for field definitions.
eloqua: RuleType
RuleType
The rule used when doing updates on existing data. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
eloqua: SyncStatusType
SyncStatusType
The status of the synchronization. This is a read-only property.